AuditManagerClient

Welcome to the Audit Manager API reference. This guide is for developers who need detailed information about the Audit Manager API operations, data types, and errors.

Audit Manager is a service that provides automated evidence collection so that you can continually audit your Amazon Web Services usage. You can use it to assess the effectiveness of your controls, manage risk, and simplify compliance.

Audit Manager provides prebuilt frameworks that structure and automate assessments for a given compliance standard. Frameworks include a prebuilt collection of controls with descriptions and testing procedures. These controls are grouped according to the requirements of the specified compliance standard or regulation. You can also customize frameworks and controls to support internal audits with specific requirements.

Use the following links to get started with the Audit Manager API:

  • Actions: An alphabetical list of all Audit Manager API operations.

  • Data types: An alphabetical list of all Audit Manager data types.

  • Common parameters: Parameters that all operations can use.

  • Common errors: Client and server errors that all operations can return.

If you're new to Audit Manager, we recommend that you review the Audit Manager User Guide.

Properties

Link copied to clipboard
abstract override val config: AuditManagerClient.Config

AuditManagerClient's configuration

Functions

Link copied to clipboard

Associates an evidence folder to an assessment report in an Audit Manager assessment.

Link copied to clipboard

Associates a list of evidence to an assessment report in an Audit Manager assessment.

Link copied to clipboard

Creates a batch of delegations for an assessment in Audit Manager.

Link copied to clipboard

Deletes a batch of delegations for an assessment in Audit Manager.

Disassociates a list of evidence from an assessment report in Audit Manager.

Link copied to clipboard

Adds one or more pieces of evidence to a control in an Audit Manager assessment.

Link copied to clipboard

Creates an assessment in Audit Manager.

Link copied to clipboard

Creates a custom framework in Audit Manager.

Link copied to clipboard

Creates an assessment report for the specified assessment.

Link copied to clipboard

Creates a new custom control in Audit Manager.

Link copied to clipboard

Deletes an assessment in Audit Manager.

Link copied to clipboard

Deletes a custom framework in Audit Manager.

Link copied to clipboard

Deletes a share request for a custom framework in Audit Manager.

Link copied to clipboard

Deletes an assessment report in Audit Manager.

Link copied to clipboard

Deletes a custom control in Audit Manager.

Link copied to clipboard
abstract suspend fun deregisterAccount(input: DeregisterAccountRequest = DeregisterAccountRequest { }): DeregisterAccountResponse

Deregisters an account in Audit Manager.

Link copied to clipboard
abstract suspend fun deregisterOrganizationAdminAccount(input: DeregisterOrganizationAdminAccountRequest = DeregisterOrganizationAdminAccountRequest { }): DeregisterOrganizationAdminAccountResponse

Removes the specified Amazon Web Services account as a delegated administrator for Audit Manager.

Disassociates an evidence folder from the specified assessment report in Audit Manager.

Link copied to clipboard
abstract suspend fun getAccountStatus(input: GetAccountStatusRequest = GetAccountStatusRequest { }): GetAccountStatusResponse

Gets the registration status of an account in Audit Manager.

Link copied to clipboard

Gets information about a specified assessment.

Link copied to clipboard

Gets information about a specified framework.

Link copied to clipboard

Gets the URL of an assessment report in Audit Manager.

Link copied to clipboard

Gets a list of changelogs from Audit Manager.

Link copied to clipboard
abstract suspend fun getControl(input: GetControlRequest): GetControlResponse

Gets information about a specified control.

Link copied to clipboard
abstract suspend fun getDelegations(input: GetDelegationsRequest = GetDelegationsRequest { }): GetDelegationsResponse

Gets a list of delegations from an audit owner to a delegate.

Link copied to clipboard
abstract suspend fun getEvidence(input: GetEvidenceRequest): GetEvidenceResponse

Gets information about a specified evidence item.

Link copied to clipboard

Gets all evidence from a specified evidence folder in Audit Manager.

Link copied to clipboard

Creates a presigned Amazon S3 URL that can be used to upload a file as manual evidence. For instructions on how to use this operation, see Upload a file from your browser in the Audit Manager User Guide.

Link copied to clipboard

Gets an evidence folder from a specified assessment in Audit Manager.

Link copied to clipboard

Gets the evidence folders from a specified assessment in Audit Manager.

Link copied to clipboard

Gets a list of evidence folders that are associated with a specified control in an Audit Manager assessment.

