AuditManagerClient

Suggest an Edit

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:

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

Installation

NPM
npm install @aws-sdk/client-auditmanager
Yarn
yarn add @aws-sdk/client-auditmanager
pnpm
pnpm add @aws-sdk/client-auditmanager

AuditManagerClient Operations

Command
Summary
AssociateAssessmentReportEvidenceFolderCommand

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

BatchAssociateAssessmentReportEvidenceCommand

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

BatchCreateDelegationByAssessmentCommand

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

BatchDeleteDelegationByAssessmentCommand

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

BatchDisassociateAssessmentReportEvidenceCommand

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

BatchImportEvidenceToAssessmentControlCommand

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

You can import manual evidence from any S3 bucket by specifying the S3 URI of the object. You can also upload a file from your browser, or enter plain text in response to a risk assessment question.

The following restrictions apply to this action:

  • manualEvidence can be only one of the following: evidenceFileName, s3ResourcePath, or textResponse

  • Maximum size of an individual evidence file: 100 MB

  • Number of daily manual evidence uploads per control: 100

  • Supported file formats: See Supported file types for manual evidence  in the Audit Manager User Guide

For more information about Audit Manager service restrictions, see Quotas and restrictions for Audit Manager .

CreateAssessmentCommand

Creates an assessment in Audit Manager.

CreateAssessmentFrameworkCommand

Creates a custom framework in Audit Manager.

CreateAssessmentReportCommand

Creates an assessment report for the specified assessment.

CreateControlCommand

Creates a new custom control in Audit Manager.

DeleteAssessmentCommand

Deletes an assessment in Audit Manager.

DeleteAssessmentFrameworkCommand

Deletes a custom framework in Audit Manager.

DeleteAssessmentFrameworkShareCommand

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

DeleteAssessmentReportCommand

Deletes an assessment report in Audit Manager.

When you run the DeleteAssessmentReport operation, Audit Manager attempts to delete the following data:

  1. The specified assessment report that’s stored in your S3 bucket

  2. The associated metadata that’s stored in Audit Manager

If Audit Manager can’t access the assessment report in your S3 bucket, the report isn’t deleted. In this event, the DeleteAssessmentReport operation doesn’t fail. Instead, it proceeds to delete the associated metadata only. You must then delete the assessment report from the S3 bucket yourself.

This scenario happens when Audit Manager receives a 403 (Forbidden) or 404 (Not Found) error from Amazon S3. To avoid this, make sure that your S3 bucket is available, and that you configured the correct permissions for Audit Manager to delete resources in your S3 bucket. For an example permissions policy that you can use, see Assessment report destination permissions  in the Audit Manager User Guide. For information about the issues that could cause a 403 (Forbidden) or 404 (Not Found) error from Amazon S3, see List of Error Codes  in the Amazon Simple Storage Service API Reference.

DeleteControlCommand

Deletes a custom control in Audit Manager.

When you invoke this operation, the custom control is deleted from any frameworks or assessments that it’s currently part of. As a result, Audit Manager will stop collecting evidence for that custom control in all of your assessments. This includes assessments that you previously created before you deleted the custom control.

DeregisterAccountCommand

Deregisters an account in Audit Manager.

Before you deregister, you can use the UpdateSettings  API operation to set your preferred data retention policy. By default, Audit Manager retains your data. If you want to delete your data, you can use the DeregistrationPolicy attribute to request the deletion of your data.

For more information about data retention, see Data Protection  in the Audit Manager User Guide.

DeregisterOrganizationAdminAccountCommand

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

When you remove a delegated administrator from your Audit Manager settings, you continue to have access to the evidence that you previously collected under that account. This is also the case when you deregister a delegated administrator from Organizations. However, Audit Manager stops collecting and attaching evidence to that delegated administrator account moving forward.

Keep in mind the following cleanup task if you use evidence finder:

Before you use your management account to remove a delegated administrator, make sure that the current delegated administrator account signs in to Audit Manager and disables evidence finder first. Disabling evidence finder automatically deletes the event data store that was created in their account when they enabled evidence finder. If this task isn’t completed, the event data store remains in their account. In this case, we recommend that the original delegated administrator goes to CloudTrail Lake and manually deletes the event data store .

This cleanup task is necessary to ensure that you don't end up with multiple event data stores. Audit Manager ignores an unused event data store after you remove or change a delegated administrator account. However, the unused event data store continues to incur storage costs from CloudTrail Lake if you don't delete it.

When you deregister a delegated administrator account for Audit Manager, the data for that account isn’t deleted. If you want to delete resource data for a delegated administrator account, you must perform that task separately before you deregister the account. Either, you can do this in the Audit Manager console. Or, you can use one of the delete API operations that are provided by Audit Manager.

To delete your Audit Manager resource data, see the following instructions:

At this time, Audit Manager doesn't provide an option to delete evidence for a specific delegated administrator. Instead, when your management account deregisters Audit Manager, we perform a cleanup for the current delegated administrator account at the time of deregistration.

DisassociateAssessmentReportEvidenceFolderCommand

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

GetAccountStatusCommand

Gets the registration status of an account in Audit Manager.

GetAssessmentCommand

Gets information about a specified assessment.

GetAssessmentFrameworkCommand

Gets information about a specified framework.

