{ "version":"2.0", "metadata":{ "apiVersion":"2017-07-25", "endpointPrefix":"auditmanager", "jsonVersion":"1.1", "protocol":"rest-json", "serviceFullName":"AWS Audit Manager", "serviceId":"AuditManager", "signatureVersion":"v4", "signingName":"auditmanager", "uid":"auditmanager-2017-07-25" }, "operations":{ "AssociateAssessmentReportEvidenceFolder":{ "name":"AssociateAssessmentReportEvidenceFolder", "http":{ "method":"PUT", "requestUri":"/assessments/{assessmentId}/associateToAssessmentReport" }, "input":{"shape":"AssociateAssessmentReportEvidenceFolderRequest"}, "output":{"shape":"AssociateAssessmentReportEvidenceFolderResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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

" }, "BatchAssociateAssessmentReportEvidence":{ "name":"BatchAssociateAssessmentReportEvidence", "http":{ "method":"PUT", "requestUri":"/assessments/{assessmentId}/batchAssociateToAssessmentReport" }, "input":{"shape":"BatchAssociateAssessmentReportEvidenceRequest"}, "output":{"shape":"BatchAssociateAssessmentReportEvidenceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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

" }, "BatchCreateDelegationByAssessment":{ "name":"BatchCreateDelegationByAssessment", "http":{ "method":"POST", "requestUri":"/assessments/{assessmentId}/delegations" }, "input":{"shape":"BatchCreateDelegationByAssessmentRequest"}, "output":{"shape":"BatchCreateDelegationByAssessmentResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

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

" }, "BatchDeleteDelegationByAssessment":{ "name":"BatchDeleteDelegationByAssessment", "http":{ "method":"PUT", "requestUri":"/assessments/{assessmentId}/delegations" }, "input":{"shape":"BatchDeleteDelegationByAssessmentRequest"}, "output":{"shape":"BatchDeleteDelegationByAssessmentResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

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

" }, "BatchDisassociateAssessmentReportEvidence":{ "name":"BatchDisassociateAssessmentReportEvidence", "http":{ "method":"PUT", "requestUri":"/assessments/{assessmentId}/batchDisassociateFromAssessmentReport" }, "input":{"shape":"BatchDisassociateAssessmentReportEvidenceRequest"}, "output":{"shape":"BatchDisassociateAssessmentReportEvidenceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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

" }, "BatchImportEvidenceToAssessmentControl":{ "name":"BatchImportEvidenceToAssessmentControl", "http":{ "method":"POST", "requestUri":"/assessments/{assessmentId}/controlSets/{controlSetId}/controls/{controlId}/evidence" }, "input":{"shape":"BatchImportEvidenceToAssessmentControlRequest"}, "output":{"shape":"BatchImportEvidenceToAssessmentControlResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

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.

" }, "CreateAssessment":{ "name":"CreateAssessment", "http":{ "method":"POST", "requestUri":"/assessments" }, "input":{"shape":"CreateAssessmentRequest"}, "output":{"shape":"CreateAssessmentResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Creates an assessment in Audit Manager.

" }, "CreateAssessmentFramework":{ "name":"CreateAssessmentFramework", "http":{ "method":"POST", "requestUri":"/assessmentFrameworks" }, "input":{"shape":"CreateAssessmentFrameworkRequest"}, "output":{"shape":"CreateAssessmentFrameworkResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Creates a custom framework in Audit Manager.

" }, "CreateAssessmentReport":{ "name":"CreateAssessmentReport", "http":{ "method":"POST", "requestUri":"/assessments/{assessmentId}/reports" }, "input":{"shape":"CreateAssessmentReportRequest"}, "output":{"shape":"CreateAssessmentReportResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Creates an assessment report for the specified assessment.

" }, "CreateControl":{ "name":"CreateControl", "http":{ "method":"POST", "requestUri":"/controls" }, "input":{"shape":"CreateControlRequest"}, "output":{"shape":"CreateControlResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Creates a new custom control in Audit Manager.

" }, "DeleteAssessment":{ "name":"DeleteAssessment", "http":{ "method":"DELETE", "requestUri":"/assessments/{assessmentId}" }, "input":{"shape":"DeleteAssessmentRequest"}, "output":{"shape":"DeleteAssessmentResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

Deletes an assessment in Audit Manager.

" }, "DeleteAssessmentFramework":{ "name":"DeleteAssessmentFramework", "http":{ "method":"DELETE", "requestUri":"/assessmentFrameworks/{frameworkId}" }, "input":{"shape":"DeleteAssessmentFrameworkRequest"}, "output":{"shape":"DeleteAssessmentFrameworkResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

Deletes a custom framework in Audit Manager.

" }, "DeleteAssessmentFrameworkShare":{ "name":"DeleteAssessmentFrameworkShare", "http":{ "method":"DELETE", "requestUri":"/assessmentFrameworkShareRequests/{requestId}" }, "input":{"shape":"DeleteAssessmentFrameworkShareRequest"}, "output":{"shape":"DeleteAssessmentFrameworkShareResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

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

" }, "DeleteAssessmentReport":{ "name":"DeleteAssessmentReport", "http":{ "method":"DELETE", "requestUri":"/assessments/{assessmentId}/reports/{assessmentReportId}" }, "input":{"shape":"DeleteAssessmentReportRequest"}, "output":{"shape":"DeleteAssessmentReportResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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.

" }, "DeleteControl":{ "name":"DeleteControl", "http":{ "method":"DELETE", "requestUri":"/controls/{controlId}" }, "input":{"shape":"DeleteControlRequest"}, "output":{"shape":"DeleteControlResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

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.

" }, "DeregisterAccount":{ "name":"DeregisterAccount", "http":{ "method":"POST", "requestUri":"/account/deregisterAccount" }, "input":{"shape":"DeregisterAccountRequest"}, "output":{"shape":"DeregisterAccountResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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.

" }, "DeregisterOrganizationAdminAccount":{ "name":"DeregisterOrganizationAdminAccount", "http":{ "method":"POST", "requestUri":"/account/deregisterOrganizationAdminAccount" }, "input":{"shape":"DeregisterOrganizationAdminAccountRequest"}, "output":{"shape":"DeregisterOrganizationAdminAccountResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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:

- DeleteAssessment (see also: Deleting an assessment in the Audit Manager User Guide)

- DeleteAssessmentFramework (see also: Deleting a custom framework in the Audit Manager User Guide)

- DeleteAssessmentFrameworkShare (see also: Deleting a share request in the Audit Manager User Guide)

- DeleteAssessmentReport (see also: Deleting an assessment report in the Audit Manager User Guide)

- DeleteControl (see also: Deleting a custom control in the Audit Manager User Guide)

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.

" }, "DisassociateAssessmentReportEvidenceFolder":{ "name":"DisassociateAssessmentReportEvidenceFolder", "http":{ "method":"PUT", "requestUri":"/assessments/{assessmentId}/disassociateFromAssessmentReport" }, "input":{"shape":"DisassociateAssessmentReportEvidenceFolderRequest"}, "output":{"shape":"DisassociateAssessmentReportEvidenceFolderResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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

" }, "GetAccountStatus":{ "name":"GetAccountStatus", "http":{ "method":"GET", "requestUri":"/account/status" }, "input":{"shape":"GetAccountStatusRequest"}, "output":{"shape":"GetAccountStatusResponse"}, "errors":[ {"shape":"InternalServerException"} ], "documentation":"

Gets the registration status of an account in Audit Manager.

" }, "GetAssessment":{ "name":"GetAssessment", "http":{ "method":"GET", "requestUri":"/assessments/{assessmentId}" }, "input":{"shape":"GetAssessmentRequest"}, "output":{"shape":"GetAssessmentResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

Gets information about a specified assessment.

" }, "GetAssessmentFramework":{ "name":"GetAssessmentFramework", "http":{ "method":"GET", "requestUri":"/assessmentFrameworks/{frameworkId}" }, "input":{"shape":"GetAssessmentFrameworkRequest"}, "output":{"shape":"GetAssessmentFrameworkResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

Gets information about a specified framework.

" }, "GetAssessmentReportUrl":{ "name":"GetAssessmentReportUrl", "http":{ "method":"GET", "requestUri":"/assessments/{assessmentId}/reports/{assessmentReportId}/url" }, "input":{"shape":"GetAssessmentReportUrlRequest"}, "output":{"shape":"GetAssessmentReportUrlResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Gets the URL of an assessment report in Audit Manager.

" }, "GetChangeLogs":{ "name":"GetChangeLogs", "http":{ "method":"GET", "requestUri":"/assessments/{assessmentId}/changelogs" }, "input":{"shape":"GetChangeLogsRequest"}, "output":{"shape":"GetChangeLogsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

Gets a list of changelogs from Audit Manager.

" }, "GetControl":{ "name":"GetControl", "http":{ "method":"GET", "requestUri":"/controls/{controlId}" }, "input":{"shape":"GetControlRequest"}, "output":{"shape":"GetControlResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

Gets information about a specified control.

" }, "GetDelegations":{ "name":"GetDelegations", "http":{ "method":"GET", "requestUri":"/delegations" }, "input":{"shape":"GetDelegationsRequest"}, "output":{"shape":"GetDelegationsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

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

" }, "GetEvidence":{ "name":"GetEvidence", "http":{ "method":"GET", "requestUri":"/assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders/{evidenceFolderId}/evidence/{evidenceId}" }, "input":{"shape":"GetEvidenceRequest"}, "output":{"shape":"GetEvidenceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

Gets information about a specified evidence item.

" }, "GetEvidenceByEvidenceFolder":{ "name":"GetEvidenceByEvidenceFolder", "http":{ "method":"GET", "requestUri":"/assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders/{evidenceFolderId}/evidence" }, "input":{"shape":"GetEvidenceByEvidenceFolderRequest"}, "output":{"shape":"GetEvidenceByEvidenceFolderResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

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

" }, "GetEvidenceFileUploadUrl":{ "name":"GetEvidenceFileUploadUrl", "http":{ "method":"GET", "requestUri":"/evidenceFileUploadUrl" }, "input":{"shape":"GetEvidenceFileUploadUrlRequest"}, "output":{"shape":"GetEvidenceFileUploadUrlResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

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.

" }, "GetEvidenceFolder":{ "name":"GetEvidenceFolder", "http":{ "method":"GET", "requestUri":"/assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders/{evidenceFolderId}" }, "input":{"shape":"GetEvidenceFolderRequest"}, "output":{"shape":"GetEvidenceFolderResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

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

" }, "GetEvidenceFoldersByAssessment":{ "name":"GetEvidenceFoldersByAssessment", "http":{ "method":"GET", "requestUri":"/assessments/{assessmentId}/evidenceFolders" }, "input":{"shape":"GetEvidenceFoldersByAssessmentRequest"}, "output":{"shape":"GetEvidenceFoldersByAssessmentResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

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

" }, "GetEvidenceFoldersByAssessmentControl":{ "name":"GetEvidenceFoldersByAssessmentControl", "http":{ "method":"GET", "requestUri":"/assessments/{assessmentId}/evidenceFolders-by-assessment-control/{controlSetId}/{controlId}" }, "input":{"shape":"GetEvidenceFoldersByAssessmentControlRequest"}, "output":{"shape":"GetEvidenceFoldersByAssessmentControlResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

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

" }, "GetInsights":{ "name":"GetInsights", "http":{ "method":"GET", "requestUri":"/insights" }, "input":{"shape":"GetInsightsRequest"}, "output":{"shape":"GetInsightsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

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

" }, "GetInsightsByAssessment":{ "name":"GetInsightsByAssessment", "http":{ "method":"GET", "requestUri":"/insights/assessments/{assessmentId}" }, "input":{"shape":"GetInsightsByAssessmentRequest"}, "output":{"shape":"GetInsightsByAssessmentResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

Gets the latest analytics data for a specific active assessment.

" }, "GetOrganizationAdminAccount":{ "name":"GetOrganizationAdminAccount", "http":{ "method":"GET", "requestUri":"/account/organizationAdminAccount" }, "input":{"shape":"GetOrganizationAdminAccountRequest"}, "output":{"shape":"GetOrganizationAdminAccountResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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

" }, "GetServicesInScope":{ "name":"GetServicesInScope", "http":{ "method":"GET", "requestUri":"/services" }, "input":{"shape":"GetServicesInScopeRequest"}, "output":{"shape":"GetServicesInScopeResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

Gets a list of all of the Amazon Web Services that you can choose to include in your assessment. When you create an assessment, specify which of these services you want to include to narrow the assessment's scope.

" }, "GetSettings":{ "name":"GetSettings", "http":{ "method":"GET", "requestUri":"/settings/{attribute}" }, "input":{"shape":"GetSettingsRequest"}, "output":{"shape":"GetSettingsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

Gets the settings for a specified Amazon Web Services account.

" }, "ListAssessmentControlInsightsByControlDomain":{ "name":"ListAssessmentControlInsightsByControlDomain", "http":{ "method":"GET", "requestUri":"/insights/controls-by-assessment" }, "input":{"shape":"ListAssessmentControlInsightsByControlDomainRequest"}, "output":{"shape":"ListAssessmentControlInsightsByControlDomainResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

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.

" }, "ListAssessmentFrameworkShareRequests":{ "name":"ListAssessmentFrameworkShareRequests", "http":{ "method":"GET", "requestUri":"/assessmentFrameworkShareRequests" }, "input":{"shape":"ListAssessmentFrameworkShareRequestsRequest"}, "output":{"shape":"ListAssessmentFrameworkShareRequestsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

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

" }, "ListAssessmentFrameworks":{ "name":"ListAssessmentFrameworks", "http":{ "method":"GET", "requestUri":"/assessmentFrameworks" }, "input":{"shape":"ListAssessmentFrameworksRequest"}, "output":{"shape":"ListAssessmentFrameworksResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

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

" }, "ListAssessmentReports":{ "name":"ListAssessmentReports", "http":{ "method":"GET", "requestUri":"/assessmentReports" }, "input":{"shape":"ListAssessmentReportsRequest"}, "output":{"shape":"ListAssessmentReportsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

Returns a list of assessment reports created in Audit Manager.

" }, "ListAssessments":{ "name":"ListAssessments", "http":{ "method":"GET", "requestUri":"/assessments" }, "input":{"shape":"ListAssessmentsRequest"}, "output":{"shape":"ListAssessmentsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

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

" }, "ListControlDomainInsights":{ "name":"ListControlDomainInsights", "http":{ "method":"GET", "requestUri":"/insights/control-domains" }, "input":{"shape":"ListControlDomainInsightsRequest"}, "output":{"shape":"ListControlDomainInsightsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

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

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.

" }, "ListControlDomainInsightsByAssessment":{ "name":"ListControlDomainInsightsByAssessment", "http":{ "method":"GET", "requestUri":"/insights/control-domains-by-assessment" }, "input":{"shape":"ListControlDomainInsightsByAssessmentRequest"}, "output":{"shape":"ListControlDomainInsightsByAssessmentResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

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

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.

" }, "ListControlInsightsByControlDomain":{ "name":"ListControlInsightsByControlDomain", "http":{ "method":"GET", "requestUri":"/insights/controls" }, "input":{"shape":"ListControlInsightsByControlDomainRequest"}, "output":{"shape":"ListControlInsightsByControlDomainResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

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.

" }, "ListControls":{ "name":"ListControls", "http":{ "method":"GET", "requestUri":"/controls" }, "input":{"shape":"ListControlsRequest"}, "output":{"shape":"ListControlsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

Returns a list of controls from Audit Manager.

" }, "ListKeywordsForDataSource":{ "name":"ListKeywordsForDataSource", "http":{ "method":"GET", "requestUri":"/dataSourceKeywords" }, "input":{"shape":"ListKeywordsForDataSourceRequest"}, "output":{"shape":"ListKeywordsForDataSourceResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

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

" }, "ListNotifications":{ "name":"ListNotifications", "http":{ "method":"GET", "requestUri":"/notifications" }, "input":{"shape":"ListNotificationsRequest"}, "output":{"shape":"ListNotificationsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

Returns a list of all Audit Manager notifications.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{resourceArn}" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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

" }, "RegisterAccount":{ "name":"RegisterAccount", "http":{ "method":"POST", "requestUri":"/account/registerAccount" }, "input":{"shape":"RegisterAccountRequest"}, "output":{"shape":"RegisterAccountResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"

Enables Audit Manager for the specified Amazon Web Services account.

" }, "RegisterOrganizationAdminAccount":{ "name":"RegisterOrganizationAdminAccount", "http":{ "method":"POST", "requestUri":"/account/registerOrganizationAdminAccount" }, "input":{"shape":"RegisterOrganizationAdminAccountRequest"}, "output":{"shape":"RegisterOrganizationAdminAccountResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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

" }, "StartAssessmentFrameworkShare":{ "name":"StartAssessmentFrameworkShare", "http":{ "method":"POST", "requestUri":"/assessmentFrameworks/{frameworkId}/shareRequests" }, "input":{"shape":"StartAssessmentFrameworkShareRequest"}, "output":{"shape":"StartAssessmentFrameworkShareResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{resourceArn}" }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Tags the specified resource in Audit Manager.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{resourceArn}" }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Removes a tag from a resource in Audit Manager.

" }, "UpdateAssessment":{ "name":"UpdateAssessment", "http":{ "method":"PUT", "requestUri":"/assessments/{assessmentId}" }, "input":{"shape":"UpdateAssessmentRequest"}, "output":{"shape":"UpdateAssessmentResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

Edits an Audit Manager assessment.

" }, "UpdateAssessmentControl":{ "name":"UpdateAssessmentControl", "http":{ "method":"PUT", "requestUri":"/assessments/{assessmentId}/controlSets/{controlSetId}/controls/{controlId}" }, "input":{"shape":"UpdateAssessmentControlRequest"}, "output":{"shape":"UpdateAssessmentControlResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

Updates a control within an assessment in Audit Manager.

" }, "UpdateAssessmentControlSetStatus":{ "name":"UpdateAssessmentControlSetStatus", "http":{ "method":"PUT", "requestUri":"/assessments/{assessmentId}/controlSets/{controlSetId}/status" }, "input":{"shape":"UpdateAssessmentControlSetStatusRequest"}, "output":{"shape":"UpdateAssessmentControlSetStatusResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

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

" }, "UpdateAssessmentFramework":{ "name":"UpdateAssessmentFramework", "http":{ "method":"PUT", "requestUri":"/assessmentFrameworks/{frameworkId}" }, "input":{"shape":"UpdateAssessmentFrameworkRequest"}, "output":{"shape":"UpdateAssessmentFrameworkResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

Updates a custom framework in Audit Manager.

" }, "UpdateAssessmentFrameworkShare":{ "name":"UpdateAssessmentFrameworkShare", "http":{ "method":"PUT", "requestUri":"/assessmentFrameworkShareRequests/{requestId}" }, "input":{"shape":"UpdateAssessmentFrameworkShareRequest"}, "output":{"shape":"UpdateAssessmentFrameworkShareResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

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

" }, "UpdateAssessmentStatus":{ "name":"UpdateAssessmentStatus", "http":{ "method":"PUT", "requestUri":"/assessments/{assessmentId}/status" }, "input":{"shape":"UpdateAssessmentStatusRequest"}, "output":{"shape":"UpdateAssessmentStatusResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Updates the status of an assessment in Audit Manager.

" }, "UpdateControl":{ "name":"UpdateControl", "http":{ "method":"PUT", "requestUri":"/controls/{controlId}" }, "input":{"shape":"UpdateControlRequest"}, "output":{"shape":"UpdateControlResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

Updates a custom control in Audit Manager.

" }, "UpdateSettings":{ "name":"UpdateSettings", "http":{ "method":"PUT", "requestUri":"/settings" }, "input":{"shape":"UpdateSettingsRequest"}, "output":{"shape":"UpdateSettingsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"

Updates Audit Manager settings for the current account.

" }, "ValidateAssessmentReportIntegrity":{ "name":"ValidateAssessmentReportIntegrity", "http":{ "method":"POST", "requestUri":"/assessmentReports/integrity" }, "input":{"shape":"ValidateAssessmentReportIntegrityRequest"}, "output":{"shape":"ValidateAssessmentReportIntegrityResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Validates the integrity of an assessment report in Audit Manager.

" } }, "shapes":{ "AWSAccount":{ "type":"structure", "members":{ "id":{ "shape":"AccountId", "documentation":"

The identifier for the Amazon Web Services account.

" }, "emailAddress":{ "shape":"EmailAddress", "documentation":"

The email address that's associated with the Amazon Web Services account.

" }, "name":{ "shape":"AccountName", "documentation":"

The name of the Amazon Web Services account.

" } }, "documentation":"

The wrapper of Amazon Web Services account details, such as account ID or email address.

" }, "AWSAccounts":{ "type":"list", "member":{"shape":"AWSAccount"}, "max":200, "min":1, "sensitive":true }, "AWSService":{ "type":"structure", "members":{ "serviceName":{ "shape":"AWSServiceName", "documentation":"

The name of the Amazon Web Service.

" } }, "documentation":"

An Amazon Web Service such as Amazon S3 or CloudTrail.

For an example of how to find an Amazon Web Service name and how to define it in your assessment scope, see the following:

- Finding an Amazon Web Service name to use in your assessment scope

- Defining an Amazon Web Service name in your assessment scope

" }, "AWSServiceName":{ "type":"string", "max":40, "min":1, "pattern":"^[a-zA-Z0-9-\\s().]+$" }, "AWSServices":{ "type":"list", "member":{"shape":"AWSService"} }, "AccessDeniedException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again.

", "error":{"httpStatusCode":403}, "exception":true }, "AccountId":{ "type":"string", "max":12, "min":12, "pattern":"^[0-9]{12}$" }, "AccountName":{ "type":"string", "max":50, "min":1, "pattern":"^[\\u0020-\\u007E]+$" }, "AccountStatus":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE", "PENDING_ACTIVATION" ] }, "ActionEnum":{ "type":"string", "enum":[ "CREATE", "UPDATE_METADATA", "ACTIVE", "INACTIVE", "DELETE", "UNDER_REVIEW", "REVIEWED", "IMPORT_EVIDENCE" ] }, "ActionPlanInstructions":{ "type":"string", "max":1000, "pattern":"^[\\w\\W\\s\\S]*$", "sensitive":true }, "ActionPlanTitle":{ "type":"string", "max":300, "pattern":"^[\\w\\W\\s\\S]*$", "sensitive":true }, "Assessment":{ "type":"structure", "members":{ "arn":{ "shape":"AuditManagerArn", "documentation":"

The Amazon Resource Name (ARN) of the assessment.

" }, "awsAccount":{ "shape":"AWSAccount", "documentation":"

The Amazon Web Services account that's associated with the assessment.

" }, "metadata":{ "shape":"AssessmentMetadata", "documentation":"

The metadata for the assessment.

" }, "framework":{ "shape":"AssessmentFramework", "documentation":"

The framework that the assessment was created from.

" }, "tags":{ "shape":"TagMap", "documentation":"

The tags that are associated with the assessment.

" } }, "documentation":"

An entity that defines the scope of audit evidence collected by Audit Manager. An Audit Manager assessment is an implementation of an Audit Manager framework.

" }, "AssessmentControl":{ "type":"structure", "members":{ "id":{ "shape":"UUID", "documentation":"

The identifier for the control.

" }, "name":{ "shape":"ControlName", "documentation":"

The name of the control.

" }, "description":{ "shape":"ControlDescription", "documentation":"

The description of the control.

" }, "status":{ "shape":"ControlStatus", "documentation":"

The status of the control.

" }, "response":{ "shape":"ControlResponse", "documentation":"

The response of the control.

" }, "comments":{ "shape":"ControlComments", "documentation":"

The list of comments that's attached to the control.

" }, "evidenceSources":{ "shape":"EvidenceSources", "documentation":"

The list of data sources for the evidence.

" }, "evidenceCount":{ "shape":"Integer", "documentation":"

The amount of evidence that's collected for the control.

" }, "assessmentReportEvidenceCount":{ "shape":"Integer", "documentation":"

The amount of evidence in the assessment report.

" } }, "documentation":"

The control entity that represents a standard control or a custom control in an Audit Manager assessment.

" }, "AssessmentControlSet":{ "type":"structure", "members":{ "id":{ "shape":"ControlSetId", "documentation":"

The identifier of the control set in the assessment. This is the control set name in a plain string format.

" }, "description":{ "shape":"NonEmptyString", "documentation":"

The description for the control set.

" }, "status":{ "shape":"ControlSetStatus", "documentation":"

The current status of the control set.

" }, "roles":{ "shape":"Roles", "documentation":"

The roles that are associated with the control set.

" }, "controls":{ "shape":"AssessmentControls", "documentation":"

The list of controls that's contained with the control set.

" }, "delegations":{ "shape":"Delegations", "documentation":"

The delegations that are associated with the control set.

" }, "systemEvidenceCount":{ "shape":"Integer", "documentation":"

The total number of evidence objects that are retrieved automatically for the control set.

" }, "manualEvidenceCount":{ "shape":"Integer", "documentation":"

The total number of evidence objects that are uploaded manually to the control set.

" } }, "documentation":"

Represents a set of controls in an Audit Manager assessment.

" }, "AssessmentControlSets":{ "type":"list", "member":{"shape":"AssessmentControlSet"} }, "AssessmentControls":{ "type":"list", "member":{"shape":"AssessmentControl"} }, "AssessmentDescription":{ "type":"string", "max":1000, "pattern":"^[\\w\\W\\s\\S]*$", "sensitive":true }, "AssessmentEvidenceFolder":{ "type":"structure", "members":{ "name":{ "shape":"AssessmentEvidenceFolderName", "documentation":"

The name of the evidence folder.

" }, "date":{ "shape":"Timestamp", "documentation":"

The date when the first evidence was added to the evidence folder.

" }, "assessmentId":{ "shape":"UUID", "documentation":"

The identifier for the assessment.

" }, "controlSetId":{ "shape":"ControlSetId", "documentation":"

The identifier for the control set.

" }, "controlId":{ "shape":"UUID", "documentation":"

The unique identifier for the control.

" }, "id":{ "shape":"UUID", "documentation":"

The identifier for the folder that the evidence is stored in.

" }, "dataSource":{ "shape":"String", "documentation":"

The Amazon Web Service that the evidence was collected from.

" }, "author":{ "shape":"String", "documentation":"

The name of the user who created the evidence folder.

" }, "totalEvidence":{ "shape":"Integer", "documentation":"

The total amount of evidence in the evidence folder.

" }, "assessmentReportSelectionCount":{ "shape":"Integer", "documentation":"

The total count of evidence that's included in the assessment report.

" }, "controlName":{ "shape":"ControlName", "documentation":"

The name of the control.

" }, "evidenceResourcesIncludedCount":{ "shape":"Integer", "documentation":"

The amount of evidence that's included in the evidence folder.

" }, "evidenceByTypeConfigurationDataCount":{ "shape":"Integer", "documentation":"

The number of evidence that falls under the configuration data category. This evidence is collected from configuration snapshots of other Amazon Web Services such as Amazon EC2, Amazon S3, or IAM.

" }, "evidenceByTypeManualCount":{ "shape":"Integer", "documentation":"

The number of evidence that falls under the manual category. This evidence is imported manually.

" }, "evidenceByTypeComplianceCheckCount":{ "shape":"Integer", "documentation":"

The number of evidence that falls under the compliance check category. This evidence is collected from Config or Security Hub.

" }, "evidenceByTypeComplianceCheckIssuesCount":{ "shape":"Integer", "documentation":"

The total number of issues that were reported directly from Security Hub, Config, or both.

" }, "evidenceByTypeUserActivityCount":{ "shape":"Integer", "documentation":"

The number of evidence that falls under the user activity category. This evidence is collected from CloudTrail logs.

" }, "evidenceAwsServiceSourceCount":{ "shape":"Integer", "documentation":"

The total number of Amazon Web Services resources that were assessed to generate the evidence.

" } }, "documentation":"

The folder where Audit Manager stores evidence for an assessment.

" }, "AssessmentEvidenceFolderName":{ "type":"string", "max":300, "min":1, "pattern":"^[\\w\\W\\s\\S]*$" }, "AssessmentEvidenceFolders":{ "type":"list", "member":{"shape":"AssessmentEvidenceFolder"} }, "AssessmentFramework":{ "type":"structure", "members":{ "id":{ "shape":"UUID", "documentation":"

The unique identifier for the framework.

" }, "arn":{ "shape":"AuditManagerArn", "documentation":"

The Amazon Resource Name (ARN) of the framework.

" }, "metadata":{"shape":"FrameworkMetadata"}, "controlSets":{ "shape":"AssessmentControlSets", "documentation":"

The control sets that are associated with the framework.

" } }, "documentation":"

The file used to structure and automate Audit Manager assessments for a given compliance standard.

", "sensitive":true }, "AssessmentFrameworkDescription":{ "type":"string", "max":200, "min":1, "pattern":"^[\\w\\W\\s\\S]*$" }, "AssessmentFrameworkMetadata":{ "type":"structure", "members":{ "arn":{ "shape":"AuditManagerArn", "documentation":"

The Amazon Resource Name (ARN) of the framework.

" }, "id":{ "shape":"UUID", "documentation":"

The unique identifier for the framework.

" }, "type":{ "shape":"FrameworkType", "documentation":"

The framework type, such as a standard framework or a custom framework.

" }, "name":{ "shape":"FrameworkName", "documentation":"

The name of the framework.

" }, "description":{ "shape":"FrameworkDescription", "documentation":"

The description of the framework.

" }, "logo":{ "shape":"Filename", "documentation":"

The logo that's associated with the framework.

" }, "complianceType":{ "shape":"ComplianceType", "documentation":"

The compliance type that the new custom framework supports, such as CIS or HIPAA.

" }, "controlsCount":{ "shape":"ControlsCount", "documentation":"

The number of controls that are associated with the framework.

" }, "controlSetsCount":{ "shape":"ControlSetsCount", "documentation":"

The number of control sets that are associated with the framework.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The time when the framework was created.

" }, "lastUpdatedAt":{ "shape":"Timestamp", "documentation":"

The time when the framework was most recently updated.

" } }, "documentation":"

The metadata that's associated with a standard framework or a custom framework.

" }, "AssessmentFrameworkShareRequest":{ "type":"structure", "members":{ "id":{ "shape":"UUID", "documentation":"

The unique identifier for the share request.

" }, "frameworkId":{ "shape":"UUID", "documentation":"

The unique identifier for the shared custom framework.

" }, "frameworkName":{ "shape":"FrameworkName", "documentation":"

The name of the custom framework that the share request is for.

" }, "frameworkDescription":{ "shape":"FrameworkDescription", "documentation":"

The description of the shared custom framework.

" }, "status":{ "shape":"ShareRequestStatus", "documentation":"

The status of the share request.

" }, "sourceAccount":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account of the sender.

" }, "destinationAccount":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account of the recipient.

" }, "destinationRegion":{ "shape":"Region", "documentation":"

The Amazon Web Services Region of the recipient.

" }, "expirationTime":{ "shape":"Timestamp", "documentation":"

The time when the share request expires.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

The time when the share request was created.

" }, "lastUpdated":{ "shape":"Timestamp", "documentation":"

Specifies when the share request was last updated.

" }, "comment":{ "shape":"ShareRequestComment", "documentation":"

An optional comment from the sender about the share request.

" }, "standardControlsCount":{ "shape":"NullableInteger", "documentation":"

The number of standard controls that are part of the shared custom framework.

" }, "customControlsCount":{ "shape":"NullableInteger", "documentation":"

The number of custom controls that are part of the shared custom framework.

" }, "complianceType":{ "shape":"ComplianceType", "documentation":"

The compliance type that the shared custom framework supports, such as CIS or HIPAA.

" } }, "documentation":"

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

" }, "AssessmentFrameworkShareRequestList":{ "type":"list", "member":{"shape":"AssessmentFrameworkShareRequest"} }, "AssessmentMetadata":{ "type":"structure", "members":{ "name":{ "shape":"AssessmentName", "documentation":"

The name of the assessment.

" }, "id":{ "shape":"UUID", "documentation":"

The unique identifier for the assessment.

" }, "description":{ "shape":"AssessmentDescription", "documentation":"

The description of the assessment.

" }, "complianceType":{ "shape":"ComplianceType", "documentation":"

The name of the compliance standard that's related to the assessment, such as PCI-DSS.

" }, "status":{ "shape":"AssessmentStatus", "documentation":"

The overall status of the assessment.

" }, "assessmentReportsDestination":{ "shape":"AssessmentReportsDestination", "documentation":"

The destination that evidence reports are stored in for the assessment.

" }, "scope":{ "shape":"Scope", "documentation":"

The wrapper of Amazon Web Services accounts and services that are in scope for the assessment.

" }, "roles":{ "shape":"Roles", "documentation":"

The roles that are associated with the assessment.

" }, "delegations":{ "shape":"Delegations", "documentation":"

The delegations that are associated with the assessment.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

Specifies when the assessment was created.

" }, "lastUpdated":{ "shape":"Timestamp", "documentation":"

The time of the most recent update.

" } }, "documentation":"

The metadata that's associated with the specified assessment.

" }, "AssessmentMetadataItem":{ "type":"structure", "members":{ "name":{ "shape":"AssessmentName", "documentation":"

The name of the assessment.

" }, "id":{ "shape":"UUID", "documentation":"

The unique identifier for the assessment.

" }, "complianceType":{ "shape":"ComplianceType", "documentation":"

The name of the compliance standard that's related to the assessment, such as PCI-DSS.

" }, "status":{ "shape":"AssessmentStatus", "documentation":"

The current status of the assessment.

" }, "roles":{ "shape":"Roles", "documentation":"

The roles that are associated with the assessment.

" }, "delegations":{ "shape":"Delegations", "documentation":"

The delegations that are associated with the assessment.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

Specifies when the assessment was created.

" }, "lastUpdated":{ "shape":"Timestamp", "documentation":"

The time of the most recent update.

" } }, "documentation":"

A metadata object that's associated with an assessment in Audit Manager.

" }, "AssessmentName":{ "type":"string", "max":300, "min":1, "pattern":"^[^\\\\]*$", "sensitive":true }, "AssessmentReport":{ "type":"structure", "members":{ "id":{ "shape":"UUID", "documentation":"

The unique identifier for the assessment report.

" }, "name":{ "shape":"AssessmentReportName", "documentation":"

The name that's given to the assessment report.

" }, "description":{ "shape":"AssessmentReportDescription", "documentation":"

The description of the specified assessment report.

" }, "awsAccountId":{ "shape":"AccountId", "documentation":"

The identifier for the specified Amazon Web Services account.

" }, "assessmentId":{ "shape":"UUID", "documentation":"

The identifier for the specified assessment.

" }, "assessmentName":{ "shape":"AssessmentName", "documentation":"

The name of the associated assessment.

" }, "author":{ "shape":"Username", "documentation":"

The name of the user who created the assessment report.

" }, "status":{ "shape":"AssessmentReportStatus", "documentation":"

The current status of the specified assessment report.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

Specifies when the assessment report was created.

" } }, "documentation":"

A finalized document that's generated from an Audit Manager assessment. These reports summarize the relevant evidence that was collected for your audit, and link to the relevant evidence folders. These evidence folders are named and organized according to the controls that are specified in your assessment.

" }, "AssessmentReportDescription":{ "type":"string", "max":1000, "pattern":"^[\\w\\W\\s\\S]*$", "sensitive":true }, "AssessmentReportDestinationType":{ "type":"string", "enum":["S3"] }, "AssessmentReportEvidenceError":{ "type":"structure", "members":{ "evidenceId":{ "shape":"UUID", "documentation":"

The identifier for the evidence.

" }, "errorCode":{ "shape":"ErrorCode", "documentation":"

The error code that was returned.

" }, "errorMessage":{ "shape":"ErrorMessage", "documentation":"

The error message that was returned.

" } }, "documentation":"

An error entity for assessment report evidence errors. This is used to provide more meaningful errors than a simple string message.

" }, "AssessmentReportEvidenceErrors":{ "type":"list", "member":{"shape":"AssessmentReportEvidenceError"} }, "AssessmentReportMetadata":{ "type":"structure", "members":{ "id":{ "shape":"UUID", "documentation":"

The unique identifier for the assessment report.

" }, "name":{ "shape":"AssessmentReportName", "documentation":"

The name of the assessment report.

" }, "description":{ "shape":"AssessmentReportDescription", "documentation":"

The description of the assessment report.

" }, "assessmentId":{ "shape":"UUID", "documentation":"

The unique identifier for the associated assessment.

" }, "assessmentName":{ "shape":"AssessmentName", "documentation":"

The name of the associated assessment.

" }, "author":{ "shape":"Username", "documentation":"

The name of the user who created the assessment report.

" }, "status":{ "shape":"AssessmentReportStatus", "documentation":"

The current status of the assessment report.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

Specifies when the assessment report was created.

" } }, "documentation":"

The metadata objects that are associated with the specified assessment report.

" }, "AssessmentReportName":{ "type":"string", "max":300, "min":1, "pattern":"^[a-zA-Z0-9-_\\.]+$" }, "AssessmentReportStatus":{ "type":"string", "enum":[ "COMPLETE", "IN_PROGRESS", "FAILED" ] }, "AssessmentReportsDestination":{ "type":"structure", "members":{ "destinationType":{ "shape":"AssessmentReportDestinationType", "documentation":"

The destination type, such as Amazon S3.

" }, "destination":{ "shape":"S3Url", "documentation":"

The destination bucket where Audit Manager stores assessment reports.

" } }, "documentation":"

The location where Audit Manager saves assessment reports for the given assessment.

", "sensitive":true }, "AssessmentReportsMetadata":{ "type":"list", "member":{"shape":"AssessmentReportMetadata"} }, "AssessmentStatus":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE" ] }, "AssociateAssessmentReportEvidenceFolderRequest":{ "type":"structure", "required":[ "assessmentId", "evidenceFolderId" ], "members":{ "assessmentId":{ "shape":"UUID", "documentation":"

The identifier for the assessment.

", "location":"uri", "locationName":"assessmentId" }, "evidenceFolderId":{ "shape":"UUID", "documentation":"

The identifier for the folder that the evidence is stored in.

" } } }, "AssociateAssessmentReportEvidenceFolderResponse":{ "type":"structure", "members":{ } }, "AuditManagerArn":{ "type":"string", "max":2048, "min":20, "pattern":"^arn:.*:auditmanager:.*" }, "BatchAssociateAssessmentReportEvidenceRequest":{ "type":"structure", "required":[ "assessmentId", "evidenceFolderId", "evidenceIds" ], "members":{ "assessmentId":{ "shape":"UUID", "documentation":"

The identifier for the assessment.

", "location":"uri", "locationName":"assessmentId" }, "evidenceFolderId":{ "shape":"UUID", "documentation":"

The identifier for the folder that the evidence is stored in.

" }, "evidenceIds":{ "shape":"EvidenceIds", "documentation":"

The list of evidence identifiers.

" } } }, "BatchAssociateAssessmentReportEvidenceResponse":{ "type":"structure", "members":{ "evidenceIds":{ "shape":"EvidenceIds", "documentation":"

The list of evidence identifiers.

" }, "errors":{ "shape":"AssessmentReportEvidenceErrors", "documentation":"

A list of errors that the `BatchAssociateAssessmentReportEvidence` API returned.

" } } }, "BatchCreateDelegationByAssessmentError":{ "type":"structure", "members":{ "createDelegationRequest":{ "shape":"CreateDelegationRequest", "documentation":"

The API request to batch create delegations in Audit Manager.

" }, "errorCode":{ "shape":"ErrorCode", "documentation":"

The error code that the `BatchCreateDelegationByAssessment` API returned.

" }, "errorMessage":{ "shape":"ErrorMessage", "documentation":"

The error message that the `BatchCreateDelegationByAssessment` API returned.

" } }, "documentation":"

An error entity for the `BatchCreateDelegationByAssessment` API. This is used to provide more meaningful errors than a simple string message.

" }, "BatchCreateDelegationByAssessmentErrors":{ "type":"list", "member":{"shape":"BatchCreateDelegationByAssessmentError"}, "sensitive":true }, "BatchCreateDelegationByAssessmentRequest":{ "type":"structure", "required":[ "createDelegationRequests", "assessmentId" ], "members":{ "createDelegationRequests":{ "shape":"CreateDelegationRequests", "documentation":"

The API request to batch create delegations in Audit Manager.

" }, "assessmentId":{ "shape":"UUID", "documentation":"

The identifier for the assessment.

", "location":"uri", "locationName":"assessmentId" } } }, "BatchCreateDelegationByAssessmentResponse":{ "type":"structure", "members":{ "delegations":{ "shape":"Delegations", "documentation":"

The delegations that are associated with the assessment.

" }, "errors":{ "shape":"BatchCreateDelegationByAssessmentErrors", "documentation":"

A list of errors that the `BatchCreateDelegationByAssessment` API returned.

" } } }, "BatchDeleteDelegationByAssessmentError":{ "type":"structure", "members":{ "delegationId":{ "shape":"UUID", "documentation":"

The identifier for the delegation.

" }, "errorCode":{ "shape":"ErrorCode", "documentation":"

The error code that the `BatchDeleteDelegationByAssessment` API returned.

" }, "errorMessage":{ "shape":"ErrorMessage", "documentation":"

The error message that the `BatchDeleteDelegationByAssessment` API returned.

" } }, "documentation":"

An error entity for the `BatchDeleteDelegationByAssessment` API. This is used to provide more meaningful errors than a simple string message.

" }, "BatchDeleteDelegationByAssessmentErrors":{ "type":"list", "member":{"shape":"BatchDeleteDelegationByAssessmentError"}, "sensitive":true }, "BatchDeleteDelegationByAssessmentRequest":{ "type":"structure", "required":[ "delegationIds", "assessmentId" ], "members":{ "delegationIds":{ "shape":"DelegationIds", "documentation":"

The identifiers for the delegations.

" }, "assessmentId":{ "shape":"UUID", "documentation":"

The identifier for the assessment.

", "location":"uri", "locationName":"assessmentId" } } }, "BatchDeleteDelegationByAssessmentResponse":{ "type":"structure", "members":{ "errors":{ "shape":"BatchDeleteDelegationByAssessmentErrors", "documentation":"

A list of errors that the `BatchDeleteDelegationByAssessment` API returned.

" } } }, "BatchDisassociateAssessmentReportEvidenceRequest":{ "type":"structure", "required":[ "assessmentId", "evidenceFolderId", "evidenceIds" ], "members":{ "assessmentId":{ "shape":"UUID", "documentation":"

The identifier for the assessment.

", "location":"uri", "locationName":"assessmentId" }, "evidenceFolderId":{ "shape":"UUID", "documentation":"

The identifier for the folder that the evidence is stored in.

" }, "evidenceIds":{ "shape":"EvidenceIds", "documentation":"

The list of evidence identifiers.

" } } }, "BatchDisassociateAssessmentReportEvidenceResponse":{ "type":"structure", "members":{ "evidenceIds":{ "shape":"EvidenceIds", "documentation":"

The identifier for the evidence.

" }, "errors":{ "shape":"AssessmentReportEvidenceErrors", "documentation":"

A list of errors that the `BatchDisassociateAssessmentReportEvidence` API returned.

" } } }, "BatchImportEvidenceToAssessmentControlError":{ "type":"structure", "members":{ "manualEvidence":{ "shape":"ManualEvidence", "documentation":"

Manual evidence that can't be collected automatically by Audit Manager.

" }, "errorCode":{ "shape":"ErrorCode", "documentation":"

The error code that the `BatchImportEvidenceToAssessmentControl` API returned.

" }, "errorMessage":{ "shape":"ErrorMessage", "documentation":"

The error message that the `BatchImportEvidenceToAssessmentControl` API returned.

" } }, "documentation":"

An error entity for the `BatchImportEvidenceToAssessmentControl` API. This is used to provide more meaningful errors than a simple string message.

" }, "BatchImportEvidenceToAssessmentControlErrors":{ "type":"list", "member":{"shape":"BatchImportEvidenceToAssessmentControlError"} }, "BatchImportEvidenceToAssessmentControlRequest":{ "type":"structure", "required":[ "assessmentId", "controlSetId", "controlId", "manualEvidence" ], "members":{ "assessmentId":{ "shape":"UUID", "documentation":"

The identifier for the assessment.

", "location":"uri", "locationName":"assessmentId" }, "controlSetId":{ "shape":"ControlSetId", "documentation":"

The identifier for the control set.

", "location":"uri", "locationName":"controlSetId" }, "controlId":{ "shape":"UUID", "documentation":"

The identifier for the control.

", "location":"uri", "locationName":"controlId" }, "manualEvidence":{ "shape":"ManualEvidenceList", "documentation":"

The list of manual evidence objects.

" } } }, "BatchImportEvidenceToAssessmentControlResponse":{ "type":"structure", "members":{ "errors":{ "shape":"BatchImportEvidenceToAssessmentControlErrors", "documentation":"

A list of errors that the `BatchImportEvidenceToAssessmentControl` API returned.

" } } }, "Boolean":{"type":"boolean"}, "ChangeLog":{ "type":"structure", "members":{ "objectType":{ "shape":"ObjectTypeEnum", "documentation":"

The object that was changed, such as an assessment, control, or control set.

" }, "objectName":{ "shape":"NonEmptyString", "documentation":"

The name of the object that changed. This could be the name of an assessment, control, or control set.

" }, "action":{ "shape":"ActionEnum", "documentation":"

The action that was performed.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The time when the action was performed and the changelog record was created.

" }, "createdBy":{ "shape":"IamArn", "documentation":"

The user or role that performed the action.

" } }, "documentation":"

The record of a change within Audit Manager. For example, this could be the status change of an assessment or the delegation of a control set.

" }, "ChangeLogs":{ "type":"list", "member":{"shape":"ChangeLog"} }, "CloudTrailArn":{ "type":"string", "max":2048, "min":20, "pattern":"^arn:.*:cloudtrail:.*" }, "ComplianceType":{ "type":"string", "max":100, "pattern":"^[\\w\\W\\s\\S]*$", "sensitive":true }, "Control":{ "type":"structure", "members":{ "arn":{ "shape":"AuditManagerArn", "documentation":"

The Amazon Resource Name (ARN) of the control.

" }, "id":{ "shape":"UUID", "documentation":"

The unique identifier for the control.

" }, "type":{ "shape":"ControlType", "documentation":"

Specifies whether the control is a standard control or a custom control.

" }, "name":{ "shape":"ControlName", "documentation":"

The name of the control.

" }, "description":{ "shape":"ControlDescription", "documentation":"

The description of the control.

" }, "testingInformation":{ "shape":"TestingInformation", "documentation":"

The steps that you should follow to determine if the control has been satisfied.

" }, "actionPlanTitle":{ "shape":"ActionPlanTitle", "documentation":"

The title of the action plan for remediating the control.

" }, "actionPlanInstructions":{ "shape":"ActionPlanInstructions", "documentation":"

The recommended actions to carry out if the control isn't fulfilled.

" }, "controlSources":{ "shape":"ControlSources", "documentation":"

The data source types that determine where Audit Manager collects evidence from for the control.

" }, "controlMappingSources":{ "shape":"ControlMappingSources", "documentation":"

The data mapping sources for the control.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The time when the control was created.

" }, "lastUpdatedAt":{ "shape":"Timestamp", "documentation":"

The time when the control was most recently updated.

" }, "createdBy":{ "shape":"CreatedBy", "documentation":"

The user or role that created the control.

" }, "lastUpdatedBy":{ "shape":"LastUpdatedBy", "documentation":"

The user or role that most recently updated the control.

" }, "tags":{ "shape":"TagMap", "documentation":"

The tags associated with the control.

" } }, "documentation":"

A control in Audit Manager.

" }, "ControlComment":{ "type":"structure", "members":{ "authorName":{ "shape":"Username", "documentation":"

The name of the user who authored the comment.

" }, "commentBody":{ "shape":"ControlCommentBody", "documentation":"

The body text of a control comment.

" }, "postedDate":{ "shape":"Timestamp", "documentation":"

The time when the comment was posted.

" } }, "documentation":"

A comment that's posted by a user on a control. This includes the author's name, the comment text, and a timestamp.

" }, "ControlCommentBody":{ "type":"string", "max":500, "pattern":"^[\\w\\W\\s\\S]*$", "sensitive":true }, "ControlComments":{ "type":"list", "member":{"shape":"ControlComment"} }, "ControlDescription":{ "type":"string", "max":1000, "pattern":"^[\\w\\W\\s\\S]*$" }, "ControlDomainInsights":{ "type":"structure", "members":{ "name":{ "shape":"NonEmptyString", "documentation":"

The name of the control domain.

" }, "id":{ "shape":"UUID", "documentation":"

The unique identifier for the control domain.

" }, "controlsCountByNoncompliantEvidence":{ "shape":"NullableInteger", "documentation":"

The number of controls in the control domain that collected non-compliant evidence on the `lastUpdated` date.

" }, "totalControlsCount":{ "shape":"NullableInteger", "documentation":"

The total number of controls in the control domain.

" }, "evidenceInsights":{ "shape":"EvidenceInsights", "documentation":"

A breakdown of the compliance check status for the evidence that’s associated with the control domain.

" }, "lastUpdated":{ "shape":"Timestamp", "documentation":"

The time when the control domain insights were last updated.

" } }, "documentation":"

A summary of the latest analytics data for a specific control domain.

Control domain insights are grouped by control domain, and ranked by the highest total count of non-compliant evidence.

" }, "ControlDomainInsightsList":{ "type":"list", "member":{"shape":"ControlDomainInsights"} }, "ControlInsightsMetadata":{ "type":"list", "member":{"shape":"ControlInsightsMetadataItem"} }, "ControlInsightsMetadataByAssessment":{ "type":"list", "member":{"shape":"ControlInsightsMetadataByAssessmentItem"} }, "ControlInsightsMetadataByAssessmentItem":{ "type":"structure", "members":{ "name":{ "shape":"NonEmptyString", "documentation":"

The name of the assessment control.

" }, "id":{ "shape":"UUID", "documentation":"

The unique identifier for the assessment control.

" }, "evidenceInsights":{ "shape":"EvidenceInsights", "documentation":"

A breakdown of the compliance check status for the evidence that’s associated with the assessment control.

" }, "controlSetName":{ "shape":"NonEmptyString", "documentation":"

The name of the control set that the assessment control belongs to.

" }, "lastUpdated":{ "shape":"Timestamp", "documentation":"

The time when the assessment control insights were last updated.

" } }, "documentation":"

A summary of the latest analytics data for a specific control in a specific active assessment.

Control insights are grouped by control domain, and ranked by the highest total count of non-compliant evidence.

" }, "ControlInsightsMetadataItem":{ "type":"structure", "members":{ "name":{ "shape":"NonEmptyString", "documentation":"

The name of the control.

" }, "id":{ "shape":"UUID", "documentation":"

The unique identifier for the control.

" }, "evidenceInsights":{ "shape":"EvidenceInsights", "documentation":"

A breakdown of the compliance check status for the evidence that’s associated with the control.

" }, "lastUpdated":{ "shape":"Timestamp", "documentation":"

The time when the control insights were last updated.

" } }, "documentation":"

A summary of the latest analytics data for a specific control.

This data reflects the total counts for the specified control across all active assessments. Control insights are grouped by control domain, and ranked by the highest total count of non-compliant evidence.

" }, "ControlMappingSource":{ "type":"structure", "members":{ "sourceId":{ "shape":"UUID", "documentation":"

The unique identifier for the source.

" }, "sourceName":{ "shape":"SourceName", "documentation":"

The name of the source.

" }, "sourceDescription":{ "shape":"SourceDescription", "documentation":"

The description of the source.

" }, "sourceSetUpOption":{ "shape":"SourceSetUpOption", "documentation":"

The setup option for the data source. This option reflects if the evidence collection is automated or manual.

" }, "sourceType":{ "shape":"SourceType", "documentation":"

Specifies one of the five data source types for evidence collection.

" }, "sourceKeyword":{"shape":"SourceKeyword"}, "sourceFrequency":{ "shape":"SourceFrequency", "documentation":"

Specifies how often evidence is collected from the control mapping source.

" }, "troubleshootingText":{ "shape":"TroubleshootingText", "documentation":"

The instructions for troubleshooting the control.

" } }, "documentation":"

The data source that determines where Audit Manager collects evidence from for the control.

" }, "ControlMappingSources":{ "type":"list", "member":{"shape":"ControlMappingSource"}, "min":1 }, "ControlMetadata":{ "type":"structure", "members":{ "arn":{ "shape":"AuditManagerArn", "documentation":"

The Amazon Resource Name (ARN) of the control.

" }, "id":{ "shape":"UUID", "documentation":"

The unique identifier for the control.

" }, "name":{ "shape":"ControlName", "documentation":"

The name of the control.

" }, "controlSources":{ "shape":"ControlSources", "documentation":"

The data source that determines where Audit Manager collects evidence from for the control.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The time when the control was created.

" }, "lastUpdatedAt":{ "shape":"Timestamp", "documentation":"

The time when the control was most recently updated.

" } }, "documentation":"

The metadata that's associated with the standard control or custom control.

" }, "ControlMetadataList":{ "type":"list", "member":{"shape":"ControlMetadata"} }, "ControlName":{ "type":"string", "max":300, "min":1, "pattern":"^[^\\\\]*$" }, "ControlResponse":{ "type":"string", "enum":[ "MANUAL", "AUTOMATE", "DEFER", "IGNORE" ] }, "ControlSet":{ "type":"structure", "members":{ "id":{ "shape":"UUID", "documentation":"

The identifier of the control set in the assessment. This is the control set name in a plain string format.

" }, "name":{ "shape":"ControlSetName", "documentation":"

The name of the control set.

" }, "controls":{ "shape":"Controls", "documentation":"

The list of controls within the control set.

" } }, "documentation":"

A set of controls in Audit Manager.

" }, "ControlSetId":{ "type":"string", "max":300, "min":1, "pattern":"^[\\w\\W\\s\\S]*$" }, "ControlSetName":{ "type":"string", "max":300, "min":1, "pattern":"^[^\\\\\\_]*$" }, "ControlSetStatus":{ "type":"string", "enum":[ "ACTIVE", "UNDER_REVIEW", "REVIEWED" ] }, "ControlSets":{ "type":"list", "member":{"shape":"ControlSet"}, "min":1, "sensitive":true }, "ControlSetsCount":{"type":"integer"}, "ControlSources":{ "type":"string", "max":100, "min":1, "pattern":"^[a-zA-Z_0-9-\\s.,]+$" }, "ControlStatus":{ "type":"string", "enum":[ "UNDER_REVIEW", "REVIEWED", "INACTIVE" ] }, "ControlType":{ "type":"string", "enum":[ "Standard", "Custom" ] }, "Controls":{ "type":"list", "member":{"shape":"Control"}, "min":1 }, "ControlsCount":{"type":"integer"}, "CreateAssessmentFrameworkControl":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"UUID", "documentation":"

The unique identifier of the control.

" } }, "documentation":"

The control entity attributes that uniquely identify an existing control to be added to a framework in Audit Manager.

" }, "CreateAssessmentFrameworkControlSet":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"ControlSetName", "documentation":"

The name of the control set.

" }, "controls":{ "shape":"CreateAssessmentFrameworkControls", "documentation":"

The list of controls within the control set. This doesn't contain the control set ID.

" } }, "documentation":"

A `controlSet` entity that represents a collection of controls in Audit Manager. This doesn't contain the control set ID.

" }, "CreateAssessmentFrameworkControlSets":{ "type":"list", "member":{"shape":"CreateAssessmentFrameworkControlSet"}, "min":1 }, "CreateAssessmentFrameworkControls":{ "type":"list", "member":{"shape":"CreateAssessmentFrameworkControl"}, "min":1 }, "CreateAssessmentFrameworkRequest":{ "type":"structure", "required":[ "name", "controlSets" ], "members":{ "name":{ "shape":"FrameworkName", "documentation":"

The name of the new custom framework.

" }, "description":{ "shape":"FrameworkDescription", "documentation":"

An optional description for the new custom framework.

" }, "complianceType":{ "shape":"ComplianceType", "documentation":"

The compliance type that the new custom framework supports, such as CIS or HIPAA.

" }, "controlSets":{ "shape":"CreateAssessmentFrameworkControlSets", "documentation":"

The control sets that are associated with the framework.

" }, "tags":{ "shape":"TagMap", "documentation":"

The tags that are associated with the framework.

" } } }, "CreateAssessmentFrameworkResponse":{ "type":"structure", "members":{ "framework":{ "shape":"Framework", "documentation":"

The name of the new framework that the `CreateAssessmentFramework` API returned.

" } } }, "CreateAssessmentReportRequest":{ "type":"structure", "required":[ "name", "assessmentId" ], "members":{ "name":{ "shape":"AssessmentReportName", "documentation":"

The name of the new assessment report.

" }, "description":{ "shape":"AssessmentReportDescription", "documentation":"

The description of the assessment report.

" }, "assessmentId":{ "shape":"UUID", "documentation":"

The identifier for the assessment.

", "location":"uri", "locationName":"assessmentId" }, "queryStatement":{ "shape":"QueryStatement", "documentation":"

A SQL statement that represents an evidence finder query.

Provide this parameter when you want to generate an assessment report from the results of an evidence finder search query. When you use this parameter, Audit Manager generates a one-time report using only the evidence from the query output. This report does not include any assessment evidence that was manually added to a report using the console, or associated with a report using the API.

To use this parameter, the enablementStatus of evidence finder must be `ENABLED`.

For examples and help resolving `queryStatement` validation exceptions, see Troubleshooting evidence finder issues in the Audit Manager User Guide.

" } } }, "CreateAssessmentReportResponse":{ "type":"structure", "members":{ "assessmentReport":{ "shape":"AssessmentReport", "documentation":"

The new assessment report that the `CreateAssessmentReport` API returned.

" } } }, "CreateAssessmentRequest":{ "type":"structure", "required":[ "name", "assessmentReportsDestination", "scope", "roles", "frameworkId" ], "members":{ "name":{ "shape":"AssessmentName", "documentation":"

The name of the assessment to be created.

" }, "description":{ "shape":"AssessmentDescription", "documentation":"

The optional description of the assessment to be created.

" }, "assessmentReportsDestination":{ "shape":"AssessmentReportsDestination", "documentation":"

The assessment report storage destination for the assessment that's being created.

" }, "scope":{"shape":"Scope"}, "roles":{ "shape":"Roles", "documentation":"

The list of roles for the assessment.

" }, "frameworkId":{ "shape":"UUID", "documentation":"

The identifier for the framework that the assessment will be created from.

" }, "tags":{ "shape":"TagMap", "documentation":"

The tags that are associated with the assessment.

" } } }, "CreateAssessmentResponse":{ "type":"structure", "members":{ "assessment":{"shape":"Assessment"} } }, "CreateControlMappingSource":{ "type":"structure", "members":{ "sourceName":{ "shape":"SourceName", "documentation":"

The name of the control mapping data source.

" }, "sourceDescription":{ "shape":"SourceDescription", "documentation":"

The description of the data source that determines where Audit Manager collects evidence from for the control.

" }, "sourceSetUpOption":{ "shape":"SourceSetUpOption", "documentation":"

The setup option for the data source, which reflects if the evidence collection is automated or manual.

" }, "sourceType":{ "shape":"SourceType", "documentation":"

Specifies one of the five types of data sources for evidence collection.

" }, "sourceKeyword":{"shape":"SourceKeyword"}, "sourceFrequency":{ "shape":"SourceFrequency", "documentation":"

Specifies how often evidence is collected from the control mapping source.

" }, "troubleshootingText":{ "shape":"TroubleshootingText", "documentation":"

The instructions for troubleshooting the control.

" } }, "documentation":"

The control mapping fields that represent the source for evidence collection, along with related parameters and metadata. This doesn't contain `mappingID`.

" }, "CreateControlMappingSources":{ "type":"list", "member":{"shape":"CreateControlMappingSource"}, "min":1 }, "CreateControlRequest":{ "type":"structure", "required":[ "name", "controlMappingSources" ], "members":{ "name":{ "shape":"ControlName", "documentation":"

The name of the control.

" }, "description":{ "shape":"ControlDescription", "documentation":"

The description of the control.

" }, "testingInformation":{ "shape":"TestingInformation", "documentation":"

The steps to follow to determine if the control is satisfied.

" }, "actionPlanTitle":{ "shape":"ActionPlanTitle", "documentation":"

The title of the action plan for remediating the control.

" }, "actionPlanInstructions":{ "shape":"ActionPlanInstructions", "documentation":"

The recommended actions to carry out if the control isn't fulfilled.

" }, "controlMappingSources":{ "shape":"CreateControlMappingSources", "documentation":"

The data mapping sources for the control.

" }, "tags":{ "shape":"TagMap", "documentation":"

The tags that are associated with the control.

" } } }, "CreateControlResponse":{ "type":"structure", "members":{ "control":{ "shape":"Control", "documentation":"

The new control that the `CreateControl` API returned.

" } } }, "CreateDelegationRequest":{ "type":"structure", "members":{ "comment":{ "shape":"DelegationComment", "documentation":"

A comment that's related to the delegation request.

" }, "controlSetId":{ "shape":"ControlSetId", "documentation":"

The unique identifier for the control set.

" }, "roleArn":{ "shape":"IamArn", "documentation":"

The Amazon Resource Name (ARN) of the IAM role.

" }, "roleType":{ "shape":"RoleType", "documentation":"

The type of customer persona.

In `CreateAssessment`, `roleType` can only be `PROCESS_OWNER`.

In `UpdateSettings`, `roleType` can only be `PROCESS_OWNER`.

In `BatchCreateDelegationByAssessment`, `roleType` can only be `RESOURCE_OWNER`.

" } }, "documentation":"

A collection of attributes that's used to create a delegation for an assessment in Audit Manager.

" }, "CreateDelegationRequests":{ "type":"list", "member":{"shape":"CreateDelegationRequest"}, "max":50, "min":1, "sensitive":true }, "CreatedBy":{ "type":"string", "max":100, "min":1, "pattern":"^[a-zA-Z0-9\\s-_()\\[\\]]+$", "sensitive":true }, "DefaultExportDestination":{ "type":"structure", "members":{ "destinationType":{ "shape":"ExportDestinationType", "documentation":"

The destination type, such as Amazon S3.

" }, "destination":{ "shape":"S3Url", "documentation":"

The destination bucket where Audit Manager stores exported files.

" } }, "documentation":"

The default s3 bucket where Audit Manager saves the files that you export from evidence finder.

" }, "Delegation":{ "type":"structure", "members":{ "id":{ "shape":"UUID", "documentation":"

The unique identifier for the delegation.

" }, "assessmentName":{ "shape":"AssessmentName", "documentation":"

The name of the assessment that's associated with the delegation.

" }, "assessmentId":{ "shape":"UUID", "documentation":"

The identifier for the assessment that's associated with the delegation.

" }, "status":{ "shape":"DelegationStatus", "documentation":"

The status of the delegation.

" }, "roleArn":{ "shape":"IamArn", "documentation":"

The Amazon Resource Name (ARN) of the IAM role.

" }, "roleType":{ "shape":"RoleType", "documentation":"

The type of customer persona.

In `CreateAssessment`, `roleType` can only be `PROCESS_OWNER`.

In `UpdateSettings`, `roleType` can only be `PROCESS_OWNER`.

In `BatchCreateDelegationByAssessment`, `roleType` can only be `RESOURCE_OWNER`.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

Specifies when the delegation was created.

" }, "lastUpdated":{ "shape":"Timestamp", "documentation":"

Specifies when the delegation was last updated.

" }, "controlSetId":{ "shape":"ControlSetId", "documentation":"

The identifier for the control set that's associated with the delegation.

" }, "comment":{ "shape":"DelegationComment", "documentation":"

The comment that's related to the delegation.

" }, "createdBy":{ "shape":"CreatedBy", "documentation":"

The user or role that created the delegation.

" } }, "documentation":"

The assignment of a control set to a delegate for review.

", "sensitive":true }, "DelegationComment":{ "type":"string", "max":350, "pattern":"^[\\w\\W\\s\\S]*$", "sensitive":true }, "DelegationIds":{ "type":"list", "member":{"shape":"UUID"}, "max":50, "min":1 }, "DelegationMetadata":{ "type":"structure", "members":{ "id":{ "shape":"UUID", "documentation":"

The unique identifier for the delegation.

" }, "assessmentName":{ "shape":"AssessmentName", "documentation":"

The name of the associated assessment.

" }, "assessmentId":{ "shape":"UUID", "documentation":"

The unique identifier for the assessment.

" }, "status":{ "shape":"DelegationStatus", "documentation":"

The current status of the delegation.

" }, "roleArn":{ "shape":"IamArn", "documentation":"

The Amazon Resource Name (ARN) of the IAM role.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

Specifies when the delegation was created.

" }, "controlSetName":{ "shape":"NonEmptyString", "documentation":"

Specifies the name of the control set that was delegated for review.

" } }, "documentation":"

The metadata that's associated with the delegation.

" }, "DelegationMetadataList":{ "type":"list", "member":{"shape":"DelegationMetadata"} }, "DelegationStatus":{ "type":"string", "enum":[ "IN_PROGRESS", "UNDER_REVIEW", "COMPLETE" ] }, "Delegations":{ "type":"list", "member":{"shape":"Delegation"} }, "DeleteAssessmentFrameworkRequest":{ "type":"structure", "required":["frameworkId"], "members":{ "frameworkId":{ "shape":"UUID", "documentation":"

The identifier for the custom framework.

", "location":"uri", "locationName":"frameworkId" } } }, "DeleteAssessmentFrameworkResponse":{ "type":"structure", "members":{ } }, "DeleteAssessmentFrameworkShareRequest":{ "type":"structure", "required":[ "requestId", "requestType" ], "members":{ "requestId":{ "shape":"UUID", "documentation":"

The unique identifier for the share request to be deleted.

", "location":"uri", "locationName":"requestId" }, "requestType":{ "shape":"ShareRequestType", "documentation":"

Specifies whether the share request is a sent request or a received request.

", "location":"querystring", "locationName":"requestType" } } }, "DeleteAssessmentFrameworkShareResponse":{ "type":"structure", "members":{ } }, "DeleteAssessmentReportRequest":{ "type":"structure", "required":[ "assessmentId", "assessmentReportId" ], "members":{ "assessmentId":{ "shape":"UUID", "documentation":"

The unique identifier for the assessment.

", "location":"uri", "locationName":"assessmentId" }, "assessmentReportId":{ "shape":"UUID", "documentation":"

The unique identifier for the assessment report.

", "location":"uri", "locationName":"assessmentReportId" } } }, "DeleteAssessmentReportResponse":{ "type":"structure", "members":{ } }, "DeleteAssessmentRequest":{ "type":"structure", "required":["assessmentId"], "members":{ "assessmentId":{ "shape":"UUID", "documentation":"

The identifier for the assessment.

", "location":"uri", "locationName":"assessmentId" } } }, "DeleteAssessmentResponse":{ "type":"structure", "members":{ } }, "DeleteControlRequest":{ "type":"structure", "required":["controlId"], "members":{ "controlId":{ "shape":"UUID", "documentation":"

The unique identifier for the control.

", "location":"uri", "locationName":"controlId" } } }, "DeleteControlResponse":{ "type":"structure", "members":{ } }, "DeleteResources":{ "type":"string", "enum":[ "ALL", "DEFAULT" ] }, "DeregisterAccountRequest":{ "type":"structure", "members":{ } }, "DeregisterAccountResponse":{ "type":"structure", "members":{ "status":{ "shape":"AccountStatus", "documentation":"

The registration status of the account.

" } } }, "DeregisterOrganizationAdminAccountRequest":{ "type":"structure", "members":{ "adminAccountId":{ "shape":"AccountId", "documentation":"

The identifier for the administrator account.

" } } }, "DeregisterOrganizationAdminAccountResponse":{ "type":"structure", "members":{ } }, "DeregistrationPolicy":{ "type":"structure", "members":{ "deleteResources":{ "shape":"DeleteResources", "documentation":"

Specifies which Audit Manager data will be deleted when you deregister Audit Manager.

- If you set the value to `ALL`, all of your data is deleted within seven days of deregistration.

- If you set the value to `DEFAULT`, none of your data is deleted at the time of deregistration. However, keep in mind that the Audit Manager data retention policy still applies. As a result, any evidence data will be deleted two years after its creation date. Your other Audit Manager resources will continue to exist indefinitely.

" } }, "documentation":"

The deregistration policy for the data that's stored in Audit Manager. You can use this attribute to determine how your data is handled when you deregister Audit Manager.

By default, Audit Manager retains evidence data for two years from the time of its creation. Other Audit Manager resources (including assessments, custom controls, and custom frameworks) remain in Audit Manager indefinitely, and are available if you re-register Audit Manager in the future. For more information about data retention, see Data Protection in the Audit Manager User Guide.

If you choose to delete all data, this action permanently deletes all evidence data in your account within seven days. It also deletes all of the Audit Manager resources that you created, including assessments, custom controls, and custom frameworks. Your data will not be available if you re-register Audit Manager in the future.

" }, "DisassociateAssessmentReportEvidenceFolderRequest":{ "type":"structure", "required":[ "assessmentId", "evidenceFolderId" ], "members":{ "assessmentId":{ "shape":"UUID", "documentation":"

The unique identifier for the assessment.

", "location":"uri", "locationName":"assessmentId" }, "evidenceFolderId":{ "shape":"UUID", "documentation":"

The unique identifier for the folder that the evidence is stored in.

" } } }, "DisassociateAssessmentReportEvidenceFolderResponse":{ "type":"structure", "members":{ } }, "EmailAddress":{ "type":"string", "max":320, "min":1, "pattern":"^.*@.*$", "sensitive":true }, "ErrorCode":{ "type":"string", "max":3, "min":3, "pattern":"[0-9]{3}" }, "ErrorMessage":{ "type":"string", "max":300, "pattern":"^[\\w\\W\\s\\S]*$" }, "EventName":{ "type":"string", "max":100, "pattern":"^[\\w\\W\\s\\S]*$" }, "Evidence":{ "type":"structure", "members":{ "dataSource":{ "shape":"String", "documentation":"

The data source where the evidence was collected from.

" }, "evidenceAwsAccountId":{ "shape":"AccountId", "documentation":"

The identifier for the Amazon Web Services account.

" }, "time":{ "shape":"Timestamp", "documentation":"

The timestamp that represents when the evidence was collected.

" }, "eventSource":{ "shape":"AWSServiceName", "documentation":"

The Amazon Web Service that the evidence is collected from.

" }, "eventName":{ "shape":"EventName", "documentation":"

The name of the evidence event.

" }, "evidenceByType":{ "shape":"String", "documentation":"

The type of automated evidence.

" }, "resourcesIncluded":{ "shape":"Resources", "documentation":"

The list of resources that are assessed to generate the evidence.

" }, "attributes":{ "shape":"EvidenceAttributes", "documentation":"

The names and values that are used by the evidence event. This includes an attribute name (such as `allowUsersToChangePassword`) and value (such as `true` or `false`).

" }, "iamId":{ "shape":"IamArn", "documentation":"

The unique identifier for the user or role that's associated with the evidence.

" }, "complianceCheck":{ "shape":"String", "documentation":"

The evaluation status for automated evidence that falls under the compliance check category.

- Audit Manager classes evidence as non-compliant if Security Hub reports a Fail result, or if Config reports a Non-compliant result.

- Audit Manager classes evidence as compliant if Security Hub reports a Pass result, or if Config reports a Compliant result.

- If a compliance check isn't available or applicable, then no compliance evaluation can be made for that evidence. This is the case if the evidence uses Config or Security Hub as the underlying data source type, but those services aren't enabled. This is also the case if the evidence uses an underlying data source type that doesn't support compliance checks (such as manual evidence, Amazon Web Services API calls, or CloudTrail).

" }, "awsOrganization":{ "shape":"String", "documentation":"

The Amazon Web Services account that the evidence is collected from, and its organization path.

" }, "awsAccountId":{ "shape":"AccountId", "documentation":"

The identifier for the Amazon Web Services account.

" }, "evidenceFolderId":{ "shape":"UUID", "documentation":"

The identifier for the folder that the evidence is stored in.

" }, "id":{ "shape":"UUID", "documentation":"

The identifier for the evidence.

" }, "assessmentReportSelection":{ "shape":"String", "documentation":"

Specifies whether the evidence is included in the assessment report.

" } }, "documentation":"

A record that contains the information needed to demonstrate compliance with the requirements specified by a control. Examples of evidence include change activity invoked by a user, or a system configuration snapshot.

" }, "EvidenceAttributeKey":{ "type":"string", "max":100, "pattern":"^[\\w\\W\\s\\S]*$" }, "EvidenceAttributeValue":{ "type":"string", "max":200, "pattern":"^[\\w\\W\\s\\S]*$" }, "EvidenceAttributes":{ "type":"map", "key":{"shape":"EvidenceAttributeKey"}, "value":{"shape":"EvidenceAttributeValue"} }, "EvidenceFinderBackfillStatus":{ "type":"string", "enum":[ "NOT_STARTED", "IN_PROGRESS", "COMPLETED" ] }, "EvidenceFinderEnablement":{ "type":"structure", "members":{ "eventDataStoreArn":{ "shape":"CloudTrailArn", "documentation":"

The Amazon Resource Name (ARN) of the CloudTrail Lake event data store that’s used by evidence finder. The event data store is the lake of evidence data that evidence finder runs queries against.

" }, "enablementStatus":{ "shape":"EvidenceFinderEnablementStatus", "documentation":"

The current status of the evidence finder feature and the related event data store.

- `ENABLE_IN_PROGRESS` means that you requested to enable evidence finder. An event data store is currently being created to support evidence finder queries.

- `ENABLED` means that an event data store was successfully created and evidence finder is enabled. We recommend that you wait 7 days until the event data store is backfilled with your past two years’ worth of evidence data. You can use evidence finder in the meantime, but not all data might be available until the backfill is complete.

- `DISABLE_IN_PROGRESS` means that you requested to disable evidence finder, and your request is pending the deletion of the event data store.

- `DISABLED` means that you have permanently disabled evidence finder and the event data store has been deleted. You can't re-enable evidence finder after this point.

" }, "backfillStatus":{ "shape":"EvidenceFinderBackfillStatus", "documentation":"

The current status of the evidence data backfill process.

The backfill starts after you enable evidence finder. During this task, Audit Manager populates an event data store with your past two years’ worth of evidence data so that your evidence can be queried.

- `NOT_STARTED` means that the backfill hasn’t started yet.

- `IN_PROGRESS` means that the backfill is in progress. This can take up to 7 days to complete, depending on the amount of evidence data.

- `COMPLETED` means that the backfill is complete. All of your past evidence is now queryable.

" }, "error":{ "shape":"ErrorMessage", "documentation":"

Represents any errors that occurred when enabling or disabling evidence finder.

" } }, "documentation":"

The settings object that specifies whether evidence finder is enabled. This object also describes the related event data store, and the backfill status for populating the event data store with evidence data.

" }, "EvidenceFinderEnablementStatus":{ "type":"string", "enum":[ "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS" ] }, "EvidenceIds":{ "type":"list", "member":{"shape":"UUID"}, "max":50, "min":0 }, "EvidenceInsights":{ "type":"structure", "members":{ "noncompliantEvidenceCount":{ "shape":"NullableInteger", "documentation":"

The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling.

" }, "compliantEvidenceCount":{ "shape":"NullableInteger", "documentation":"

The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling.

" }, "inconclusiveEvidenceCount":{ "shape":"NullableInteger", "documentation":"

The number of evidence that a compliance check ruling isn't available for. Evidence is inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when a control uses a data source that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail).

If evidence has a compliance check status of not applicable in the console, it's classified as inconclusive in `EvidenceInsights` data.

" } }, "documentation":"

A breakdown of the latest compliance check status for the evidence in your Audit Manager assessments.

" }, "EvidenceList":{ "type":"list", "member":{"shape":"Evidence"} }, "EvidenceSources":{ "type":"list", "member":{"shape":"NonEmptyString"} }, "ExportDestinationType":{ "type":"string", "enum":["S3"] }, "Filename":{ "type":"string", "max":255, "min":1, "pattern":"^[\\w,\\s-]+\\.[A-Za-z]+$" }, "Framework":{ "type":"structure", "members":{ "arn":{ "shape":"AuditManagerArn", "documentation":"

The Amazon Resource Name (ARN) of the framework.

" }, "id":{ "shape":"UUID", "documentation":"

The unique identifier for the framework.

" }, "name":{ "shape":"FrameworkName", "documentation":"

The name of the framework.

" }, "type":{ "shape":"FrameworkType", "documentation":"

Specifies whether the framework is a standard framework or a custom framework.

" }, "complianceType":{ "shape":"ComplianceType", "documentation":"

The compliance type that the framework supports, such as CIS or HIPAA.

" }, "description":{ "shape":"FrameworkDescription", "documentation":"

The description of the framework.

" }, "logo":{ "shape":"Filename", "documentation":"

The logo that's associated with the framework.

" }, "controlSources":{ "shape":"ControlSources", "documentation":"

The control data sources where Audit Manager collects evidence from.

" }, "controlSets":{ "shape":"ControlSets", "documentation":"

The control sets that are associated with the framework.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The time when the framework was created.

" }, "lastUpdatedAt":{ "shape":"Timestamp", "documentation":"

The time when the framework was most recently updated.

" }, "createdBy":{ "shape":"CreatedBy", "documentation":"

The user or role that created the framework.

" }, "lastUpdatedBy":{ "shape":"LastUpdatedBy", "documentation":"

The user or role that most recently updated the framework.

" }, "tags":{ "shape":"TagMap", "documentation":"

The tags that are associated with the framework.

" } }, "documentation":"

The file that's used to structure and automate Audit Manager assessments for a given compliance standard.

" }, "FrameworkDescription":{ "type":"string", "max":1000, "min":1, "pattern":"^[\\w\\W\\s\\S]*$" }, "FrameworkMetadata":{ "type":"structure", "members":{ "name":{ "shape":"AssessmentName", "documentation":"

The name of the framework.

" }, "description":{ "shape":"AssessmentFrameworkDescription", "documentation":"

The description of the framework.

" }, "logo":{ "shape":"Filename", "documentation":"

The logo that's associated with the framework.

" }, "complianceType":{ "shape":"ComplianceType", "documentation":"

The compliance standard that's associated with the framework. For example, this could be PCI DSS or HIPAA.

" } }, "documentation":"

The metadata of a framework, such as the name, ID, or description.

" }, "FrameworkMetadataList":{ "type":"list", "member":{"shape":"AssessmentFrameworkMetadata"} }, "FrameworkName":{ "type":"string", "max":300, "min":1, "pattern":"^[^\\\\]*$" }, "FrameworkType":{ "type":"string", "enum":[ "Standard", "Custom" ] }, "GenericArn":{ "type":"string", "max":2048, "min":20, "pattern":"^arn:.*" }, "GetAccountStatusRequest":{ "type":"structure", "members":{ } }, "GetAccountStatusResponse":{ "type":"structure", "members":{ "status":{ "shape":"AccountStatus", "documentation":"

The status of the Amazon Web Services account.

" } } }, "GetAssessmentFrameworkRequest":{ "type":"structure", "required":["frameworkId"], "members":{ "frameworkId":{ "shape":"UUID", "documentation":"

The identifier for the framework.

", "location":"uri", "locationName":"frameworkId" } } }, "GetAssessmentFrameworkResponse":{ "type":"structure", "members":{ "framework":{ "shape":"Framework", "documentation":"

The framework that the `GetAssessmentFramework` API returned.

" } } }, "GetAssessmentReportUrlRequest":{ "type":"structure", "required":[ "assessmentReportId", "assessmentId" ], "members":{ "assessmentReportId":{ "shape":"UUID", "documentation":"

The unique identifier for the assessment report.

", "location":"uri", "locationName":"assessmentReportId" }, "assessmentId":{ "shape":"UUID", "documentation":"

The unique identifier for the assessment.

", "location":"uri", "locationName":"assessmentId" } } }, "GetAssessmentReportUrlResponse":{ "type":"structure", "members":{ "preSignedUrl":{"shape":"URL"} } }, "GetAssessmentRequest":{ "type":"structure", "required":["assessmentId"], "members":{ "assessmentId":{ "shape":"UUID", "documentation":"

The unique identifier for the assessment.

", "location":"uri", "locationName":"assessmentId" } } }, "GetAssessmentResponse":{ "type":"structure", "members":{ "assessment":{"shape":"Assessment"}, "userRole":{"shape":"Role"} } }, "GetChangeLogsRequest":{ "type":"structure", "required":["assessmentId"], "members":{ "assessmentId":{ "shape":"UUID", "documentation":"

The unique identifier for the assessment.

", "location":"uri", "locationName":"assessmentId" }, "controlSetId":{ "shape":"ControlSetId", "documentation":"

The unique identifier for the control set.

", "location":"querystring", "locationName":"controlSetId" }, "controlId":{ "shape":"UUID", "documentation":"

The unique identifier for the control.

", "location":"querystring", "locationName":"controlId" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Represents the maximum number of results on a page or for an API request call.

", "location":"querystring", "locationName":"maxResults" } } }, "GetChangeLogsResponse":{ "type":"structure", "members":{ "changeLogs":{ "shape":"ChangeLogs", "documentation":"

The list of user activity for the control.

" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

" } } }, "GetControlRequest":{ "type":"structure", "required":["controlId"], "members":{ "controlId":{ "shape":"UUID", "documentation":"

The identifier for the control.

", "location":"uri", "locationName":"controlId" } } }, "GetControlResponse":{ "type":"structure", "members":{ "control":{ "shape":"Control", "documentation":"

The details of the control that the `GetControl` API returned.

" } } }, "GetDelegationsRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Represents the maximum number of results on a page or for an API request call.

", "location":"querystring", "locationName":"maxResults" } } }, "GetDelegationsResponse":{ "type":"structure", "members":{ "delegations":{ "shape":"DelegationMetadataList", "documentation":"

The list of delegations that the `GetDelegations` API returned.

" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

" } } }, "GetEvidenceByEvidenceFolderRequest":{ "type":"structure", "required":[ "assessmentId", "controlSetId", "evidenceFolderId" ], "members":{ "assessmentId":{ "shape":"UUID", "documentation":"

The identifier for the assessment.

", "location":"uri", "locationName":"assessmentId" }, "controlSetId":{ "shape":"ControlSetId", "documentation":"

The identifier for the control set.

", "location":"uri", "locationName":"controlSetId" }, "evidenceFolderId":{ "shape":"UUID", "documentation":"

The unique identifier for the folder that the evidence is stored in.

", "location":"uri", "locationName":"evidenceFolderId" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Represents the maximum number of results on a page or for an API request call.

", "location":"querystring", "locationName":"maxResults" } } }, "GetEvidenceByEvidenceFolderResponse":{ "type":"structure", "members":{ "evidence":{ "shape":"EvidenceList", "documentation":"

The list of evidence that the `GetEvidenceByEvidenceFolder` API returned.

" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

" } } }, "GetEvidenceFileUploadUrlRequest":{ "type":"structure", "required":["fileName"], "members":{ "fileName":{ "shape":"ManualEvidenceLocalFileName", "documentation":"

The file that you want to upload. For a list of supported file formats, see Supported file types for manual evidence in the Audit Manager User Guide.

", "location":"querystring", "locationName":"fileName" } } }, "GetEvidenceFileUploadUrlResponse":{ "type":"structure", "members":{ "evidenceFileName":{ "shape":"NonEmptyString", "documentation":"

The name of the uploaded manual evidence file that the presigned URL was generated for.

" }, "uploadUrl":{ "shape":"NonEmptyString", "documentation":"

The presigned URL that was generated.

" } }, "sensitive":true }, "GetEvidenceFolderRequest":{ "type":"structure", "required":[ "assessmentId", "controlSetId", "evidenceFolderId" ], "members":{ "assessmentId":{ "shape":"UUID", "documentation":"

The unique identifier for the assessment.

", "location":"uri", "locationName":"assessmentId" }, "controlSetId":{ "shape":"ControlSetId", "documentation":"

The unique identifier for the control set.

", "location":"uri", "locationName":"controlSetId" }, "evidenceFolderId":{ "shape":"UUID", "documentation":"

The unique identifier for the folder that the evidence is stored in.

", "location":"uri", "locationName":"evidenceFolderId" } } }, "GetEvidenceFolderResponse":{ "type":"structure", "members":{ "evidenceFolder":{ "shape":"AssessmentEvidenceFolder", "documentation":"

The folder that the evidence is stored in.

" } } }, "GetEvidenceFoldersByAssessmentControlRequest":{ "type":"structure", "required":[ "assessmentId", "controlSetId", "controlId" ], "members":{ "assessmentId":{ "shape":"UUID", "documentation":"

The identifier for the assessment.

", "location":"uri", "locationName":"assessmentId" }, "controlSetId":{ "shape":"ControlSetId", "documentation":"

The identifier for the control set.

", "location":"uri", "locationName":"controlSetId" }, "controlId":{ "shape":"UUID", "documentation":"

The identifier for the control.

", "location":"uri", "locationName":"controlId" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Represents the maximum number of results on a page or for an API request call.

", "location":"querystring", "locationName":"maxResults" } } }, "GetEvidenceFoldersByAssessmentControlResponse":{ "type":"structure", "members":{ "evidenceFolders":{ "shape":"AssessmentEvidenceFolders", "documentation":"

The list of evidence folders that the `GetEvidenceFoldersByAssessmentControl` API returned.

" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

" } } }, "GetEvidenceFoldersByAssessmentRequest":{ "type":"structure", "required":["assessmentId"], "members":{ "assessmentId":{ "shape":"UUID", "documentation":"

The unique identifier for the assessment.

", "location":"uri", "locationName":"assessmentId" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Represents the maximum number of results on a page or for an API request call.

", "location":"querystring", "locationName":"maxResults" } } }, "GetEvidenceFoldersByAssessmentResponse":{ "type":"structure", "members":{ "evidenceFolders":{ "shape":"AssessmentEvidenceFolders", "documentation":"

The list of evidence folders that the `GetEvidenceFoldersByAssessment` API returned.

" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

" } } }, "GetEvidenceRequest":{ "type":"structure", "required":[ "assessmentId", "controlSetId", "evidenceFolderId", "evidenceId" ], "members":{ "assessmentId":{ "shape":"UUID", "documentation":"

The unique identifier for the assessment.

", "location":"uri", "locationName":"assessmentId" }, "controlSetId":{ "shape":"ControlSetId", "documentation":"

The unique identifier for the control set.

", "location":"uri", "locationName":"controlSetId" }, "evidenceFolderId":{ "shape":"UUID", "documentation":"

The unique identifier for the folder that the evidence is stored in.

", "location":"uri", "locationName":"evidenceFolderId" }, "evidenceId":{ "shape":"UUID", "documentation":"

The unique identifier for the evidence.

", "location":"uri", "locationName":"evidenceId" } } }, "GetEvidenceResponse":{ "type":"structure", "members":{ "evidence":{ "shape":"Evidence", "documentation":"

The evidence that the `GetEvidence` API returned.

" } } }, "GetInsightsByAssessmentRequest":{ "type":"structure", "required":["assessmentId"], "members":{ "assessmentId":{ "shape":"UUID", "documentation":"

The unique identifier for the assessment.

", "location":"uri", "locationName":"assessmentId" } } }, "GetInsightsByAssessmentResponse":{ "type":"structure", "members":{ "insights":{ "shape":"InsightsByAssessment", "documentation":"

The assessment analytics data that the `GetInsightsByAssessment` API returned.

" } } }, "GetInsightsRequest":{ "type":"structure", "members":{ } }, "GetInsightsResponse":{ "type":"structure", "members":{ "insights":{ "shape":"Insights", "documentation":"

The analytics data that the `GetInsights` API returned.

" } } }, "GetOrganizationAdminAccountRequest":{ "type":"structure", "members":{ } }, "GetOrganizationAdminAccountResponse":{ "type":"structure", "members":{ "adminAccountId":{ "shape":"AccountId", "documentation":"

The identifier for the administrator account.

" }, "organizationId":{ "shape":"organizationId", "documentation":"

The identifier for the organization.

" } } }, "GetServicesInScopeRequest":{ "type":"structure", "members":{ } }, "GetServicesInScopeResponse":{ "type":"structure", "members":{ "serviceMetadata":{ "shape":"ServiceMetadataList", "documentation":"

The metadata that's associated with the Amazon Web Service.

" } } }, "GetSettingsRequest":{ "type":"structure", "required":["attribute"], "members":{ "attribute":{ "shape":"SettingAttribute", "documentation":"

The list of setting attribute enum values.

", "location":"uri", "locationName":"attribute" } } }, "GetSettingsResponse":{ "type":"structure", "members":{ "settings":{ "shape":"Settings", "documentation":"

The settings object that holds all supported Audit Manager settings.

" } } }, "HyperlinkName":{ "type":"string", "max":200, "min":1, "pattern":"^[\\w\\W\\s\\S]*$" }, "IamArn":{ "type":"string", "max":2048, "min":20, "pattern":"^arn:.*:iam:.*" }, "Insights":{ "type":"structure", "members":{ "activeAssessmentsCount":{ "shape":"NullableInteger", "documentation":"

The number of active assessments in Audit Manager.

" }, "noncompliantEvidenceCount":{ "shape":"NullableInteger", "documentation":"

The number of compliance check evidence that Audit Manager classified as non-compliant on the `lastUpdated` date. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling.

" }, "compliantEvidenceCount":{ "shape":"NullableInteger", "documentation":"

The number of compliance check evidence that Audit Manager classified as compliant on the `lastUpdated` date. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling.

" }, "inconclusiveEvidenceCount":{ "shape":"NullableInteger", "documentation":"

The number of evidence without a compliance check ruling. Evidence is inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when a control uses a data source that doesn’t support compliance checks (for example: manual evidence, API calls, or CloudTrail).

If evidence has a compliance check status of not applicable, it's classed as inconclusive in `Insights` data.

" }, "assessmentControlsCountByNoncompliantEvidence":{ "shape":"NullableInteger", "documentation":"

The number of assessment controls that collected non-compliant evidence on the `lastUpdated` date.

" }, "totalAssessmentControlsCount":{ "shape":"NullableInteger", "documentation":"

The total number of controls across all active assessments.

" }, "lastUpdated":{ "shape":"Timestamp", "documentation":"

The time when the cross-assessment insights were last updated.

" } }, "documentation":"

A summary of the latest analytics data for all your active assessments.

This summary is a snapshot of the data that your active assessments collected on the `lastUpdated` date. It’s important to understand that the following totals are daily counts based on this date — they aren’t a total sum to date.

The `Insights` data is eventually consistent. This means that, when you read data from `Insights`, the response might not instantly reflect the results of a recently completed write or update operation. If you repeat your read request after a few hours, the response should return the latest data.

If you delete an assessment or change its status to inactive, `InsightsByAssessment` includes data for that assessment as follows.

- Inactive assessments - If Audit Manager collected evidence for your assessment before you changed it inactive, that evidence is included in the `InsightsByAssessment` counts for that day.

- Deleted assessments - If Audit Manager collected evidence for your assessment before you deleted it, that evidence isn't included in the `InsightsByAssessment` counts for that day.

" }, "InsightsByAssessment":{ "type":"structure", "members":{ "noncompliantEvidenceCount":{ "shape":"NullableInteger", "documentation":"

The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling.

" }, "compliantEvidenceCount":{ "shape":"NullableInteger", "documentation":"

The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling.

" }, "inconclusiveEvidenceCount":{ "shape":"NullableInteger", "documentation":"

The amount of evidence without a compliance check ruling. Evidence is inconclusive if the associated control uses Security Hub or Config as a data source and you didn't enable those services. This is also the case if a control uses a data source that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail).

If evidence has a compliance check status of not applicable, it's classified as inconclusive in `InsightsByAssessment` data.

" }, "assessmentControlsCountByNoncompliantEvidence":{ "shape":"NullableInteger", "documentation":"

The number of assessment controls that collected non-compliant evidence on the `lastUpdated` date.

" }, "totalAssessmentControlsCount":{ "shape":"NullableInteger", "documentation":"

The total number of controls in the assessment.

" }, "lastUpdated":{ "shape":"Timestamp", "documentation":"

The time when the assessment insights were last updated.

" } }, "documentation":"

A summary of the latest analytics data for a specific active assessment.

This summary is a snapshot of the data that was collected on the `lastUpdated` date. It’s important to understand that the totals in `InsightsByAssessment` are daily counts based on this date — they aren’t a total sum to date.

The `InsightsByAssessment` data is eventually consistent. This means that when you read data from `InsightsByAssessment`, the response might not instantly reflect the results of a recently completed write or update operation. If you repeat your read request after a few hours, the response returns the latest data.

If you delete an assessment or change its status to inactive, `InsightsByAssessment` includes data for that assessment as follows.

- Inactive assessments - If Audit Manager collected evidence for your assessment before you changed it inactive, that evidence is included in the `InsightsByAssessment` counts for that day.

- Deleted assessments - If Audit Manager collected evidence for your assessment before you deleted it, that evidence isn't included in the `InsightsByAssessment` counts for that day.

" }, "Integer":{"type":"integer"}, "InternalServerException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

An internal service error occurred during the processing of your request. Try again later.

", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "KeywordInputType":{ "type":"string", "enum":[ "SELECT_FROM_LIST", "UPLOAD_FILE", "INPUT_TEXT" ] }, "KeywordValue":{ "type":"string", "max":100, "min":1, "pattern":"^[a-zA-Z_0-9-\\s().]+$" }, "Keywords":{ "type":"list", "member":{"shape":"KeywordValue"} }, "KmsKey":{ "type":"string", "max":2048, "min":7, "pattern":"^arn:.*:kms:.*|DEFAULT" }, "LastUpdatedBy":{ "type":"string", "max":100, "min":1, "pattern":"^[a-zA-Z0-9\\s-_()\\[\\]]+$", "sensitive":true }, "ListAssessmentControlInsightsByControlDomainRequest":{ "type":"structure", "required":[ "controlDomainId", "assessmentId" ], "members":{ "controlDomainId":{ "shape":"UUID", "documentation":"

The unique identifier for the control domain.

", "location":"querystring", "locationName":"controlDomainId" }, "assessmentId":{ "shape":"UUID", "documentation":"

The unique identifier for the active assessment.

", "location":"querystring", "locationName":"assessmentId" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Represents the maximum number of results on a page or for an API request call.

", "location":"querystring", "locationName":"maxResults" } } }, "ListAssessmentControlInsightsByControlDomainResponse":{ "type":"structure", "members":{ "controlInsightsByAssessment":{ "shape":"ControlInsightsMetadataByAssessment", "documentation":"

The assessment control analytics data that the `ListAssessmentControlInsightsByControlDomain` API returned.

" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

" } } }, "ListAssessmentFrameworkShareRequestsRequest":{ "type":"structure", "required":["requestType"], "members":{ "requestType":{ "shape":"ShareRequestType", "documentation":"

Specifies whether the share request is a sent request or a received request.

", "location":"querystring", "locationName":"requestType" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Represents the maximum number of results on a page or for an API request call.

", "location":"querystring", "locationName":"maxResults" } } }, "ListAssessmentFrameworkShareRequestsResponse":{ "type":"structure", "members":{ "assessmentFrameworkShareRequests":{ "shape":"AssessmentFrameworkShareRequestList", "documentation":"

The list of share requests that the `ListAssessmentFrameworkShareRequests` API returned.

" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

" } } }, "ListAssessmentFrameworksRequest":{ "type":"structure", "required":["frameworkType"], "members":{ "frameworkType":{ "shape":"FrameworkType", "documentation":"

The type of framework, such as a standard framework or a custom framework.

", "location":"querystring", "locationName":"frameworkType" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Represents the maximum number of results on a page or for an API request call.

", "location":"querystring", "locationName":"maxResults" } } }, "ListAssessmentFrameworksResponse":{ "type":"structure", "members":{ "frameworkMetadataList":{ "shape":"FrameworkMetadataList", "documentation":"

A list of metadata that the `ListAssessmentFrameworks` API returns for each framework.

" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

" } } }, "ListAssessmentMetadata":{ "type":"list", "member":{"shape":"AssessmentMetadataItem"} }, "ListAssessmentReportsRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Represents the maximum number of results on a page or for an API request call.

", "location":"querystring", "locationName":"maxResults" } } }, "ListAssessmentReportsResponse":{ "type":"structure", "members":{ "assessmentReports":{ "shape":"AssessmentReportsMetadata", "documentation":"

The list of assessment reports that the `ListAssessmentReports` API returned.

" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

" } } }, "ListAssessmentsRequest":{ "type":"structure", "members":{ "status":{ "shape":"AssessmentStatus", "documentation":"

The current status of the assessment.

", "location":"querystring", "locationName":"status" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Represents the maximum number of results on a page or for an API request call.

", "location":"querystring", "locationName":"maxResults" } } }, "ListAssessmentsResponse":{ "type":"structure", "members":{ "assessmentMetadata":{ "shape":"ListAssessmentMetadata", "documentation":"

The metadata that the `ListAssessments` API returns for each assessment.

" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

" } } }, "ListControlDomainInsightsByAssessmentRequest":{ "type":"structure", "required":["assessmentId"], "members":{ "assessmentId":{ "shape":"UUID", "documentation":"

The unique identifier for the active assessment.

", "location":"querystring", "locationName":"assessmentId" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Represents the maximum number of results on a page or for an API request call.

", "location":"querystring", "locationName":"maxResults" } } }, "ListControlDomainInsightsByAssessmentResponse":{ "type":"structure", "members":{ "controlDomainInsights":{ "shape":"ControlDomainInsightsList", "documentation":"

The control domain analytics data that the `ListControlDomainInsightsByAssessment` API returned.

" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

" } } }, "ListControlDomainInsightsRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Represents the maximum number of results on a page or for an API request call.

", "location":"querystring", "locationName":"maxResults" } } }, "ListControlDomainInsightsResponse":{ "type":"structure", "members":{ "controlDomainInsights":{ "shape":"ControlDomainInsightsList", "documentation":"

The control domain analytics data that the `ListControlDomainInsights` API returned.

" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

" } } }, "ListControlInsightsByControlDomainRequest":{ "type":"structure", "required":["controlDomainId"], "members":{ "controlDomainId":{ "shape":"UUID", "documentation":"

The unique identifier for the control domain.

", "location":"querystring", "locationName":"controlDomainId" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Represents the maximum number of results on a page or for an API request call.

", "location":"querystring", "locationName":"maxResults" } } }, "ListControlInsightsByControlDomainResponse":{ "type":"structure", "members":{ "controlInsightsMetadata":{ "shape":"ControlInsightsMetadata", "documentation":"

The control analytics data that the `ListControlInsightsByControlDomain` API returned.

" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

" } } }, "ListControlsRequest":{ "type":"structure", "required":["controlType"], "members":{ "controlType":{ "shape":"ControlType", "documentation":"

The type of control, such as a standard control or a custom control.

", "location":"querystring", "locationName":"controlType" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Represents the maximum number of results on a page or for an API request call.

", "location":"querystring", "locationName":"maxResults" } } }, "ListControlsResponse":{ "type":"structure", "members":{ "controlMetadataList":{ "shape":"ControlMetadataList", "documentation":"

A list of metadata that the `ListControls` API returns for each control.

" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

" } } }, "ListKeywordsForDataSourceRequest":{ "type":"structure", "required":["source"], "members":{ "source":{ "shape":"SourceType", "documentation":"

The control mapping data source that the keywords apply to.

", "location":"querystring", "locationName":"source" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Represents the maximum number of results on a page or for an API request call.

", "location":"querystring", "locationName":"maxResults" } } }, "ListKeywordsForDataSourceResponse":{ "type":"structure", "members":{ "keywords":{ "shape":"Keywords", "documentation":"

The list of keywords for the event mapping source.

" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

" } } }, "ListNotificationsRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Represents the maximum number of results on a page or for an API request call.

", "location":"querystring", "locationName":"maxResults" } } }, "ListNotificationsResponse":{ "type":"structure", "members":{ "notifications":{ "shape":"Notifications", "documentation":"

The returned list of notifications.

" }, "nextToken":{ "shape":"Token", "documentation":"

The pagination token that's used to fetch the next set of results.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"AuditManagerArn", "documentation":"

The Amazon Resource Name (ARN) of the resource.

", "location":"uri", "locationName":"resourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"TagMap", "documentation":"

The list of tags that the `ListTagsForResource` API returned.

" } } }, "ManualEvidence":{ "type":"structure", "members":{ "s3ResourcePath":{ "shape":"S3Url", "documentation":"

The S3 URL of the object that's imported as manual evidence.

" }, "textResponse":{ "shape":"ManualEvidenceTextResponse", "documentation":"

The plain text response that's entered and saved as manual evidence.

" }, "evidenceFileName":{ "shape":"ManualEvidenceLocalFileName", "documentation":"

The name of the file that's uploaded as manual evidence. This name is populated using the `evidenceFileName` value from the `GetEvidenceFileUploadUrl` API response.

" } }, "documentation":"

Evidence that's manually added to a control in Audit Manager. `manualEvidence` can be one of the following: `evidenceFileName`, `s3ResourcePath`, or `textResponse`.

" }, "ManualEvidenceList":{ "type":"list", "member":{"shape":"ManualEvidence"}, "max":50, "min":1 }, "ManualEvidenceLocalFileName":{ "type":"string", "max":300, "min":1, "pattern":"[^\\/]*", "sensitive":true }, "ManualEvidenceTextResponse":{ "type":"string", "max":1000, "min":1, "pattern":"^[\\w\\W\\s\\S]*$", "sensitive":true }, "MaxResults":{ "type":"integer", "documentation":"Max results in the page.", "max":1000, "min":1 }, "NonEmptyString":{ "type":"string", "max":2048, "min":1, "pattern":".*\\S.*" }, "Notification":{ "type":"structure", "members":{ "id":{ "shape":"TimestampUUID", "documentation":"

The unique identifier for the notification.

" }, "assessmentId":{ "shape":"UUID", "documentation":"

The identifier for the assessment.

" }, "assessmentName":{ "shape":"AssessmentName", "documentation":"

The name of the related assessment.

" }, "controlSetId":{ "shape":"ControlSetId", "documentation":"

The identifier for the control set.

" }, "controlSetName":{ "shape":"NonEmptyString", "documentation":"

Specifies the name of the control set that the notification is about.

" }, "description":{ "shape":"NonEmptyString", "documentation":"

The description of the notification.

" }, "eventTime":{ "shape":"Timestamp", "documentation":"

The time when the notification was sent.

" }, "source":{ "shape":"NonEmptyString", "documentation":"

The sender of the notification.

" } }, "documentation":"

The notification that informs a user of an update in Audit Manager. For example, this includes the notification that's sent when a control set is delegated for review.

" }, "Notifications":{ "type":"list", "member":{"shape":"Notification"} }, "NullableInteger":{"type":"integer"}, "ObjectTypeEnum":{ "type":"string", "enum":[ "ASSESSMENT", "CONTROL_SET", "CONTROL", "DELEGATION", "ASSESSMENT_REPORT" ] }, "QueryStatement":{ "type":"string", "max":10000, "min":1, "pattern":"(?s).*" }, "Region":{ "type":"string", "pattern":"^[a-z]{2}-[a-z]+-[0-9]{1}$" }, "RegisterAccountRequest":{ "type":"structure", "members":{ "kmsKey":{ "shape":"KmsKey", "documentation":"

The KMS key details.

" }, "delegatedAdminAccount":{ "shape":"AccountId", "documentation":"

The delegated administrator account for Audit Manager.

" } } }, "RegisterAccountResponse":{ "type":"structure", "members":{ "status":{ "shape":"AccountStatus", "documentation":"

The status of the account registration request.

" } } }, "RegisterOrganizationAdminAccountRequest":{ "type":"structure", "required":["adminAccountId"], "members":{ "adminAccountId":{ "shape":"AccountId", "documentation":"

The identifier for the delegated administrator account.

" } } }, "RegisterOrganizationAdminAccountResponse":{ "type":"structure", "members":{ "adminAccountId":{ "shape":"AccountId", "documentation":"

The identifier for the delegated administrator account.

" }, "organizationId":{ "shape":"organizationId", "documentation":"

The identifier for the organization.

" } } }, "Resource":{ "type":"structure", "members":{ "arn":{ "shape":"GenericArn", "documentation":"

The Amazon Resource Name (ARN) for the resource.

" }, "value":{ "shape":"String", "documentation":"

The value of the resource.

" }, "complianceCheck":{ "shape":"String", "documentation":"

The evaluation status for a resource that was assessed when collecting compliance check evidence.

- Audit Manager classes the resource as non-compliant if Security Hub reports a Fail result, or if Config reports a Non-compliant result.

- Audit Manager classes the resource as compliant if Security Hub reports a Pass result, or if Config reports a Compliant result.

- If a compliance check isn't available or applicable, then no compliance evaluation can be made for that resource. This is the case if a resource assessment uses Config or Security Hub as the underlying data source type, but those services aren't enabled. This is also the case if the resource assessment uses an underlying data source type that doesn't support compliance checks (such as manual evidence, Amazon Web Services API calls, or CloudTrail).

" } }, "documentation":"

A system asset that's evaluated in an Audit Manager assessment.

" }, "ResourceNotFoundException":{ "type":"structure", "required":[ "message", "resourceId", "resourceType" ], "members":{ "message":{"shape":"String"}, "resourceId":{ "shape":"String", "documentation":"

The unique identifier for the resource.

" }, "resourceType":{ "shape":"String", "documentation":"

The type of resource that's affected by the error.

" } }, "documentation":"

The resource that's specified in the request can't be found.

", "error":{"httpStatusCode":404}, "exception":true }, "Resources":{ "type":"list", "member":{"shape":"Resource"} }, "Role":{ "type":"structure", "required":[ "roleType", "roleArn" ], "members":{ "roleType":{ "shape":"RoleType", "documentation":"

The type of customer persona.

In `CreateAssessment`, `roleType` can only be `PROCESS_OWNER`.

In `UpdateSettings`, `roleType` can only be `PROCESS_OWNER`.

In `BatchCreateDelegationByAssessment`, `roleType` can only be `RESOURCE_OWNER`.

" }, "roleArn":{ "shape":"IamArn", "documentation":"

The Amazon Resource Name (ARN) of the IAM role.

" } }, "documentation":"

The wrapper that contains the Audit Manager role information of the current user. This includes the role type and IAM Amazon Resource Name (ARN).

" }, "RoleType":{ "type":"string", "enum":[ "PROCESS_OWNER", "RESOURCE_OWNER" ] }, "Roles":{ "type":"list", "member":{"shape":"Role"}, "sensitive":true }, "S3Url":{ "type":"string", "max":1024, "min":1, "pattern":"^(S|s)3:\\/\\/[a-zA-Z0-9\\-\\.\\(\\)\\'\\*\\_\\!\\/]+$" }, "SNSTopic":{ "type":"string", "max":255, "min":1, "pattern":"^[a-zA-Z0-9-_\\(\\)\\[\\]]+$", "sensitive":true }, "Scope":{ "type":"structure", "members":{ "awsAccounts":{ "shape":"AWSAccounts", "documentation":"

The Amazon Web Services accounts that are included in the scope of the assessment.

" }, "awsServices":{ "shape":"AWSServices", "documentation":"

The Amazon Web Services services that are included in the scope of the assessment.

" } }, "documentation":"

The wrapper that contains the Amazon Web Services accounts and services that are in scope for the assessment.

", "sensitive":true }, "ServiceMetadata":{ "type":"structure", "members":{ "name":{ "shape":"AWSServiceName", "documentation":"

The name of the Amazon Web Service.

" }, "displayName":{ "shape":"NonEmptyString", "documentation":"

The display name of the Amazon Web Service.

" }, "description":{ "shape":"NonEmptyString", "documentation":"

The description of the Amazon Web Service.

" }, "category":{ "shape":"NonEmptyString", "documentation":"

The category that the Amazon Web Service belongs to, such as compute, storage, or database.

" } }, "documentation":"

The metadata that's associated with the Amazon Web Service.

" }, "ServiceMetadataList":{ "type":"list", "member":{"shape":"ServiceMetadata"} }, "ServiceQuotaExceededException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

You've reached your account quota for this resource type. To perform the requested action, delete some existing resources or request a quota increase from the Service Quotas console. For a list of Audit Manager service quotas, see Quotas and restrictions for Audit Manager.

", "error":{"httpStatusCode":402}, "exception":true }, "SettingAttribute":{ "type":"string", "enum":[ "ALL", "IS_AWS_ORG_ENABLED", "SNS_TOPIC", "DEFAULT_ASSESSMENT_REPORTS_DESTINATION", "DEFAULT_PROCESS_OWNERS", "EVIDENCE_FINDER_ENABLEMENT", "DEREGISTRATION_POLICY", "DEFAULT_EXPORT_DESTINATION" ] }, "Settings":{ "type":"structure", "members":{ "isAwsOrgEnabled":{ "shape":"Boolean", "documentation":"

Specifies whether Organizations is enabled.

" }, "snsTopic":{ "shape":"SNSTopic", "documentation":"

The designated Amazon Simple Notification Service (Amazon SNS) topic.

" }, "defaultAssessmentReportsDestination":{ "shape":"AssessmentReportsDestination", "documentation":"

The default S3 destination bucket for storing assessment reports.

" }, "defaultProcessOwners":{ "shape":"Roles", "documentation":"

The designated default audit owners.

" }, "kmsKey":{ "shape":"KmsKey", "documentation":"

The KMS key details.

" }, "evidenceFinderEnablement":{ "shape":"EvidenceFinderEnablement", "documentation":"

The current evidence finder status and event data store details.

" }, "deregistrationPolicy":{ "shape":"DeregistrationPolicy", "documentation":"

The deregistration policy for your Audit Manager data. You can use this attribute to determine how your data is handled when you deregister Audit Manager.

" }, "defaultExportDestination":{ "shape":"DefaultExportDestination", "documentation":"

The default S3 destination bucket for storing evidence finder exports.

" } }, "documentation":"

The settings object that holds all supported Audit Manager settings.

" }, "ShareRequestAction":{ "type":"string", "enum":[ "ACCEPT", "DECLINE", "REVOKE" ] }, "ShareRequestComment":{ "type":"string", "max":500, "pattern":"^[\\w\\W\\s\\S]*$" }, "ShareRequestStatus":{ "type":"string", "enum":[ "ACTIVE", "REPLICATING", "SHARED", "EXPIRING", "FAILED", "EXPIRED", "DECLINED", "REVOKED" ] }, "ShareRequestType":{ "type":"string", "enum":[ "SENT", "RECEIVED" ] }, "SnsArn":{ "type":"string", "max":2048, "min":4, "pattern":"^arn:.*:sns:.*|NONE" }, "SourceDescription":{ "type":"string", "max":1000, "pattern":"^[\\w\\W\\s\\S]*$" }, "SourceFrequency":{ "type":"string", "enum":[ "DAILY", "WEEKLY", "MONTHLY" ] }, "SourceKeyword":{ "type":"structure", "members":{ "keywordInputType":{ "shape":"KeywordInputType", "documentation":"

The input method for the keyword.

- `SELECT_FROM_LIST` is used when mapping a data source for automated evidence.

  - When `keywordInputType` is `SELECT_FROM_LIST`, a keyword must be selected to collect automated evidence. For example, this keyword can be a CloudTrail event name, a rule name for Config, a Security Hub control, or the name of an Amazon Web Services API call.

- `UPLOAD_FILE` and `INPUT_TEXT` are only used when mapping a data source for manual evidence.

  - When `keywordInputType` is `UPLOAD_FILE`, a file must be uploaded as manual evidence.

  - When `keywordInputType` is `INPUT_TEXT`, text must be entered as manual evidence.

" }, "keywordValue":{ "shape":"KeywordValue", "documentation":"

The value of the keyword that's used when mapping a control data source. For example, this can be a CloudTrail event name, a rule name for Config, a Security Hub control, or the name of an Amazon Web Services API call.

If you’re mapping a data source to a rule in Config, the `keywordValue` that you specify depends on the type of rule:

- For managed rules, you can use the rule identifier as the `keywordValue`. You can find the rule identifier from the list of Config managed rules. For some rules, the rule identifier is different from the rule name. For example, the rule name `restricted-ssh` has the following rule identifier: `INCOMING_SSH_DISABLED`. Make sure to use the rule identifier, not the rule name.

  Keyword example for managed rules:

  - Managed rule name: s3-bucket-acl-prohibited

    `keywordValue`: `S3_BUCKET_ACL_PROHIBITED`

- For custom rules, you form the `keywordValue` by adding the `Custom_` prefix to the rule name. This prefix distinguishes the custom rule from a managed rule.

  Keyword example for custom rules:

  - Custom rule name: my-custom-config-rule

    `keywordValue`: `Custom_my-custom-config-rule`

- For service-linked rules, you form the `keywordValue` by adding the `Custom_` prefix to the rule name. In addition, you remove the suffix ID that appears at the end of the rule name.

  Keyword examples for service-linked rules:

  - Service-linked rule name: CustomRuleForAccount-conformance-pack-szsm1uv0w

    `keywordValue`: `Custom_CustomRuleForAccount-conformance-pack`

  - Service-linked rule name: OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba

    `keywordValue`: `Custom_OrgConfigRule-s3-bucket-versioning-enabled`

The `keywordValue` is case sensitive. If you enter a value incorrectly, Audit Manager might not recognize the data source mapping. As a result, you might not successfully collect evidence from that data source as intended.

Keep in mind the following requirements, depending on the data source type that you're using.

1. For Config:

   - For managed rules, make sure that the `keywordValue` is the rule identifier in `ALL_CAPS_WITH_UNDERSCORES`. For example, `CLOUDWATCH_LOG_GROUP_ENCRYPTED`. For accuracy, we recommend that you reference the list of supported Config managed rules.

   - For custom rules, make sure that the `keywordValue` has the `Custom_` prefix followed by the custom rule name. The format of the custom rule name itself may vary. For accuracy, we recommend that you visit the Config console to verify your custom rule name.

2. For Security Hub: The format varies for Security Hub control names. For accuracy, we recommend that you reference the list of supported Security Hub controls.

3. For Amazon Web Services API calls: Make sure that the `keywordValue` is written as `serviceprefix_ActionName`. For example, `iam_ListGroups`. For accuracy, we recommend that you reference the list of supported API calls.

4. For CloudTrail: Make sure that the `keywordValue` is written as `serviceprefix_ActionName`. For example, `cloudtrail_StartLogging`. For accuracy, we recommend that you review the Amazon Web Service prefix and action names in the Service Authorization Reference.

" } }, "documentation":"

A keyword that relates to the control data source.

For manual evidence, this keyword indicates if the manual evidence is a file or text.

For automated evidence, this keyword identifies a specific CloudTrail event, Config rule, Security Hub control, or Amazon Web Services API name.

To learn more about the supported keywords that you can use when mapping a control data source, see the following pages in the Audit Manager User Guide:

- Config rules supported by Audit Manager

- Security Hub controls supported by Audit Manager

- API calls supported by Audit Manager

- CloudTrail event names supported by Audit Manager

" }, "SourceName":{ "type":"string", "max":100, "min":1 }, "SourceSetUpOption":{ "type":"string", "enum":[ "System_Controls_Mapping", "Procedural_Controls_Mapping" ] }, "SourceType":{ "type":"string", "enum":[ "AWS_Cloudtrail", "AWS_Config", "AWS_Security_Hub", "AWS_API_Call", "MANUAL" ] }, "StartAssessmentFrameworkShareRequest":{ "type":"structure", "required":[ "frameworkId", "destinationAccount", "destinationRegion" ], "members":{ "frameworkId":{ "shape":"UUID", "documentation":"

The unique identifier for the custom framework to be shared.

", "location":"uri", "locationName":"frameworkId" }, "destinationAccount":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account of the recipient.

" }, "destinationRegion":{ "shape":"Region", "documentation":"

The Amazon Web Services Region of the recipient.

" }, "comment":{ "shape":"ShareRequestComment", "documentation":"

An optional comment from the sender about the share request.

" } } }, "StartAssessmentFrameworkShareResponse":{ "type":"structure", "members":{ "assessmentFrameworkShareRequest":{ "shape":"AssessmentFrameworkShareRequest", "documentation":"

The share request that's created by the `StartAssessmentFrameworkShare` API.

" } } }, "String":{ "type":"string", "max":2048, "min":0, "pattern":".*" }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":50, "min":1 }, "TagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "max":50, "min":0 }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"AuditManagerArn", "documentation":"

The Amazon Resource Name (ARN) of the resource.

", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"TagMap", "documentation":"

The tags that are associated with the resource.

" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":".{0,255}" }, "TestingInformation":{ "type":"string", "max":1000, "pattern":"^[\\w\\W\\s\\S]*$", "sensitive":true }, "ThrottlingException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The request was denied due to request throttling.

", "error":{"httpStatusCode":400}, "exception":true }, "Timestamp":{"type":"timestamp"}, "TimestampUUID":{ "type":"string", "max":50, "min":47, "pattern":"^[0-9]{10,13}_[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" }, "Token":{ "type":"string", "max":1000, "min":1, "pattern":"^[A-Za-z0-9+\\/=]*$" }, "TroubleshootingText":{ "type":"string", "max":1000, "pattern":"^[\\w\\W\\s\\S]*$", "sensitive":true }, "URL":{ "type":"structure", "members":{ "hyperlinkName":{ "shape":"HyperlinkName", "documentation":"

The name or word that's used as a hyperlink to the URL.

" }, "link":{ "shape":"UrlLink", "documentation":"

The unique identifier for the internet resource.

" } }, "documentation":"

Short for uniform resource locator. A URL is used as a unique identifier to locate a resource on the internet.

" }, "UUID":{ "type":"string", "max":36, "min":36, "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"AuditManagerArn", "documentation":"

The Amazon Resource Name (ARN) of the specified resource.

", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeyList", "documentation":"

The name or key of the tag.

", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateAssessmentControlRequest":{ "type":"structure", "required":[ "assessmentId", "controlSetId", "controlId" ], "members":{ "assessmentId":{ "shape":"UUID", "documentation":"

The unique identifier for the assessment.

", "location":"uri", "locationName":"assessmentId" }, "controlSetId":{ "shape":"ControlSetId", "documentation":"

The unique identifier for the control set.

", "location":"uri", "locationName":"controlSetId" }, "controlId":{ "shape":"UUID", "documentation":"

The unique identifier for the control.

", "location":"uri", "locationName":"controlId" }, "controlStatus":{ "shape":"ControlStatus", "documentation":"

The status of the control.

" }, "commentBody":{ "shape":"ControlCommentBody", "documentation":"

The comment body text for the control.

" } } }, "UpdateAssessmentControlResponse":{ "type":"structure", "members":{ "control":{ "shape":"AssessmentControl", "documentation":"

The name of the updated control set that the `UpdateAssessmentControl` API returned.

" } } }, "UpdateAssessmentControlSetStatusRequest":{ "type":"structure", "required":[ "assessmentId", "controlSetId", "status", "comment" ], "members":{ "assessmentId":{ "shape":"UUID", "documentation":"

The unique identifier for the assessment.

", "location":"uri", "locationName":"assessmentId" }, "controlSetId":{ "shape":"String", "documentation":"

The unique identifier for the control set.

", "location":"uri", "locationName":"controlSetId" }, "status":{ "shape":"ControlSetStatus", "documentation":"

The status of the control set that's being updated.

" }, "comment":{ "shape":"DelegationComment", "documentation":"

The comment that's related to the status update.

" } } }, "UpdateAssessmentControlSetStatusResponse":{ "type":"structure", "members":{ "controlSet":{ "shape":"AssessmentControlSet", "documentation":"

The name of the updated control set that the `UpdateAssessmentControlSetStatus` API returned.

" } } }, "UpdateAssessmentFrameworkControlSet":{ "type":"structure", "required":[ "name", "controls" ], "members":{ "id":{ "shape":"ControlSetName", "documentation":"

The unique identifier for the control set.

" }, "name":{ "shape":"ControlSetName", "documentation":"

The name of the control set.

" }, "controls":{ "shape":"CreateAssessmentFrameworkControls", "documentation":"

The list of controls that are contained within the control set.

" } }, "documentation":"

A `controlSet` entity that represents a collection of controls in Audit Manager. This doesn't contain the control set ID.

" }, "UpdateAssessmentFrameworkControlSets":{ "type":"list", "member":{"shape":"UpdateAssessmentFrameworkControlSet"}, "min":1 }, "UpdateAssessmentFrameworkRequest":{ "type":"structure", "required":[ "frameworkId", "name", "controlSets" ], "members":{ "frameworkId":{ "shape":"UUID", "documentation":"

The unique identifier for the framework.

", "location":"uri", "locationName":"frameworkId" }, "name":{ "shape":"FrameworkName", "documentation":"

The name of the framework to be updated.

" }, "description":{ "shape":"FrameworkDescription", "documentation":"

The description of the updated framework.

" }, "complianceType":{ "shape":"ComplianceType", "documentation":"

The compliance type that the new custom framework supports, such as CIS or HIPAA.

" }, "controlSets":{ "shape":"UpdateAssessmentFrameworkControlSets", "documentation":"

The control sets that are associated with the framework.

" } } }, "UpdateAssessmentFrameworkResponse":{ "type":"structure", "members":{ "framework":{ "shape":"Framework", "documentation":"

The name of the framework.

" } } }, "UpdateAssessmentFrameworkShareRequest":{ "type":"structure", "required":[ "requestId", "requestType", "action" ], "members":{ "requestId":{ "shape":"UUID", "documentation":"

The unique identifier for the share request.

", "location":"uri", "locationName":"requestId" }, "requestType":{ "shape":"ShareRequestType", "documentation":"

Specifies whether the share request is a sent request or a received request.

" }, "action":{ "shape":"ShareRequestAction", "documentation":"

Specifies the update action for the share request.

" } } }, "UpdateAssessmentFrameworkShareResponse":{ "type":"structure", "members":{ "assessmentFrameworkShareRequest":{ "shape":"AssessmentFrameworkShareRequest", "documentation":"

The updated share request that's returned by the `UpdateAssessmentFrameworkShare` operation.

" } } }, "UpdateAssessmentRequest":{ "type":"structure", "required":[ "assessmentId", "scope" ], "members":{ "assessmentId":{ "shape":"UUID", "documentation":"

The unique identifier for the assessment.

", "location":"uri", "locationName":"assessmentId" }, "assessmentName":{ "shape":"AssessmentName", "documentation":"

The name of the assessment to be updated.

" }, "assessmentDescription":{ "shape":"AssessmentDescription", "documentation":"

The description of the assessment.

" }, "scope":{ "shape":"Scope", "documentation":"

The scope of the assessment.

" }, "assessmentReportsDestination":{ "shape":"AssessmentReportsDestination", "documentation":"

The assessment report storage destination for the assessment that's being updated.

" }, "roles":{ "shape":"Roles", "documentation":"

The list of roles for the assessment.

" } } }, "UpdateAssessmentResponse":{ "type":"structure", "members":{ "assessment":{ "shape":"Assessment", "documentation":"

The response object for the `UpdateAssessment` API. This is the name of the updated assessment.

" } } }, "UpdateAssessmentStatusRequest":{ "type":"structure", "required":[ "assessmentId", "status" ], "members":{ "assessmentId":{ "shape":"UUID", "documentation":"

The unique identifier for the assessment.

", "location":"uri", "locationName":"assessmentId" }, "status":{ "shape":"AssessmentStatus", "documentation":"

The current status of the assessment.

" } } }, "UpdateAssessmentStatusResponse":{ "type":"structure", "members":{ "assessment":{ "shape":"Assessment", "documentation":"

The name of the updated assessment that the `UpdateAssessmentStatus` API returned.

" } } }, "UpdateControlRequest":{ "type":"structure", "required":[ "controlId", "name", "controlMappingSources" ], "members":{ "controlId":{ "shape":"UUID", "documentation":"

The identifier for the control.

", "location":"uri", "locationName":"controlId" }, "name":{ "shape":"ControlName", "documentation":"

The name of the updated control.

" }, "description":{ "shape":"ControlDescription", "documentation":"

The optional description of the control.

" }, "testingInformation":{ "shape":"TestingInformation", "documentation":"

The steps that you should follow to determine if the control is met.

" }, "actionPlanTitle":{ "shape":"ActionPlanTitle", "documentation":"

The title of the action plan for remediating the control.

" }, "actionPlanInstructions":{ "shape":"ActionPlanInstructions", "documentation":"

The recommended actions to carry out if the control isn't fulfilled.

" }, "controlMappingSources":{ "shape":"ControlMappingSources", "documentation":"

The data mapping sources for the control.

" } } }, "UpdateControlResponse":{ "type":"structure", "members":{ "control":{ "shape":"Control", "documentation":"

The name of the updated control set that the `UpdateControl` API returned.

" } } }, "UpdateSettingsRequest":{ "type":"structure", "members":{ "snsTopic":{ "shape":"SnsArn", "documentation":"

The Amazon Simple Notification Service (Amazon SNS) topic that Audit Manager sends notifications to.

" }, "defaultAssessmentReportsDestination":{ "shape":"AssessmentReportsDestination", "documentation":"

The default S3 destination bucket for storing assessment reports.

" }, "defaultProcessOwners":{ "shape":"Roles", "documentation":"

A list of the default audit owners.

" }, "kmsKey":{ "shape":"KmsKey", "documentation":"

The KMS key details.

" }, "evidenceFinderEnabled":{ "shape":"Boolean", "documentation":"

Specifies whether the evidence finder feature is enabled. Change this attribute to enable or disable evidence finder.

When you use this attribute to disable evidence finder, Audit Manager deletes the event data store that’s used to query your evidence data. As a result, you can’t re-enable evidence finder and use the feature again. Your only alternative is to deregister and then re-register Audit Manager.

" }, "deregistrationPolicy":{ "shape":"DeregistrationPolicy", "documentation":"

The deregistration policy for your Audit Manager data. You can use this attribute to determine how your data is handled when you deregister Audit Manager.

" }, "defaultExportDestination":{ "shape":"DefaultExportDestination", "documentation":"

The default S3 destination bucket for storing evidence finder exports.

" } } }, "UpdateSettingsResponse":{ "type":"structure", "members":{ "settings":{ "shape":"Settings", "documentation":"

The current list of settings.

" } } }, "UrlLink":{ "type":"string", "max":8192, "min":1, "pattern":"^(https?:\\/\\/)?(www\\.)?[a-zA-Z0-9-_]+([\\.]+[a-zA-Z]+)+[\\/\\w]*$" }, "Username":{ "type":"string", "max":128, "min":1, "pattern":"^[a-zA-Z0-9-_()\\s\\+=,.@]+$", "sensitive":true }, "ValidateAssessmentReportIntegrityRequest":{ "type":"structure", "required":["s3RelativePath"], "members":{ "s3RelativePath":{ "shape":"S3Url", "documentation":"

The relative path of the Amazon S3 bucket that the assessment report is stored in.

" } } }, "ValidateAssessmentReportIntegrityResponse":{ "type":"structure", "members":{ "signatureValid":{ "shape":"Boolean", "documentation":"

Specifies whether the signature key is valid.

" }, "signatureAlgorithm":{ "shape":"String", "documentation":"

The signature algorithm that's used to code sign the assessment report file.

" }, "signatureDateTime":{ "shape":"String", "documentation":"

The date and time signature that specifies when the assessment report was created.

" }, "signatureKeyId":{ "shape":"String", "documentation":"

The unique identifier for the validation signature key.

" }, "validationErrors":{ "shape":"ValidationErrors", "documentation":"

Represents any errors that occurred when validating the assessment report.

" } } }, "ValidationErrors":{ "type":"list", "member":{"shape":"NonEmptyString"} }, "ValidationException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"}, "reason":{ "shape":"ValidationExceptionReason", "documentation":"

The reason the request failed validation.

" }, "fields":{ "shape":"ValidationExceptionFieldList", "documentation":"

The fields that caused the error, if applicable.

" } }, "documentation":"

The request has invalid or missing parameters.

", "error":{"httpStatusCode":400}, "exception":true }, "ValidationExceptionField":{ "type":"structure", "required":[ "name", "message" ], "members":{ "name":{ "shape":"String", "documentation":"

The name of the validation error.

" }, "message":{ "shape":"String", "documentation":"

The body of the error message.

" } }, "documentation":"

Indicates that the request has invalid or missing parameters for the field.

" }, "ValidationExceptionFieldList":{ "type":"list", "member":{"shape":"ValidationExceptionField"} }, "ValidationExceptionReason":{ "type":"string", "enum":[ "unknownOperation", "cannotParse", "fieldValidationFailed", "other" ] }, "organizationId":{ "type":"string", "max":34, "min":12, "pattern":"o-[a-z0-9]{10,32}" } }, "documentation":"

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.

" }