Link copied to clipboard
abstract suspend fun getInsights(input: GetInsightsRequest = GetInsightsRequest { }): GetInsightsResponse

Gets the latest analytics data for all your current active assessments.

Link copied to clipboard

Gets the latest analytics data for a specific active assessment.

Link copied to clipboard
abstract suspend fun getOrganizationAdminAccount(input: GetOrganizationAdminAccountRequest = GetOrganizationAdminAccountRequest { }): GetOrganizationAdminAccountResponse

Gets the name of the delegated Amazon Web Services administrator account for a specified organization.

Link copied to clipboard
abstract suspend fun getServicesInScope(input: GetServicesInScopeRequest = GetServicesInScopeRequest { }): GetServicesInScopeResponse

Gets a list of the Amazon Web Services services from which Audit Manager can collect evidence.

Link copied to clipboard
abstract suspend fun getSettings(input: GetSettingsRequest): GetSettingsResponse

Gets the settings for a specified Amazon Web Services account.

Lists the latest analytics data for controls within a specific control domain and a specific active assessment.

Link copied to clipboard

Returns a list of the frameworks that are available in the Audit Manager framework library.

Link copied to clipboard

Returns a list of sent or received share requests for custom frameworks in Audit Manager.

Link copied to clipboard
abstract suspend fun listAssessmentReports(input: ListAssessmentReportsRequest = ListAssessmentReportsRequest { }): ListAssessmentReportsResponse

Returns a list of assessment reports created in Audit Manager.

Link copied to clipboard
abstract suspend fun listAssessments(input: ListAssessmentsRequest = ListAssessmentsRequest { }): ListAssessmentsResponse

Returns a list of current and past assessments from Audit Manager.

Link copied to clipboard
abstract suspend fun listControlDomainInsights(input: ListControlDomainInsightsRequest = ListControlDomainInsightsRequest { }): ListControlDomainInsightsResponse

Lists the latest analytics data for control domains across all of your active assessments.

Link copied to clipboard

Lists analytics data for control domains within a specified active assessment.

Link copied to clipboard

Lists the latest analytics data for controls within a specific control domain across all active assessments.

Link copied to clipboard

Returns a list of controls from Audit Manager.

Link copied to clipboard

Returns a list of keywords that are pre-mapped to the specified control data source.

Link copied to clipboard
abstract suspend fun listNotifications(input: ListNotificationsRequest = ListNotificationsRequest { }): ListNotificationsResponse

Returns a list of all Audit Manager notifications.

Link copied to clipboard

Returns a list of tags for the specified resource in Audit Manager.

Link copied to clipboard
abstract suspend fun registerAccount(input: RegisterAccountRequest = RegisterAccountRequest { }): RegisterAccountResponse

Enables Audit Manager for the specified Amazon Web Services account.

Link copied to clipboard

Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager.

Link copied to clipboard

Creates a share request for a custom framework in Audit Manager.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Tags the specified resource in Audit Manager.

Link copied to clipboard

Removes a tag from a resource in Audit Manager.

Link copied to clipboard

Edits an Audit Manager assessment.

Link copied to clipboard

Updates a control within an assessment in Audit Manager.

Link copied to clipboard

Updates the status of a control set in an Audit Manager assessment.

Link copied to clipboard

Updates a custom framework in Audit Manager.

Link copied to clipboard

Updates a share request for a custom framework in Audit Manager.

Link copied to clipboard

Updates the status of an assessment in Audit Manager.

Link copied to clipboard

Updates a custom control in Audit Manager.

Link copied to clipboard
abstract suspend fun updateSettings(input: UpdateSettingsRequest = UpdateSettingsRequest { }): UpdateSettingsResponse

Updates Audit Manager settings for the current account.

Link copied to clipboard

Validates the integrity of an assessment report in Audit Manager.

Inherited functions

Link copied to clipboard

Associates an evidence folder to an assessment report in an Audit Manager assessment.

Link copied to clipboard

Associates a list of evidence to an assessment report in an Audit Manager assessment.

Link copied to clipboard

Creates a batch of delegations for an assessment in Audit Manager.

Link copied to clipboard

Deletes a batch of delegations for an assessment in Audit Manager.

Disassociates a list of evidence from an assessment report in Audit Manager.

Link copied to clipboard

Adds one or more pieces of evidence to a control in an Audit Manager assessment.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

Creates an assessment in Audit Manager.

Link copied to clipboard

