Navigation Guide
You are on the package index page for the Client of a service. Return to the Client landing page

@aws-sdk/client-auditmanager

Description

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 .

Installation

NPM

npm install @aws-sdk/client-auditmanager

Yarn

yarn add @aws-sdk/client-auditmanager

pnpm

pnpm add @aws-sdk/client-auditmanager

Types

Type Name	Type
AccessDeniedException	Class
AccountStatus	TypeAlias
AccountStatusenum	Variable
ActionEnum	TypeAlias
ActionEnumenum	Variable
Assessment	Interface
AssessmentControl	Interface
AssessmentControlSet	Interface
AssessmentEvidenceFolder	Interface
AssessmentFramework	Interface
AssessmentFrameworkMetadata	Interface
AssessmentFrameworkShareRequest	Interface
AssessmentMetadata	Interface
AssessmentMetadataItem	Interface
AssessmentReport	Interface
AssessmentReportDestinationType	TypeAlias
AssessmentReportDestinationTypeenum	Variable
AssessmentReportEvidenceError	Interface
AssessmentReportMetadata	Interface
AssessmentReportsDestination	Interface
AssessmentReportStatus	TypeAlias
AssessmentReportStatusenum	Variable
AssessmentStatus	TypeAlias
AssessmentStatusenum	Variable
AssociateAssessmentReportEvidenceFolderCommand	Class
AssociateAssessmentReportEvidenceFolderCommandInput	Interface
AssociateAssessmentReportEvidenceFolderCommandOutput	Interface
AssociateAssessmentReportEvidenceFolderRequest	Interface
AssociateAssessmentReportEvidenceFolderResponse	Interface
AuditManager	Class
AuditManager	Interface
AuditManagerClient	Class
AuditManagerClientConfig	Interface
AuditManagerClientConfigType	TypeAlias
AuditManagerClientResolvedConfig	Interface
AuditManagerClientResolvedConfigType	TypeAlias
AuditManagerPaginationConfiguration	Interface
AuditManagerServiceException	Class
AWSAccount	Interface
AWSService	Interface
BatchAssociateAssessmentReportEvidenceCommand	Class
BatchAssociateAssessmentReportEvidenceCommandInput	Interface
BatchAssociateAssessmentReportEvidenceCommandOutput	Interface
BatchAssociateAssessmentReportEvidenceRequest	Interface
BatchAssociateAssessmentReportEvidenceResponse	Interface
BatchCreateDelegationByAssessmentCommand	Class
BatchCreateDelegationByAssessmentCommandInput	Interface
BatchCreateDelegationByAssessmentCommandOutput	Interface
BatchCreateDelegationByAssessmentError	Interface
BatchCreateDelegationByAssessmentRequest	Interface
BatchCreateDelegationByAssessmentResponse	Interface
BatchDeleteDelegationByAssessmentCommand	Class
BatchDeleteDelegationByAssessmentCommandInput	Interface
BatchDeleteDelegationByAssessmentCommandOutput	Interface
BatchDeleteDelegationByAssessmentError	Interface
BatchDeleteDelegationByAssessmentRequest	Interface
BatchDeleteDelegationByAssessmentResponse	Interface
BatchDisassociateAssessmentReportEvidenceCommand	Class
BatchDisassociateAssessmentReportEvidenceCommandInput	Interface
BatchDisassociateAssessmentReportEvidenceCommandOutput	Interface
BatchDisassociateAssessmentReportEvidenceRequest	Interface
BatchDisassociateAssessmentReportEvidenceResponse	Interface
BatchImportEvidenceToAssessmentControlCommand	Class
BatchImportEvidenceToAssessmentControlCommandInput	Interface
BatchImportEvidenceToAssessmentControlCommandOutput	Interface
BatchImportEvidenceToAssessmentControlError	Interface
BatchImportEvidenceToAssessmentControlRequest	Interface
BatchImportEvidenceToAssessmentControlResponse	Interface
ChangeLog	Interface
ClientDefaults	Interface
ClientInputEndpointParameters	Interface
Control	Interface
ControlComment	Interface
ControlDomainInsights	Interface
ControlInsightsMetadataByAssessmentItem	Interface
ControlInsightsMetadataItem	Interface
ControlMappingSource	Interface
ControlMetadata	Interface
ControlResponse	TypeAlias
ControlResponseenum	Variable
ControlSet	Interface
ControlSetStatus	TypeAlias
ControlSetStatusenum	Variable
ControlState	TypeAlias
ControlStateenum	Variable
ControlStatus	TypeAlias
ControlStatusenum	Variable
ControlType	TypeAlias
ControlTypeenum	Variable
CreateAssessmentCommand	Class
CreateAssessmentCommandInput	Interface
CreateAssessmentCommandOutput	Interface
CreateAssessmentFrameworkCommand	Class
CreateAssessmentFrameworkCommandInput	Interface
CreateAssessmentFrameworkCommandOutput	Interface
CreateAssessmentFrameworkControl	Interface
CreateAssessmentFrameworkControlSet	Interface
CreateAssessmentFrameworkRequest	Interface
CreateAssessmentFrameworkResponse	Interface
CreateAssessmentReportCommand	Class
CreateAssessmentReportCommandInput	Interface
CreateAssessmentReportCommandOutput	Interface
CreateAssessmentReportRequest	Interface
CreateAssessmentReportResponse	Interface
CreateAssessmentRequest	Interface
CreateAssessmentResponse	Interface
CreateControlCommand	Class
CreateControlCommandInput	Interface
CreateControlCommandOutput	Interface
CreateControlMappingSource	Interface
CreateControlRequest	Interface
CreateControlResponse	Interface
CreateDelegationRequest	Interface
DataSourceType	TypeAlias
DataSourceTypeenum	Variable
DefaultExportDestination	Interface
Delegation	Interface
DelegationMetadata	Interface
DelegationStatus	TypeAlias
DelegationStatusenum	Variable
DeleteAssessmentCommand	Class
DeleteAssessmentCommandInput	Interface
DeleteAssessmentCommandOutput	Interface
DeleteAssessmentFrameworkCommand	Class
DeleteAssessmentFrameworkCommandInput	Interface
DeleteAssessmentFrameworkCommandOutput	Interface
DeleteAssessmentFrameworkRequest	Interface
DeleteAssessmentFrameworkResponse	Interface
DeleteAssessmentFrameworkShareCommand	Class
DeleteAssessmentFrameworkShareCommandInput	Interface
DeleteAssessmentFrameworkShareCommandOutput	Interface
DeleteAssessmentFrameworkShareRequest	Interface
DeleteAssessmentFrameworkShareResponse	Interface
DeleteAssessmentReportCommand	Class
DeleteAssessmentReportCommandInput	Interface
DeleteAssessmentReportCommandOutput	Interface
DeleteAssessmentReportRequest	Interface
DeleteAssessmentReportResponse	Interface
DeleteAssessmentRequest	Interface
DeleteAssessmentResponse	Interface
DeleteControlCommand	Class
DeleteControlCommandInput	Interface
DeleteControlCommandOutput	Interface
DeleteControlRequest	Interface
DeleteControlResponse	Interface
DeleteResources	TypeAlias
DeleteResourcesenum	Variable
DeregisterAccountCommand	Class
DeregisterAccountCommandInput	Interface
DeregisterAccountCommandOutput	Interface
DeregisterAccountRequest	Interface
DeregisterAccountResponse	Interface
DeregisterOrganizationAdminAccountCommand	Class
DeregisterOrganizationAdminAccountCommandInput	Interface
DeregisterOrganizationAdminAccountCommandOutput	Interface
DeregisterOrganizationAdminAccountRequest	Interface
DeregisterOrganizationAdminAccountResponse	Interface
DeregistrationPolicy	Interface
DisassociateAssessmentReportEvidenceFolderCommand	Class
DisassociateAssessmentReportEvidenceFolderCommandInput	Interface
DisassociateAssessmentReportEvidenceFolderCommandOutput	Interface
DisassociateAssessmentReportEvidenceFolderRequest	Interface
DisassociateAssessmentReportEvidenceFolderResponse	Interface
Evidence	Interface
EvidenceFinderBackfillStatus	TypeAlias
EvidenceFinderBackfillStatusenum	Variable
EvidenceFinderEnablement	Interface
EvidenceFinderEnablementStatus	TypeAlias
EvidenceFinderEnablementStatusenum	Variable
EvidenceInsights	Interface
ExportDestinationType	TypeAlias
ExportDestinationTypeenum	Variable
Framework	Interface
FrameworkMetadata	Interface
FrameworkType	TypeAlias
FrameworkTypeenum	Variable
GetAccountStatusCommand	Class
GetAccountStatusCommandInput	Interface
GetAccountStatusCommandOutput	Interface
GetAccountStatusRequest	Interface
GetAccountStatusResponse	Interface
GetAssessmentCommand	Class
GetAssessmentCommandInput	Interface
GetAssessmentCommandOutput	Interface
GetAssessmentFrameworkCommand	Class
GetAssessmentFrameworkCommandInput	Interface
GetAssessmentFrameworkCommandOutput	Interface
GetAssessmentFrameworkRequest	Interface
GetAssessmentFrameworkResponse	Interface
GetAssessmentReportUrlCommand	Class
GetAssessmentReportUrlCommandInput	Interface
GetAssessmentReportUrlCommandOutput	Interface
GetAssessmentReportUrlRequest	Interface
GetAssessmentReportUrlResponse	Interface
GetAssessmentRequest	Interface
GetAssessmentResponse	Interface
GetChangeLogsCommand	Class
GetChangeLogsCommandInput	Interface
GetChangeLogsCommandOutput	Interface
GetChangeLogsRequest	Interface
GetChangeLogsResponse	Interface
GetControlCommand	Class
GetControlCommandInput	Interface
GetControlCommandOutput	Interface
GetControlRequest	Interface
GetControlResponse	Interface
GetDelegationsCommand	Class
GetDelegationsCommandInput	Interface
GetDelegationsCommandOutput	Interface
GetDelegationsRequest	Interface
GetDelegationsResponse	Interface
GetEvidenceByEvidenceFolderCommand	Class
GetEvidenceByEvidenceFolderCommandInput	Interface
GetEvidenceByEvidenceFolderCommandOutput	Interface
GetEvidenceByEvidenceFolderRequest	Interface
GetEvidenceByEvidenceFolderResponse	Interface
GetEvidenceCommand	Class
GetEvidenceCommandInput	Interface
GetEvidenceCommandOutput	Interface
GetEvidenceFileUploadUrlCommand	Class
GetEvidenceFileUploadUrlCommandInput	Interface
GetEvidenceFileUploadUrlCommandOutput	Interface
GetEvidenceFileUploadUrlRequest	Interface
GetEvidenceFileUploadUrlResponse	Interface
GetEvidenceFolderCommand	Class
GetEvidenceFolderCommandInput	Interface
GetEvidenceFolderCommandOutput	Interface
GetEvidenceFolderRequest	Interface
GetEvidenceFolderResponse	Interface
GetEvidenceFoldersByAssessmentCommand	Class
GetEvidenceFoldersByAssessmentCommandInput	Interface
GetEvidenceFoldersByAssessmentCommandOutput	Interface
GetEvidenceFoldersByAssessmentControlCommand	Class
GetEvidenceFoldersByAssessmentControlCommandInput	Interface
GetEvidenceFoldersByAssessmentControlCommandOutput	Interface
GetEvidenceFoldersByAssessmentControlRequest	Interface
GetEvidenceFoldersByAssessmentControlResponse	Interface
GetEvidenceFoldersByAssessmentRequest	Interface
GetEvidenceFoldersByAssessmentResponse	Interface
GetEvidenceRequest	Interface
GetEvidenceResponse	Interface
GetInsightsByAssessmentCommand	Class
GetInsightsByAssessmentCommandInput	Interface
GetInsightsByAssessmentCommandOutput	Interface
GetInsightsByAssessmentRequest	Interface
GetInsightsByAssessmentResponse	Interface
GetInsightsCommand	Class
GetInsightsCommandInput	Interface
GetInsightsCommandOutput	Interface
GetInsightsRequest	Interface
GetInsightsResponse	Interface
GetOrganizationAdminAccountCommand	Class
GetOrganizationAdminAccountCommandInput	Interface
GetOrganizationAdminAccountCommandOutput	Interface
GetOrganizationAdminAccountRequest	Interface
GetOrganizationAdminAccountResponse	Interface
GetServicesInScopeCommand	Class
GetServicesInScopeCommandInput	Interface
GetServicesInScopeCommandOutput	Interface
GetServicesInScopeRequest	Interface
GetServicesInScopeResponse	Interface
GetSettingsCommand	Class
GetSettingsCommandInput	Interface
GetSettingsCommandOutput	Interface
GetSettingsRequest	Interface
GetSettingsResponse	Interface
Insights	Interface
InsightsByAssessment	Interface
InternalServerException	Class
KeywordInputType	TypeAlias
KeywordInputTypeenum	Variable
ListAssessmentControlInsightsByControlDomainCommand	Class
ListAssessmentControlInsightsByControlDomainCommandInput	Interface
ListAssessmentControlInsightsByControlDomainCommandOutput	Interface
ListAssessmentControlInsightsByControlDomainRequest	Interface
ListAssessmentControlInsightsByControlDomainResponse	Interface
ListAssessmentFrameworksCommand	Class
ListAssessmentFrameworksCommandInput	Interface
ListAssessmentFrameworksCommandOutput	Interface
ListAssessmentFrameworkShareRequestsCommand	Class
ListAssessmentFrameworkShareRequestsCommandInput	Interface
ListAssessmentFrameworkShareRequestsCommandOutput	Interface
ListAssessmentFrameworkShareRequestsRequest	Interface
ListAssessmentFrameworkShareRequestsResponse	Interface
ListAssessmentFrameworksRequest	Interface
ListAssessmentFrameworksResponse	Interface
ListAssessmentReportsCommand	Class
ListAssessmentReportsCommandInput	Interface
ListAssessmentReportsCommandOutput	Interface
ListAssessmentReportsRequest	Interface
ListAssessmentReportsResponse	Interface
ListAssessmentsCommand	Class
ListAssessmentsCommandInput	Interface
ListAssessmentsCommandOutput	Interface
ListAssessmentsRequest	Interface
ListAssessmentsResponse	Interface
ListControlDomainInsightsByAssessmentCommand	Class
ListControlDomainInsightsByAssessmentCommandInput	Interface
ListControlDomainInsightsByAssessmentCommandOutput	Interface
ListControlDomainInsightsByAssessmentRequest	Interface
ListControlDomainInsightsByAssessmentResponse	Interface
ListControlDomainInsightsCommand	Class
ListControlDomainInsightsCommandInput	Interface
ListControlDomainInsightsCommandOutput	Interface
ListControlDomainInsightsRequest	Interface
ListControlDomainInsightsResponse	Interface
ListControlInsightsByControlDomainCommand	Class
ListControlInsightsByControlDomainCommandInput	Interface
ListControlInsightsByControlDomainCommandOutput	Interface
ListControlInsightsByControlDomainRequest	Interface
ListControlInsightsByControlDomainResponse	Interface
ListControlsCommand	Class
ListControlsCommandInput	Interface
ListControlsCommandOutput	Interface
ListControlsRequest	Interface
ListControlsResponse	Interface
ListKeywordsForDataSourceCommand	Class
ListKeywordsForDataSourceCommandInput	Interface
ListKeywordsForDataSourceCommandOutput	Interface
ListKeywordsForDataSourceRequest	Interface
ListKeywordsForDataSourceResponse	Interface
ListNotificationsCommand	Class
ListNotificationsCommandInput	Interface
ListNotificationsCommandOutput	Interface
ListNotificationsRequest	Interface
ListNotificationsResponse	Interface
ListTagsForResourceCommand	Class
ListTagsForResourceCommandInput	Interface
ListTagsForResourceCommandOutput	Interface
ListTagsForResourceRequest	Interface
ListTagsForResourceResponse	Interface
ManualEvidence	Interface
Notification	Interface
ObjectTypeEnum	TypeAlias
ObjectTypeEnumenum	Variable
paginateGetChangeLogs	Variable
paginateGetDelegations	Variable
paginateGetEvidenceByEvidenceFolder	Variable
paginateGetEvidenceFoldersByAssessment	Variable
paginateGetEvidenceFoldersByAssessmentControl	Variable
paginateListAssessmentControlInsightsByControlDomain	Variable
paginateListAssessmentFrameworks	Variable
paginateListAssessmentFrameworkShareRequests	Variable
paginateListAssessmentReports	Variable
paginateListAssessments	Variable
paginateListControlDomainInsights	Variable
paginateListControlDomainInsightsByAssessment	Variable
paginateListControlInsightsByControlDomain	Variable
paginateListControls	Variable
paginateListKeywordsForDataSource	Variable
paginateListNotifications	Variable
RegisterAccountCommand	Class
RegisterAccountCommandInput	Interface
RegisterAccountCommandOutput	Interface
RegisterAccountRequest	Interface
RegisterAccountResponse	Interface
RegisterOrganizationAdminAccountCommand	Class
RegisterOrganizationAdminAccountCommandInput	Interface
RegisterOrganizationAdminAccountCommandOutput	Interface
RegisterOrganizationAdminAccountRequest	Interface
RegisterOrganizationAdminAccountResponse	Interface
Resource	Interface
ResourceNotFoundException	Class
Role	Interface
RoleType	TypeAlias
RoleTypeenum	Variable
RuntimeExtension	Interface
Scope	Interface
ServiceInputTypes	TypeAlias
ServiceMetadata	Interface
ServiceOutputTypes	TypeAlias
ServiceQuotaExceededException	Class
SettingAttribute	TypeAlias
SettingAttributeenum	Variable
Settings	Interface
ShareRequestAction	TypeAlias
ShareRequestActionenum	Variable
ShareRequestStatus	TypeAlias
ShareRequestStatusenum	Variable
ShareRequestType	TypeAlias
ShareRequestTypeenum	Variable
SourceFrequency	TypeAlias
SourceFrequencyenum	Variable
SourceKeyword	Interface
SourceSetUpOption	TypeAlias
SourceSetUpOptionenum	Variable
SourceType	TypeAlias
SourceTypeenum	Variable
StartAssessmentFrameworkShareCommand	Class
StartAssessmentFrameworkShareCommandInput	Interface
StartAssessmentFrameworkShareCommandOutput	Interface
StartAssessmentFrameworkShareRequest	Interface
StartAssessmentFrameworkShareResponse	Interface
TagResourceCommand	Class
TagResourceCommandInput	Interface
TagResourceCommandOutput	Interface
TagResourceRequest	Interface
TagResourceResponse	Interface
ThrottlingException	Class
UntagResourceCommand	Class
UntagResourceCommandInput	Interface
UntagResourceCommandOutput	Interface
UntagResourceRequest	Interface
UntagResourceResponse	Interface
UpdateAssessmentCommand	Class
UpdateAssessmentCommandInput	Interface
UpdateAssessmentCommandOutput	Interface
UpdateAssessmentControlCommand	Class
UpdateAssessmentControlCommandInput	Interface
UpdateAssessmentControlCommandOutput	Interface
UpdateAssessmentControlRequest	Interface
UpdateAssessmentControlResponse	Interface
UpdateAssessmentControlSetStatusCommand	Class
UpdateAssessmentControlSetStatusCommandInput	Interface
UpdateAssessmentControlSetStatusCommandOutput	Interface
UpdateAssessmentControlSetStatusRequest	Interface
UpdateAssessmentControlSetStatusResponse	Interface
UpdateAssessmentFrameworkCommand	Class
UpdateAssessmentFrameworkCommandInput	Interface
UpdateAssessmentFrameworkCommandOutput	Interface
UpdateAssessmentFrameworkControlSet	Interface
UpdateAssessmentFrameworkRequest	Interface
UpdateAssessmentFrameworkResponse	Interface
UpdateAssessmentFrameworkShareCommand	Class
UpdateAssessmentFrameworkShareCommandInput	Interface
UpdateAssessmentFrameworkShareCommandOutput	Interface
UpdateAssessmentFrameworkShareRequest	Interface
UpdateAssessmentFrameworkShareResponse	Interface
UpdateAssessmentRequest	Interface
UpdateAssessmentResponse	Interface
UpdateAssessmentStatusCommand	Class
UpdateAssessmentStatusCommandInput	Interface
UpdateAssessmentStatusCommandOutput	Interface
UpdateAssessmentStatusRequest	Interface
UpdateAssessmentStatusResponse	Interface
UpdateControlCommand	Class
UpdateControlCommandInput	Interface
UpdateControlCommandOutput	Interface
UpdateControlRequest	Interface
UpdateControlResponse	Interface
UpdateSettingsCommand	Class
UpdateSettingsCommandInput	Interface
UpdateSettingsCommandOutput	Interface
UpdateSettingsRequest	Interface
UpdateSettingsResponse	Interface
URL	Interface
ValidateAssessmentReportIntegrityCommand	Class
ValidateAssessmentReportIntegrityCommandInput	Interface
ValidateAssessmentReportIntegrityCommandOutput	Interface
ValidateAssessmentReportIntegrityRequest	Interface
ValidateAssessmentReportIntegrityResponse	Interface
ValidationException	Class
ValidationExceptionField	Interface
ValidationExceptionReason	TypeAlias
ValidationExceptionReasonenum	Variable

Getting Started

References

@aws-sdk/client-auditmanager

Description

Installation

Types

Table of Contents

Search