GetAssessmentReportUrlCommand

Gets the URL of an assessment report in Audit Manager.

GetChangeLogsCommand

Gets a list of changelogs from Audit Manager.

GetControlCommand

Gets information about a specified control.

GetDelegationsCommand

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

GetEvidenceByEvidenceFolderCommand

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

GetEvidenceCommand

Gets information about a specified evidence item.

GetEvidenceFileUploadUrlCommand

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.

The following restrictions apply to this operation:

  • Maximum size of an individual evidence file: 100 MB

  • Number of daily manual evidence uploads per control: 100

  • Supported file formats: See Supported file types for manual evidence  in the Audit Manager User Guide

For more information about Audit Manager service restrictions, see Quotas and restrictions for Audit Manager .

GetEvidenceFolderCommand

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

GetEvidenceFoldersByAssessmentCommand

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

GetEvidenceFoldersByAssessmentControlCommand

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

GetInsightsByAssessmentCommand

Gets the latest analytics data for a specific active assessment.

GetInsightsCommand

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

GetOrganizationAdminAccountCommand

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

GetServicesInScopeCommand

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

Audit Manager defines which Amazon Web Services are in scope for an assessment. Audit Manager infers this scope by examining the assessment’s controls and their data sources, and then mapping this information to one or more of the corresponding Amazon Web Services that are in this list.

For information about why it's no longer possible to specify services in scope manually, see I can't edit the services in scope for my assessment  in the Troubleshooting section of the Audit Manager user guide.

GetSettingsCommand

Gets the settings for a specified Amazon Web Services account.

ListAssessmentControlInsightsByControlDomainCommand

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

Control insights are listed only if the control belongs to the control domain and assessment that was specified. Moreover, the control must have collected evidence on the lastUpdated date of controlInsightsByAssessment. If neither of these conditions are met, no data is listed for that control.

ListAssessmentFrameworkShareRequestsCommand

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

ListAssessmentFrameworksCommand

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

ListAssessmentReportsCommand

Returns a list of assessment reports created in Audit Manager.

ListAssessmentsCommand

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

ListControlDomainInsightsByAssessmentCommand

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

Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see ListDomains   in the Amazon Web Services Control Catalog API Reference.

A control domain is listed only if at least one of the controls within that domain collected evidence on the lastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that domain.

ListControlDomainInsightsCommand

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

Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see ListDomains   in the Amazon Web Services Control Catalog API Reference.

A control domain is listed only if at least one of the controls within that domain collected evidence on the lastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that control domain.

ListControlInsightsByControlDomainCommand

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

Control insights are listed only if the control belongs to the control domain that was specified and the control collected evidence on the lastUpdated date of controlInsightsMetadata. If neither of these conditions are met, no data is listed for that control.

ListControlsCommand

Returns a list of controls from Audit Manager.

ListKeywordsForDataSourceCommand

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

ListNotificationsCommand

Returns a list of all Audit Manager notifications.

ListTagsForResourceCommand

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

RegisterAccountCommand

Enables Audit Manager for the specified Amazon Web Services account.

RegisterOrganizationAdminAccountCommand

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

StartAssessmentFrameworkShareCommand

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

The share request specifies a recipient and notifies them that a custom framework is available. Recipients have 120 days to accept or decline the request. If no action is taken, the share request expires.

When you create a share request, Audit Manager stores a snapshot of your custom framework in the US East (N. Virginia) Amazon Web Services Region. Audit Manager also stores a backup of the same snapshot in the US West (Oregon) Amazon Web Services Region.

Audit Manager deletes the snapshot and the backup snapshot when one of the following events occurs:

  • The sender revokes the share request.

  • The recipient declines the share request.

  • The recipient encounters an error and doesn't successfully accept the share request.

  • The share request expires before the recipient responds to the request.

When a sender resends a share request , the snapshot is replaced with an updated version that corresponds with the latest version of the custom framework.

When a recipient accepts a share request, the snapshot is replicated into their Amazon Web Services account under the Amazon Web Services Region that was specified in the share request.

When you invoke the StartAssessmentFrameworkShare API, you are about to share a custom framework with another Amazon Web Services account. You may not share a custom framework that is derived from a standard framework if the standard framework is designated as not eligible for sharing by Amazon Web Services, unless you have obtained permission to do so from the owner of the standard framework. To learn more about which standard frameworks are eligible for sharing, see Framework sharing eligibility  in the Audit Manager User Guide.

TagResourceCommand

Tags the specified resource in Audit Manager.

UntagResourceCommand

Removes a tag from a resource in Audit Manager.

UpdateAssessmentCommand

Edits an Audit Manager assessment.

UpdateAssessmentControlCommand

Updates a control within an assessment in Audit Manager.

UpdateAssessmentControlSetStatusCommand

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

UpdateAssessmentFrameworkCommand

Updates a custom framework in Audit Manager.

UpdateAssessmentFrameworkShareCommand

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

UpdateAssessmentStatusCommand

Updates the status of an assessment in Audit Manager.

UpdateControlCommand

Updates a custom control in Audit Manager.

UpdateSettingsCommand

Updates Audit Manager settings for the current account.

ValidateAssessmentReportIntegrityCommand

Validates the integrity of an assessment report in Audit Manager.

AuditManagerClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: AuditManagerClientConfig