Creates a custom framework in Audit Manager.

Link copied to clipboard

Creates an assessment report for the specified assessment.

Link copied to clipboard

Creates a new custom control in Audit Manager.

Link copied to clipboard

Deletes an assessment in Audit Manager.

Link copied to clipboard

Deletes a custom framework in Audit Manager.

Link copied to clipboard

Deletes a share request for a custom framework in Audit Manager.

Link copied to clipboard

Deletes an assessment report in Audit Manager.

Link copied to clipboard

Deletes a custom control in Audit Manager.

Link copied to clipboard

Deregisters an account in Audit Manager.

Link copied to clipboard

Removes the specified Amazon Web Services account as a delegated administrator for Audit Manager.

Disassociates an evidence folder from the specified assessment report in Audit Manager.

Link copied to clipboard

Gets the registration status of an account in Audit Manager.

Link copied to clipboard

Gets information about a specified assessment.

Link copied to clipboard

Gets information about a specified framework.

Link copied to clipboard

Gets the URL of an assessment report in Audit Manager.

Link copied to clipboard

Gets a list of changelogs from Audit Manager.

Link copied to clipboard
inline suspend fun AuditManagerClient.getControl(crossinline block: GetControlRequest.Builder.() -> Unit): GetControlResponse

Gets information about a specified control.

Link copied to clipboard

Gets a list of delegations from an audit owner to a delegate.

Link copied to clipboard

Gets information about a specified evidence item.

Link copied to clipboard

Gets all evidence from a specified evidence folder in Audit Manager.

Link copied to clipboard

Creates a presigned Amazon S3 URL that can be used to upload a file as manual evidence. For instructions on how to use this operation, see Upload a file from your browser in the Audit Manager User Guide.

Link copied to clipboard

Gets an evidence folder from a specified assessment in Audit Manager.

Link copied to clipboard

Gets the evidence folders from a specified assessment in Audit Manager.

Link copied to clipboard

Gets a list of evidence folders that are associated with a specified control in an Audit Manager assessment.

Link copied to clipboard

Gets the latest analytics data for all your current active assessments.

Link copied to clipboard

Gets the latest analytics data for a specific active assessment.

Link copied to clipboard

Gets the name of the delegated Amazon Web Services administrator account for a specified organization.

Link copied to clipboard

Gets a list of the Amazon Web Services services from which Audit Manager can collect evidence.

Link copied to clipboard

Gets the settings for a specified Amazon Web Services account.

Lists the latest analytics data for controls within a specific control domain and a specific active assessment.

Link copied to clipboard

Returns a list of the frameworks that are available in the Audit Manager framework library.

Link copied to clipboard

Returns a list of sent or received share requests for custom frameworks in Audit Manager.

Link copied to clipboard

Returns a list of assessment reports created in Audit Manager.

Link copied to clipboard

Returns a list of current and past assessments from Audit Manager.

Link copied to clipboard

Lists the latest analytics data for control domains across all of your active assessments.

Link copied to clipboard

Lists analytics data for control domains within a specified active assessment.

Link copied to clipboard

Lists the latest analytics data for controls within a specific control domain across all active assessments.

Link copied to clipboard

Returns a list of controls from Audit Manager.

Link copied to clipboard

Returns a list of keywords that are pre-mapped to the specified control data source.

Link copied to clipboard

Returns a list of all Audit Manager notifications.

Link copied to clipboard

Returns a list of tags for the specified resource in Audit Manager.

Link copied to clipboard

Enables Audit Manager for the specified Amazon Web Services account.

Link copied to clipboard

Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager.

Link copied to clipboard

Creates a share request for a custom framework in Audit Manager.

Link copied to clipboard

Tags the specified resource in Audit Manager.

Link copied to clipboard

Removes a tag from a resource in Audit Manager.

Link copied to clipboard

Edits an Audit Manager assessment.

Link copied to clipboard

Updates a control within an assessment in Audit Manager.

Link copied to clipboard

Updates the status of a control set in an Audit Manager assessment.

Link copied to clipboard

Updates a custom framework in Audit Manager.

Link copied to clipboard

Updates a share request for a custom framework in Audit Manager.

Link copied to clipboard

Updates the status of an assessment in Audit Manager.

Link copied to clipboard

Updates a custom control in Audit Manager.

Link copied to clipboard

Updates Audit Manager settings for the current account.

Link copied to clipboard

Validates the integrity of an assessment report in Audit Manager.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.