# Actions The following actions are supported: + [AssociateAssessmentReportEvidenceFolder](API_AssociateAssessmentReportEvidenceFolder.md) + [BatchAssociateAssessmentReportEvidence](API_BatchAssociateAssessmentReportEvidence.md) + [BatchCreateDelegationByAssessment](API_BatchCreateDelegationByAssessment.md) + [BatchDeleteDelegationByAssessment](API_BatchDeleteDelegationByAssessment.md) + [BatchDisassociateAssessmentReportEvidence](API_BatchDisassociateAssessmentReportEvidence.md) + [BatchImportEvidenceToAssessmentControl](API_BatchImportEvidenceToAssessmentControl.md) + [CreateAssessment](API_CreateAssessment.md) + [CreateAssessmentFramework](API_CreateAssessmentFramework.md) + [CreateAssessmentReport](API_CreateAssessmentReport.md) + [CreateControl](API_CreateControl.md) + [DeleteAssessment](API_DeleteAssessment.md) + [DeleteAssessmentFramework](API_DeleteAssessmentFramework.md) + [DeleteAssessmentFrameworkShare](API_DeleteAssessmentFrameworkShare.md) + [DeleteAssessmentReport](API_DeleteAssessmentReport.md) + [DeleteControl](API_DeleteControl.md) + [DeregisterAccount](API_DeregisterAccount.md) + [DeregisterOrganizationAdminAccount](API_DeregisterOrganizationAdminAccount.md) + [DisassociateAssessmentReportEvidenceFolder](API_DisassociateAssessmentReportEvidenceFolder.md) + [GetAccountStatus](API_GetAccountStatus.md) + [GetAssessment](API_GetAssessment.md) + [GetAssessmentFramework](API_GetAssessmentFramework.md) + [GetAssessmentReportUrl](API_GetAssessmentReportUrl.md) + [GetChangeLogs](API_GetChangeLogs.md) + [GetControl](API_GetControl.md) + [GetDelegations](API_GetDelegations.md) + [GetEvidence](API_GetEvidence.md) + [GetEvidenceByEvidenceFolder](API_GetEvidenceByEvidenceFolder.md) + [GetEvidenceFileUploadUrl](API_GetEvidenceFileUploadUrl.md) + [GetEvidenceFolder](API_GetEvidenceFolder.md) + [GetEvidenceFoldersByAssessment](API_GetEvidenceFoldersByAssessment.md) + [GetEvidenceFoldersByAssessmentControl](API_GetEvidenceFoldersByAssessmentControl.md) + [GetInsights](API_GetInsights.md) + [GetInsightsByAssessment](API_GetInsightsByAssessment.md) + [GetOrganizationAdminAccount](API_GetOrganizationAdminAccount.md) + [GetServicesInScope](API_GetServicesInScope.md) + [GetSettings](API_GetSettings.md) + [ListAssessmentControlInsightsByControlDomain](API_ListAssessmentControlInsightsByControlDomain.md) + [ListAssessmentFrameworks](API_ListAssessmentFrameworks.md) + [ListAssessmentFrameworkShareRequests](API_ListAssessmentFrameworkShareRequests.md) + [ListAssessmentReports](API_ListAssessmentReports.md) + [ListAssessments](API_ListAssessments.md) + [ListControlDomainInsights](API_ListControlDomainInsights.md) + [ListControlDomainInsightsByAssessment](API_ListControlDomainInsightsByAssessment.md) + [ListControlInsightsByControlDomain](API_ListControlInsightsByControlDomain.md) + [ListControls](API_ListControls.md) + [ListKeywordsForDataSource](API_ListKeywordsForDataSource.md) + [ListNotifications](API_ListNotifications.md) + [ListTagsForResource](API_ListTagsForResource.md) + [RegisterAccount](API_RegisterAccount.md) + [RegisterOrganizationAdminAccount](API_RegisterOrganizationAdminAccount.md) + [StartAssessmentFrameworkShare](API_StartAssessmentFrameworkShare.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) + [UpdateAssessment](API_UpdateAssessment.md) + [UpdateAssessmentControl](API_UpdateAssessmentControl.md) + [UpdateAssessmentControlSetStatus](API_UpdateAssessmentControlSetStatus.md) + [UpdateAssessmentFramework](API_UpdateAssessmentFramework.md) + [UpdateAssessmentFrameworkShare](API_UpdateAssessmentFrameworkShare.md) + [UpdateAssessmentStatus](API_UpdateAssessmentStatus.md) + [UpdateControl](API_UpdateControl.md) + [UpdateSettings](API_UpdateSettings.md) + [ValidateAssessmentReportIntegrity](API_ValidateAssessmentReportIntegrity.md) # AssociateAssessmentReportEvidenceFolder **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Associates an evidence folder to an assessment report in an Audit Manager assessment. ## Request Syntax ``` PUT /assessments/assessmentId/associateToAssessmentReport HTTP/1.1 Content-type: application/json { "evidenceFolderId": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_AssociateAssessmentReportEvidenceFolder_RequestSyntax) ** The identifier for the assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [evidenceFolderId](#API_AssociateAssessmentReportEvidenceFolder_RequestSyntax) ** The identifier for the folder that the evidence is stored in. Type: String Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/AssociateAssessmentReportEvidenceFolder) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/AssociateAssessmentReportEvidenceFolder) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/AssociateAssessmentReportEvidenceFolder) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/AssociateAssessmentReportEvidenceFolder) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/AssociateAssessmentReportEvidenceFolder) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/AssociateAssessmentReportEvidenceFolder) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/AssociateAssessmentReportEvidenceFolder) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/AssociateAssessmentReportEvidenceFolder) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/AssociateAssessmentReportEvidenceFolder) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/AssociateAssessmentReportEvidenceFolder) # BatchAssociateAssessmentReportEvidence **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Associates a list of evidence to an assessment report in an Audit Manager assessment. ## Request Syntax ``` PUT /assessments/assessmentId/batchAssociateToAssessmentReport HTTP/1.1 Content-type: application/json { "evidenceFolderId": "string", "evidenceIds": [ "string" ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_BatchAssociateAssessmentReportEvidence_RequestSyntax) ** The identifier for the assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [evidenceFolderId](#API_BatchAssociateAssessmentReportEvidence_RequestSyntax) ** The identifier for the folder that the evidence is stored in. Type: String Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [evidenceIds](#API_BatchAssociateAssessmentReportEvidence_RequestSyntax) ** The list of evidence identifiers. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 50 items. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "errors": [ { "errorCode": "string", "errorMessage": "string", "evidenceId": "string" } ], "evidenceIds": [ "string" ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [errors](#API_BatchAssociateAssessmentReportEvidence_ResponseSyntax) ** A list of errors that the `BatchAssociateAssessmentReportEvidence` API returned. Type: Array of [AssessmentReportEvidenceError](API_AssessmentReportEvidenceError.md) objects ** [evidenceIds](#API_BatchAssociateAssessmentReportEvidence_ResponseSyntax) ** The list of evidence identifiers. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 50 items. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/BatchAssociateAssessmentReportEvidence) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/BatchAssociateAssessmentReportEvidence) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/BatchAssociateAssessmentReportEvidence) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/BatchAssociateAssessmentReportEvidence) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/BatchAssociateAssessmentReportEvidence) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/BatchAssociateAssessmentReportEvidence) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/BatchAssociateAssessmentReportEvidence) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/BatchAssociateAssessmentReportEvidence) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/BatchAssociateAssessmentReportEvidence) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/BatchAssociateAssessmentReportEvidence) # BatchCreateDelegationByAssessment **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Creates a batch of delegations for an assessment in AWS Audit Manager. ## Request Syntax ``` POST /assessments/assessmentId/delegations HTTP/1.1 Content-type: application/json { "createDelegationRequests": [ { "comment": "string", "controlSetId": "string", "roleArn": "string", "roleType": "string" } ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_BatchCreateDelegationByAssessment_RequestSyntax) ** The identifier for the assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [createDelegationRequests](#API_BatchCreateDelegationByAssessment_RequestSyntax) ** The API request to batch create delegations in Audit Manager. Type: Array of [CreateDelegationRequest](API_CreateDelegationRequest.md) objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "delegations": [ { "assessmentId": "string", "assessmentName": "string", "comment": "string", "controlSetId": "string", "createdBy": "string", "creationTime": number, "id": "string", "lastUpdated": number, "roleArn": "string", "roleType": "string", "status": "string" } ], "errors": [ { "createDelegationRequest": { "comment": "string", "controlSetId": "string", "roleArn": "string", "roleType": "string" }, "errorCode": "string", "errorMessage": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [delegations](#API_BatchCreateDelegationByAssessment_ResponseSyntax) ** The delegations that are associated with the assessment. Type: Array of [Delegation](API_Delegation.md) objects ** [errors](#API_BatchCreateDelegationByAssessment_ResponseSyntax) ** A list of errors that the `BatchCreateDelegationByAssessment` API returned. Type: Array of [BatchCreateDelegationByAssessmentError](API_BatchCreateDelegationByAssessmentError.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/BatchCreateDelegationByAssessment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/BatchCreateDelegationByAssessment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/BatchCreateDelegationByAssessment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/BatchCreateDelegationByAssessment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/BatchCreateDelegationByAssessment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/BatchCreateDelegationByAssessment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/BatchCreateDelegationByAssessment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/BatchCreateDelegationByAssessment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/BatchCreateDelegationByAssessment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/BatchCreateDelegationByAssessment) # BatchDeleteDelegationByAssessment **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Deletes a batch of delegations for an assessment in AWS Audit Manager. ## Request Syntax ``` PUT /assessments/assessmentId/delegations HTTP/1.1 Content-type: application/json { "delegationIds": [ "string" ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_BatchDeleteDelegationByAssessment_RequestSyntax) ** The identifier for the assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [delegationIds](#API_BatchDeleteDelegationByAssessment_RequestSyntax) ** The identifiers for the delegations. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 50 items. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "errors": [ { "delegationId": "string", "errorCode": "string", "errorMessage": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [errors](#API_BatchDeleteDelegationByAssessment_ResponseSyntax) ** A list of errors that the `BatchDeleteDelegationByAssessment` API returned. Type: Array of [BatchDeleteDelegationByAssessmentError](API_BatchDeleteDelegationByAssessmentError.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/BatchDeleteDelegationByAssessment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/BatchDeleteDelegationByAssessment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/BatchDeleteDelegationByAssessment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/BatchDeleteDelegationByAssessment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/BatchDeleteDelegationByAssessment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/BatchDeleteDelegationByAssessment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/BatchDeleteDelegationByAssessment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/BatchDeleteDelegationByAssessment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/BatchDeleteDelegationByAssessment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/BatchDeleteDelegationByAssessment) # BatchDisassociateAssessmentReportEvidence **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Disassociates a list of evidence from an assessment report in AWS Audit Manager. ## Request Syntax ``` PUT /assessments/assessmentId/batchDisassociateFromAssessmentReport HTTP/1.1 Content-type: application/json { "evidenceFolderId": "string", "evidenceIds": [ "string" ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_BatchDisassociateAssessmentReportEvidence_RequestSyntax) ** The identifier for the assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [evidenceFolderId](#API_BatchDisassociateAssessmentReportEvidence_RequestSyntax) ** The identifier for the folder that the evidence is stored in. Type: String Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [evidenceIds](#API_BatchDisassociateAssessmentReportEvidence_RequestSyntax) ** The list of evidence identifiers. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 50 items. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "errors": [ { "errorCode": "string", "errorMessage": "string", "evidenceId": "string" } ], "evidenceIds": [ "string" ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [errors](#API_BatchDisassociateAssessmentReportEvidence_ResponseSyntax) ** A list of errors that the `BatchDisassociateAssessmentReportEvidence` API returned. Type: Array of [AssessmentReportEvidenceError](API_AssessmentReportEvidenceError.md) objects ** [evidenceIds](#API_BatchDisassociateAssessmentReportEvidence_ResponseSyntax) ** The identifier for the evidence. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 50 items. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/BatchDisassociateAssessmentReportEvidence) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/BatchDisassociateAssessmentReportEvidence) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/BatchDisassociateAssessmentReportEvidence) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/BatchDisassociateAssessmentReportEvidence) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/BatchDisassociateAssessmentReportEvidence) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/BatchDisassociateAssessmentReportEvidence) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/BatchDisassociateAssessmentReportEvidence) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/BatchDisassociateAssessmentReportEvidence) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/BatchDisassociateAssessmentReportEvidence) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/BatchDisassociateAssessmentReportEvidence) # BatchImportEvidenceToAssessmentControl **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). 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](https://docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#supported-manual-evidence-files) in the * AWS Audit Manager User Guide* For more information about Audit Manager service restrictions, see [Quotas and restrictions for AWS Audit Manager](https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html). ## Request Syntax ``` POST /assessments/assessmentId/controlSets/controlSetId/controls/controlId/evidence HTTP/1.1 Content-type: application/json { "manualEvidence": [ { "evidenceFileName": "string", "s3ResourcePath": "string", "textResponse": "string" } ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_BatchImportEvidenceToAssessmentControl_RequestSyntax) ** The identifier for the assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [controlId](#API_BatchImportEvidenceToAssessmentControl_RequestSyntax) ** The identifier for the control. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [controlSetId](#API_BatchImportEvidenceToAssessmentControl_RequestSyntax) ** The identifier for the control set. Length Constraints: Minimum length of 1. Maximum length of 300. Pattern: `^[\w\W\s\S]*$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [manualEvidence](#API_BatchImportEvidenceToAssessmentControl_RequestSyntax) ** The list of manual evidence objects. Type: Array of [ManualEvidence](API_ManualEvidence.md) objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "errors": [ { "errorCode": "string", "errorMessage": "string", "manualEvidence": { "evidenceFileName": "string", "s3ResourcePath": "string", "textResponse": "string" } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [errors](#API_BatchImportEvidenceToAssessmentControl_ResponseSyntax) ** A list of errors that the `BatchImportEvidenceToAssessmentControl` API returned. Type: Array of [BatchImportEvidenceToAssessmentControlError](API_BatchImportEvidenceToAssessmentControlError.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ThrottlingException ** The request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/BatchImportEvidenceToAssessmentControl) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/BatchImportEvidenceToAssessmentControl) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/BatchImportEvidenceToAssessmentControl) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/BatchImportEvidenceToAssessmentControl) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/BatchImportEvidenceToAssessmentControl) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/BatchImportEvidenceToAssessmentControl) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/BatchImportEvidenceToAssessmentControl) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/BatchImportEvidenceToAssessmentControl) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/BatchImportEvidenceToAssessmentControl) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/BatchImportEvidenceToAssessmentControl) # CreateAssessment **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Creates an assessment in AWS Audit Manager. ## Request Syntax ``` POST /assessments HTTP/1.1 Content-type: application/json { "assessmentReportsDestination": { "destination": "string", "destinationType": "string" }, "description": "string", "frameworkId": "string", "name": "string", "roles": [ { "roleArn": "string", "roleType": "string" } ], "scope": { "awsAccounts": [ { "emailAddress": "string", "id": "string", "name": "string" } ], "awsServices": [ { "serviceName": "string" } ] }, "tags": { "string" : "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [assessmentReportsDestination](#API_CreateAssessment_RequestSyntax) ** The assessment report storage destination for the assessment that's being created. Type: [AssessmentReportsDestination](API_AssessmentReportsDestination.md) object Required: Yes ** [description](#API_CreateAssessment_RequestSyntax) ** The optional description of the assessment to be created. Type: String Length Constraints: Maximum length of 1000. Pattern: `^[\w\W\s\S]*$` Required: No ** [frameworkId](#API_CreateAssessment_RequestSyntax) ** The identifier for the framework that the assessment will be created from. Type: String Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [name](#API_CreateAssessment_RequestSyntax) ** The name of the assessment to be created. Type: String Length Constraints: Minimum length of 1. Maximum length of 300. Pattern: `^[^\\]*$` Required: Yes ** [roles](#API_CreateAssessment_RequestSyntax) ** The list of roles for the assessment. Type: Array of [Role](API_Role.md) objects Required: Yes ** [scope](#API_CreateAssessment_RequestSyntax) ** The wrapper that contains the AWS accounts that are in scope for the assessment. You no longer need to specify which AWS services are in scope when you create or update an assessment. Audit Manager infers the services in scope by examining your assessment controls and their data sources, and then mapping this information to the relevant AWS services. If an underlying data source changes for your assessment, we automatically update the services scope as needed to reflect the correct AWS services. This ensures that your assessment collects accurate and comprehensive evidence about all of the relevant services in your AWS environment. Type: [Scope](API_Scope.md) object Required: Yes ** [tags](#API_CreateAssessment_RequestSyntax) ** The tags that are associated with the assessment. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `.{0,255}` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "assessment": { "arn": "string", "awsAccount": { "emailAddress": "string", "id": "string", "name": "string" }, "framework": { "arn": "string", "controlSets": [ { "controls": [ { "assessmentReportEvidenceCount": number, "comments": [ { "authorName": "string", "commentBody": "string", "postedDate": number } ], "description": "string", "evidenceCount": number, "evidenceSources": [ "string" ], "id": "string", "name": "string", "response": "string", "status": "string" } ], "delegations": [ { "assessmentId": "string", "assessmentName": "string", "comment": "string", "controlSetId": "string", "createdBy": "string", "creationTime": number, "id": "string", "lastUpdated": number, "roleArn": "string", "roleType": "string", "status": "string" } ], "description": "string", "id": "string", "manualEvidenceCount": number, "roles": [ { "roleArn": "string", "roleType": "string" } ], "status": "string", "systemEvidenceCount": number } ], "id": "string", "metadata": { "complianceType": "string", "description": "string", "logo": "string", "name": "string" } }, "metadata": { "assessmentReportsDestination": { "destination": "string", "destinationType": "string" }, "complianceType": "string", "creationTime": number, "delegations": [ { "assessmentId": "string", "assessmentName": "string", "comment": "string", "controlSetId": "string", "createdBy": "string", "creationTime": number, "id": "string", "lastUpdated": number, "roleArn": "string", "roleType": "string", "status": "string" } ], "description": "string", "id": "string", "lastUpdated": number, "name": "string", "roles": [ { "roleArn": "string", "roleType": "string" } ], "scope": { "awsAccounts": [ { "emailAddress": "string", "id": "string", "name": "string" } ], "awsServices": [ { "serviceName": "string" } ] }, "status": "string" }, "tags": { "string" : "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [assessment](#API_CreateAssessment_ResponseSyntax) ** An entity that defines the scope of audit evidence collected by AWS Audit Manager. An Audit Manager assessment is an implementation of an Audit Manager framework. Type: [Assessment](API_Assessment.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ServiceQuotaExceededException ** You've reached your account quota for this resource type. To perform the requested action, delete some existing resources or [request a quota increase](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) from the Service Quotas console. For a list of Audit Manager service quotas, see [Quotas and restrictions for AWS Audit Manager](https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html). HTTP Status Code: 402 ** ThrottlingException ** The request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/CreateAssessment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/CreateAssessment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/CreateAssessment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/CreateAssessment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/CreateAssessment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/CreateAssessment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/CreateAssessment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/CreateAssessment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/CreateAssessment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/CreateAssessment) # CreateAssessmentFramework **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Creates a custom framework in AWS Audit Manager. ## Request Syntax ``` POST /assessmentFrameworks HTTP/1.1 Content-type: application/json { "complianceType": "string", "controlSets": [ { "controls": [ { "id": "string" } ], "name": "string" } ], "description": "string", "name": "string", "tags": { "string" : "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [complianceType](#API_CreateAssessmentFramework_RequestSyntax) ** The compliance type that the new custom framework supports, such as CIS or HIPAA. Type: String Length Constraints: Maximum length of 100. Pattern: `^[\w\W\s\S]*$` Required: No ** [controlSets](#API_CreateAssessmentFramework_RequestSyntax) ** The control sets that are associated with the framework. The `Controls` object returns a partial response when called through Framework APIs. For a complete `Controls` object, use `GetControl`. Type: Array of [CreateAssessmentFrameworkControlSet](API_CreateAssessmentFrameworkControlSet.md) objects Array Members: Minimum number of 1 item. Required: Yes ** [description](#API_CreateAssessmentFramework_RequestSyntax) ** An optional description for the new custom framework. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[\w\W\s\S]*$` Required: No ** [name](#API_CreateAssessmentFramework_RequestSyntax) ** The name of the new custom framework. Type: String Length Constraints: Minimum length of 1. Maximum length of 300. Pattern: `^[^\\]*$` Required: Yes ** [tags](#API_CreateAssessmentFramework_RequestSyntax) ** The tags that are associated with the framework. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `.{0,255}` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "framework": { "arn": "string", "complianceType": "string", "controlSets": [ { "controls": [ { "actionPlanInstructions": "string", "actionPlanTitle": "string", "arn": "string", "controlMappingSources": [ { "sourceDescription": "string", "sourceFrequency": "string", "sourceId": "string", "sourceKeyword": { "keywordInputType": "string", "keywordValue": "string" }, "sourceName": "string", "sourceSetUpOption": "string", "sourceType": "string", "troubleshootingText": "string" } ], "controlSources": "string", "createdAt": number, "createdBy": "string", "description": "string", "id": "string", "lastUpdatedAt": number, "lastUpdatedBy": "string", "name": "string", "state": "string", "tags": { "string" : "string" }, "testingInformation": "string", "type": "string" } ], "id": "string", "name": "string" } ], "controlSources": "string", "createdAt": number, "createdBy": "string", "description": "string", "id": "string", "lastUpdatedAt": number, "lastUpdatedBy": "string", "logo": "string", "name": "string", "tags": { "string" : "string" }, "type": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [framework](#API_CreateAssessmentFramework_ResponseSyntax) ** The new framework object that the `CreateAssessmentFramework` API returned. Type: [Framework](API_Framework.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ServiceQuotaExceededException ** You've reached your account quota for this resource type. To perform the requested action, delete some existing resources or [request a quota increase](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) from the Service Quotas console. For a list of Audit Manager service quotas, see [Quotas and restrictions for AWS Audit Manager](https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html). HTTP Status Code: 402 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/CreateAssessmentFramework) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/CreateAssessmentFramework) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/CreateAssessmentFramework) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/CreateAssessmentFramework) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/CreateAssessmentFramework) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/CreateAssessmentFramework) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/CreateAssessmentFramework) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/CreateAssessmentFramework) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/CreateAssessmentFramework) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/CreateAssessmentFramework) # CreateAssessmentReport **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Creates an assessment report for the specified assessment. ## Request Syntax ``` POST /assessments/assessmentId/reports HTTP/1.1 Content-type: application/json { "description": "string", "name": "string", "queryStatement": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_CreateAssessmentReport_RequestSyntax) ** The identifier for the assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [description](#API_CreateAssessmentReport_RequestSyntax) ** The description of the assessment report. Type: String Length Constraints: Maximum length of 1000. Pattern: `^[\w\W\s\S]*$` Required: No ** [name](#API_CreateAssessmentReport_RequestSyntax) ** The name of the new assessment report. Type: String Length Constraints: Minimum length of 1. Maximum length of 300. Pattern: `^[a-zA-Z0-9-_\.]+$` Required: Yes ** [queryStatement](#API_CreateAssessmentReport_RequestSyntax) ** 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](https://docs.aws.amazon.com/audit-manager/latest/userguide/generate-assessment-report.html#generate-assessment-report-include-evidence), or [associated with a report using the API](https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_BatchAssociateAssessmentReportEvidence.html). To use this parameter, the [enablementStatus](https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_EvidenceFinderEnablement.html#auditmanager-Type-EvidenceFinderEnablement-enablementStatus) of evidence finder must be `ENABLED`. For examples and help resolving `queryStatement` validation exceptions, see [Troubleshooting evidence finder issues](https://docs.aws.amazon.com/audit-manager/latest/userguide/evidence-finder-issues.html#querystatement-exceptions) in the * AWS Audit Manager User Guide.* Type: String Length Constraints: Minimum length of 1. Maximum length of 10000. Pattern: `(?s).*` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "assessmentReport": { "assessmentId": "string", "assessmentName": "string", "author": "string", "awsAccountId": "string", "creationTime": number, "description": "string", "id": "string", "name": "string", "status": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [assessmentReport](#API_CreateAssessmentReport_ResponseSyntax) ** The new assessment report that the `CreateAssessmentReport` API returned. Type: [AssessmentReport](API_AssessmentReport.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/CreateAssessmentReport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/CreateAssessmentReport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/CreateAssessmentReport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/CreateAssessmentReport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/CreateAssessmentReport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/CreateAssessmentReport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/CreateAssessmentReport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/CreateAssessmentReport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/CreateAssessmentReport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/CreateAssessmentReport) # CreateControl **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Creates a new custom control in AWS Audit Manager. ## Request Syntax ``` POST /controls HTTP/1.1 Content-type: application/json { "actionPlanInstructions": "string", "actionPlanTitle": "string", "controlMappingSources": [ { "sourceDescription": "string", "sourceFrequency": "string", "sourceKeyword": { "keywordInputType": "string", "keywordValue": "string" }, "sourceName": "string", "sourceSetUpOption": "string", "sourceType": "string", "troubleshootingText": "string" } ], "description": "string", "name": "string", "tags": { "string" : "string" }, "testingInformation": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [actionPlanInstructions](#API_CreateControl_RequestSyntax) ** The recommended actions to carry out if the control isn't fulfilled. Type: String Length Constraints: Maximum length of 1000. Pattern: `^[\w\W\s\S]*$` Required: No ** [actionPlanTitle](#API_CreateControl_RequestSyntax) ** The title of the action plan for remediating the control. Type: String Length Constraints: Maximum length of 300. Pattern: `^[\w\W\s\S]*$` Required: No ** [controlMappingSources](#API_CreateControl_RequestSyntax) ** The data mapping sources for the control. Type: Array of [CreateControlMappingSource](API_CreateControlMappingSource.md) objects Array Members: Minimum number of 1 item. Required: Yes ** [description](#API_CreateControl_RequestSyntax) ** The description of the control. Type: String Length Constraints: Maximum length of 1000. Pattern: `^[\w\W\s\S]*$` Required: No ** [name](#API_CreateControl_RequestSyntax) ** The name of the control. Type: String Length Constraints: Minimum length of 1. Maximum length of 300. Pattern: `^[^\\]*$` Required: Yes ** [tags](#API_CreateControl_RequestSyntax) ** The tags that are associated with the control. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `.{0,255}` Required: No ** [testingInformation](#API_CreateControl_RequestSyntax) ** The steps to follow to determine if the control is satisfied. Type: String Length Constraints: Maximum length of 1000. Pattern: `^[\w\W\s\S]*$` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "control": { "actionPlanInstructions": "string", "actionPlanTitle": "string", "arn": "string", "controlMappingSources": [ { "sourceDescription": "string", "sourceFrequency": "string", "sourceId": "string", "sourceKeyword": { "keywordInputType": "string", "keywordValue": "string" }, "sourceName": "string", "sourceSetUpOption": "string", "sourceType": "string", "troubleshootingText": "string" } ], "controlSources": "string", "createdAt": number, "createdBy": "string", "description": "string", "id": "string", "lastUpdatedAt": number, "lastUpdatedBy": "string", "name": "string", "state": "string", "tags": { "string" : "string" }, "testingInformation": "string", "type": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [control](#API_CreateControl_ResponseSyntax) ** The new control that the `CreateControl` API returned. Type: [Control](API_Control.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ServiceQuotaExceededException ** You've reached your account quota for this resource type. To perform the requested action, delete some existing resources or [request a quota increase](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) from the Service Quotas console. For a list of Audit Manager service quotas, see [Quotas and restrictions for AWS Audit Manager](https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html). HTTP Status Code: 402 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/CreateControl) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/CreateControl) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/CreateControl) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/CreateControl) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/CreateControl) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/CreateControl) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/CreateControl) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/CreateControl) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/CreateControl) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/CreateControl) # DeleteAssessment **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Deletes an assessment in AWS Audit Manager. ## Request Syntax ``` DELETE /assessments/assessmentId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_DeleteAssessment_RequestSyntax) ** The identifier for the assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/DeleteAssessment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/DeleteAssessment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/DeleteAssessment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/DeleteAssessment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/DeleteAssessment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/DeleteAssessment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/DeleteAssessment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/DeleteAssessment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/DeleteAssessment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/DeleteAssessment) # DeleteAssessmentFramework **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Deletes a custom framework in AWS Audit Manager. ## Request Syntax ``` DELETE /assessmentFrameworks/frameworkId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [frameworkId](#API_DeleteAssessmentFramework_RequestSyntax) ** The identifier for the custom framework. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/DeleteAssessmentFramework) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/DeleteAssessmentFramework) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/DeleteAssessmentFramework) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/DeleteAssessmentFramework) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/DeleteAssessmentFramework) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/DeleteAssessmentFramework) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/DeleteAssessmentFramework) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/DeleteAssessmentFramework) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/DeleteAssessmentFramework) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/DeleteAssessmentFramework) # DeleteAssessmentFrameworkShare **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Deletes a share request for a custom framework in AWS Audit Manager. ## Request Syntax ``` DELETE /assessmentFrameworkShareRequests/requestId?requestType=requestType HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [requestId](#API_DeleteAssessmentFrameworkShare_RequestSyntax) ** The unique identifier for the share request to be deleted. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [requestType](#API_DeleteAssessmentFrameworkShare_RequestSyntax) ** Specifies whether the share request is a sent request or a received request. Valid Values: `SENT | RECEIVED` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/DeleteAssessmentFrameworkShare) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/DeleteAssessmentFrameworkShare) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/DeleteAssessmentFrameworkShare) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/DeleteAssessmentFrameworkShare) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/DeleteAssessmentFrameworkShare) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/DeleteAssessmentFrameworkShare) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/DeleteAssessmentFrameworkShare) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/DeleteAssessmentFrameworkShare) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/DeleteAssessmentFrameworkShare) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/DeleteAssessmentFrameworkShare) # DeleteAssessmentReport **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Deletes an assessment report in AWS 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 1. 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](https://docs.aws.amazon.com/audit-manager/latest/userguide/security_iam_id-based-policy-examples.html#full-administrator-access-assessment-report-destination) in the * AWS 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](https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList) in the *Amazon Simple Storage Service API Reference*. ## Request Syntax ``` DELETE /assessments/assessmentId/reports/assessmentReportId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_DeleteAssessmentReport_RequestSyntax) ** The unique identifier for the assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [assessmentReportId](#API_DeleteAssessmentReport_RequestSyntax) ** The unique identifier for the assessment report. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/DeleteAssessmentReport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/DeleteAssessmentReport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/DeleteAssessmentReport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/DeleteAssessmentReport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/DeleteAssessmentReport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/DeleteAssessmentReport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/DeleteAssessmentReport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/DeleteAssessmentReport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/DeleteAssessmentReport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/DeleteAssessmentReport) # DeleteControl **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Deletes a custom control in AWS Audit Manager. **Important** 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. ## Request Syntax ``` DELETE /controls/controlId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [controlId](#API_DeleteControl_RequestSyntax) ** The unique identifier for the control. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/DeleteControl) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/DeleteControl) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/DeleteControl) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/DeleteControl) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/DeleteControl) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/DeleteControl) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/DeleteControl) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/DeleteControl) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/DeleteControl) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/DeleteControl) # DeregisterAccount **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Deregisters an account in AWS Audit Manager. **Note** Before you deregister, you can use the [UpdateSettings](https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_UpdateSettings.html) 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](https://docs.aws.amazon.com/audit-manager/latest/userguide/data-protection.html) in the * AWS Audit Manager User Guide*. ## Request Syntax ``` POST /account/deregisterAccount HTTP/1.1 ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [status](#API_DeregisterAccount_ResponseSyntax) ** The registration status of the account. Type: String Valid Values: `ACTIVE | INACTIVE | PENDING_ACTIVATION` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/DeregisterAccount) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/DeregisterAccount) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/DeregisterAccount) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/DeregisterAccount) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/DeregisterAccount) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/DeregisterAccount) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/DeregisterAccount) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/DeregisterAccount) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/DeregisterAccount) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/DeregisterAccount) # DeregisterOrganizationAdminAccount **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Removes the specified AWS account as a delegated administrator for AWS 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 AWS Organizations. However, Audit Manager stops collecting and attaching evidence to that delegated administrator account moving forward. **Important** 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](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-eds-disable-termination.html). 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](https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessment.html) (see also: [Deleting an assessment](https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-assessment.html) in the * AWS Audit Manager User Guide*) + [DeleteAssessmentFramework](https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFramework.html) (see also: [Deleting a custom framework](https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-custom-framework.html) in the * AWS Audit Manager User Guide*) + [DeleteAssessmentFrameworkShare](https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFrameworkShare.html) (see also: [Deleting a share request](https://docs.aws.amazon.com/audit-manager/latest/userguide/deleting-shared-framework-requests.html) in the * AWS Audit Manager User Guide*) + [DeleteAssessmentReport](https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentReport.html) (see also: [Deleting an assessment report](https://docs.aws.amazon.com/audit-manager/latest/userguide/generate-assessment-report.html#delete-assessment-report-steps) in the * AWS Audit Manager User Guide*) + [DeleteControl](https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteControl.html) (see also: [Deleting a custom control](https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-controls.html) in the * AWS 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. ## Request Syntax ``` POST /account/deregisterOrganizationAdminAccount HTTP/1.1 Content-type: application/json { "adminAccountId": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [adminAccountId](#API_DeregisterOrganizationAdminAccount_RequestSyntax) ** The identifier for the administrator account. Type: String Length Constraints: Fixed length of 12. Pattern: `^[0-9]{12}$` Required: No ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/DeregisterOrganizationAdminAccount) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/DeregisterOrganizationAdminAccount) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/DeregisterOrganizationAdminAccount) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/DeregisterOrganizationAdminAccount) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/DeregisterOrganizationAdminAccount) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/DeregisterOrganizationAdminAccount) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/DeregisterOrganizationAdminAccount) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/DeregisterOrganizationAdminAccount) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/DeregisterOrganizationAdminAccount) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/DeregisterOrganizationAdminAccount) # DisassociateAssessmentReportEvidenceFolder **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Disassociates an evidence folder from the specified assessment report in AWS Audit Manager. ## Request Syntax ``` PUT /assessments/assessmentId/disassociateFromAssessmentReport HTTP/1.1 Content-type: application/json { "evidenceFolderId": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_DisassociateAssessmentReportEvidenceFolder_RequestSyntax) ** The unique identifier for the assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [evidenceFolderId](#API_DisassociateAssessmentReportEvidenceFolder_RequestSyntax) ** The unique identifier for the folder that the evidence is stored in. Type: String Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/DisassociateAssessmentReportEvidenceFolder) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/DisassociateAssessmentReportEvidenceFolder) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/DisassociateAssessmentReportEvidenceFolder) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/DisassociateAssessmentReportEvidenceFolder) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/DisassociateAssessmentReportEvidenceFolder) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/DisassociateAssessmentReportEvidenceFolder) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/DisassociateAssessmentReportEvidenceFolder) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/DisassociateAssessmentReportEvidenceFolder) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/DisassociateAssessmentReportEvidenceFolder) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/DisassociateAssessmentReportEvidenceFolder) # GetAccountStatus **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Gets the registration status of an account in AWS Audit Manager. ## Request Syntax ``` GET /account/status HTTP/1.1 ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [status](#API_GetAccountStatus_ResponseSyntax) ** The status of the AWS account. Type: String Valid Values: `ACTIVE | INACTIVE | PENDING_ACTIVATION` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ## Examples ### Identifying the registration status for an account This is an example response of the `GetAccountStatus` API operation for an active account. #### Sample Response ``` { "status": "ACTIVE" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/GetAccountStatus) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/GetAccountStatus) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/GetAccountStatus) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/GetAccountStatus) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/GetAccountStatus) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/GetAccountStatus) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/GetAccountStatus) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/GetAccountStatus) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/GetAccountStatus) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/GetAccountStatus) # GetAssessment **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Gets information about a specified assessment. ## Request Syntax ``` GET /assessments/assessmentId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_GetAssessment_RequestSyntax) ** The unique identifier for the assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "assessment": { "arn": "string", "awsAccount": { "emailAddress": "string", "id": "string", "name": "string" }, "framework": { "arn": "string", "controlSets": [ { "controls": [ { "assessmentReportEvidenceCount": number, "comments": [ { "authorName": "string", "commentBody": "string", "postedDate": number } ], "description": "string", "evidenceCount": number, "evidenceSources": [ "string" ], "id": "string", "name": "string", "response": "string", "status": "string" } ], "delegations": [ { "assessmentId": "string", "assessmentName": "string", "comment": "string", "controlSetId": "string", "createdBy": "string", "creationTime": number, "id": "string", "lastUpdated": number, "roleArn": "string", "roleType": "string", "status": "string" } ], "description": "string", "id": "string", "manualEvidenceCount": number, "roles": [ { "roleArn": "string", "roleType": "string" } ], "status": "string", "systemEvidenceCount": number } ], "id": "string", "metadata": { "complianceType": "string", "description": "string", "logo": "string", "name": "string" } }, "metadata": { "assessmentReportsDestination": { "destination": "string", "destinationType": "string" }, "complianceType": "string", "creationTime": number, "delegations": [ { "assessmentId": "string", "assessmentName": "string", "comment": "string", "controlSetId": "string", "createdBy": "string", "creationTime": number, "id": "string", "lastUpdated": number, "roleArn": "string", "roleType": "string", "status": "string" } ], "description": "string", "id": "string", "lastUpdated": number, "name": "string", "roles": [ { "roleArn": "string", "roleType": "string" } ], "scope": { "awsAccounts": [ { "emailAddress": "string", "id": "string", "name": "string" } ], "awsServices": [ { "serviceName": "string" } ] }, "status": "string" }, "tags": { "string" : "string" } }, "userRole": { "roleArn": "string", "roleType": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [assessment](#API_GetAssessment_ResponseSyntax) ** An entity that defines the scope of audit evidence collected by AWS Audit Manager. An Audit Manager assessment is an implementation of an Audit Manager framework. Type: [Assessment](API_Assessment.md) object ** [userRole](#API_GetAssessment_ResponseSyntax) ** The wrapper that contains the Audit Manager role information of the current user. This includes the role type and IAM Amazon Resource Name (ARN). Type: [Role](API_Role.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## Examples ### Getting information about an assessment This example shows a sample response for the `GetAssessment` API operation. #### Sample Response ``` { "assessment": { "arn": "arn:aws:auditmanager:us-east-1:111122223333:assessment/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "awsAccount": { "id": "111122223333" }, "metadata": { "name": "My assessment", "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "description": "This is a description about the assessment", "complianceType": "AWS Audit Manager Sample Framework", "status": "ACTIVE", "assessmentReportsDestination": { "destinationType": "S3", "destination": "s3://my-assessment-report-destination" }, "scope": { "awsAccounts": [ { "id": "111122223333" } ], "awsServices": [ { "serviceName": "iam" }, { "serviceName": "ec2" }, { "serviceName": "cloudtrail" } ] }, "roles": [ { "roleType": "PROCESS_OWNER", "roleArn": "arn:aws:iam::111122223333:role/Administrator" }, { "roleType": "PROCESS_OWNER", "roleArn": "arn:aws:iam::222233334444:role/ReadOnly" } ], "delegations": [], "creationTime": "2023-03-13T16:05:55.180000-07:00", "lastUpdated": "2023-03-13T16:05:55.309000-07:00" }, "framework": { "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "metadata": { "name": "AWS Audit Manager Sample Framework", "description": "The AWS Audit Manager sample template contains CloudTrail and AWS API calls. \n\n4 automated controls\n1 manual controls", "logo": "Arch_AWS-Audit-Manager_16.svg", "complianceType": "AWS Audit Manager Sample Framework" }, "controlSets": [ { "id": "AWS API", "description": "AWS API", "status": "ACTIVE", "roles": [ { "roleType": "PROCESS_OWNER", "roleArn": "arn:aws:iam::111122223333:role/Administrator" }, { "roleType": "PROCESS_OWNER", "roleArn": "arn:aws:iam::222233334444:role/ReadOnly" } ], "controls": [ { "id": "control1-5678-90ab-cdef-example11111", "name": "2.2.0 - List Principals and Policies", "description": "2.2.0 - List Principals and Policies", "status": "UNDER_REVIEW", "comments": [], "evidenceSources": [ "AWS API calls" ], "evidenceCount": 0, "assessmentReportEvidenceCount": 0 }, { "id": "control2-5678-90ab-cdef-example22222", "name": "2.2.1 - Describe Networks", "description": "2.2.1 - Describe Networks", "status": "UNDER_REVIEW", "comments": [], "evidenceSources": [ "AWS API calls" ], "evidenceCount": 0, "assessmentReportEvidenceCount": 0 } ], "delegations": [], "systemEvidenceCount": 0, "manualEvidenceCount": 0 }, { "id": "Account", "description": "Account", "status": "ACTIVE", "roles": [ { "roleType": "PROCESS_OWNER", "roleArn": "arn:aws:iam::111122223333:role/Administrator" }, { "roleType": "PROCESS_OWNER", "roleArn": "arn:aws:iam::222233334444:role/ReadOnly" } ], "controls": [ { "id": "control3-5678-90ab-cdef-example33333", "name": "3.0.0 - Account Summary", "description": "3.0.0 - Account Summary", "status": "REVIEWED", "comments": [], "evidenceSources": [ "Manual" ], "evidenceCount": 1, "assessmentReportEvidenceCount": 1 } ], "delegations": [], "systemEvidenceCount": 0, "manualEvidenceCount": 0 }, { "id": "CloudTrail", "description": "CloudTrail", "status": "ACTIVE", "roles": [ { "roleType": "PROCESS_OWNER", "roleArn": "arn:aws:iam::111122223333:role/Administrator" }, { "roleType": "PROCESS_OWNER", "roleArn": "arn:aws:iam::222233334444:role/ReadOnly" } ], "controls": [ { "id": "control4-5678-90ab-cdef-example44444", "name": "1.0.1 - CloudTrail Instance Events", "description": "1.0.1 - CloudTrail Instance Events", "status": "UNDER_REVIEW", "comments": [], "evidenceSources": [ "AWS CloudTrail" ], "evidenceCount": 0, "assessmentReportEvidenceCount": 0 }, { "id": "ab65b812-0e1d-4aa9-ad61-0a642535824d", "name": "1.0.2 - CloudTrail Volume Events", "description": "1.0.2 - CloudTrail Volume Events", "status": "UNDER_REVIEW", "comments": [], "evidenceSources": [ "AWS CloudTrail" ], "evidenceCount": 0, "assessmentReportEvidenceCount": 0 } ], "delegations": [], "systemEvidenceCount": 0, "manualEvidenceCount": 0 } ] }, "tags": {} }, "userRole": { "roleType": "PROCESS_OWNER", "roleArn": "arn:aws:iam::111122223333:role/Administrator" } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/GetAssessment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/GetAssessment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/GetAssessment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/GetAssessment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/GetAssessment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/GetAssessment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/GetAssessment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/GetAssessment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/GetAssessment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/GetAssessment) # GetAssessmentFramework **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Gets information about a specified framework. ## Request Syntax ``` GET /assessmentFrameworks/frameworkId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [frameworkId](#API_GetAssessmentFramework_RequestSyntax) ** The identifier for the framework. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "framework": { "arn": "string", "complianceType": "string", "controlSets": [ { "controls": [ { "actionPlanInstructions": "string", "actionPlanTitle": "string", "arn": "string", "controlMappingSources": [ { "sourceDescription": "string", "sourceFrequency": "string", "sourceId": "string", "sourceKeyword": { "keywordInputType": "string", "keywordValue": "string" }, "sourceName": "string", "sourceSetUpOption": "string", "sourceType": "string", "troubleshootingText": "string" } ], "controlSources": "string", "createdAt": number, "createdBy": "string", "description": "string", "id": "string", "lastUpdatedAt": number, "lastUpdatedBy": "string", "name": "string", "state": "string", "tags": { "string" : "string" }, "testingInformation": "string", "type": "string" } ], "id": "string", "name": "string" } ], "controlSources": "string", "createdAt": number, "createdBy": "string", "description": "string", "id": "string", "lastUpdatedAt": number, "lastUpdatedBy": "string", "logo": "string", "name": "string", "tags": { "string" : "string" }, "type": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [framework](#API_GetAssessmentFramework_ResponseSyntax) ** The framework that the `GetAssessmentFramework` API returned. The `Controls` object returns a partial response when called through Framework APIs. For a complete `Controls` object, use `GetControl`. Type: [Framework](API_Framework.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## Examples ### Getting information about a framework This example shows a sample response for the `GetAssessmentFramework` API operation. This example shows details for a custom framework with two control sets and three controls. #### Sample Response ``` { "framework": { "arn": "arn:aws:auditmanager:us-east-1:111122223333:assessmentFramework/a1b2c3d4-5678-90ab-cdef-example11111", "id": "a1b2c3d4-5678-90ab-cdef-example11111", "name": "My example custom framework", "type": "Custom", "description": "Checks CloudTrail and AWS API calls.", "controlSources": "AWS API calls, AWS CloudTrail", "controlSets": [ { "id": "AWS API Calls", "name": "Control set 1 - AWS API Calls", "controls": [ { "arn": "arn:aws:auditmanager:us-east-1::control/control1-5678-90ab-cdef-example11111", "id": "control1-5678-90ab-cdef-example11111", "type": "Standard", "name": "Control 1 - List Principals and Policies", "state": "ACTIVE", "description": "List all AWS IAM Principals and Policies", "testingInformation": "IAM:\nListRoles\nListRolePolicies\nListUsers\nListGroups\n\n", "controlSources": "AWS API calls", "controlMappingSources": [ { "sourceId": "sourceid-5678-90ab-cdef-example11111", "sourceSetUpOption": "System_Controls_Mapping", "sourceType": "AWS_API_Call", "sourceKeyword": { "keywordInputType": "SELECT_FROM_LIST", "keywordValue": "iam_ListGroups" }, "sourceFrequency": "DAILY" }, { "sourceId": "sourceid-5678-90ab-cdef-example22222", "sourceSetUpOption": "System_Controls_Mapping", "sourceType": "AWS_API_Call", "sourceKeyword": { "keywordInputType": "SELECT_FROM_LIST", "keywordValue": "iam_ListRoles" }, "sourceFrequency": "DAILY" }, { "sourceId": "sourceid-5678-90ab-cdef-example33333", "sourceSetUpOption": "System_Controls_Mapping", "sourceType": "AWS_API_Call", "sourceKeyword": { "keywordInputType": "SELECT_FROM_LIST", "keywordValue": "iam_ListUsers" }, "sourceFrequency": "DAILY" }, { "sourceId": "sourceid-5678-90ab-cdef-example44444", "sourceSetUpOption": "System_Controls_Mapping", "sourceType": "AWS_API_Call", "sourceKeyword": { "keywordInputType": "SELECT_FROM_LIST", "keywordValue": "iam_ListPolicies" }, "sourceFrequency": "DAILY" } ], "createdAt": "2020-12-07T15:18:29.217000-08:00", "lastUpdatedAt": "2022-03-24T12:06:55.083000-07:00", "createdBy": "john-doe", "tags": {} }, { "arn": "arn:aws:auditmanager:us-east-1::control/control2-5678-90ab-cdef-example22222", "id": "control2-5678-90ab-cdef-example22222", "type": "Standard", "name": "Control 2 - Describe Networks", "state": "ACTIVE", "description": "Describe all VPC(s), Security Groups, Network ACL, and Routes", "testingInformation": "List all VPC IDs in region. Get a list of all Security Groups and NACLs describes for each of those VPC IDs. Display all routes.", "controlSources": "AWS API calls", "controlMappingSources": [ { "sourceId": "sourceid-5678-90ab-cdef-example55555", "sourceSetUpOption": "System_Controls_Mapping", "sourceType": "AWS_API_Call", "sourceKeyword": { "keywordInputType": "SELECT_FROM_LIST", "keywordValue": "ec2_DescribeVpcs" }, "sourceFrequency": "DAILY" }, { "sourceId": "sourceid-5678-90ab-cdef-example66666", "sourceSetUpOption": "System_Controls_Mapping", "sourceType": "AWS_API_Call", "sourceKeyword": { "keywordInputType": "SELECT_FROM_LIST", "keywordValue": "ec2_DescribeSecurityGroups" }, "sourceFrequency": "DAILY" }, { "sourceId": "sourceid-5678-90ab-cdef-example77777", "sourceSetUpOption": "System_Controls_Mapping", "sourceType": "AWS_API_Call", "sourceKeyword": { "keywordInputType": "SELECT_FROM_LIST", "keywordValue": "ec2_DescribeNetworkAcls" }, "sourceFrequency": "DAILY" }, { "sourceId": "sourceid-5678-90ab-cdef-example88888", "sourceSetUpOption": "System_Controls_Mapping", "sourceType": "AWS_API_Call", "sourceKeyword": { "keywordInputType": "SELECT_FROM_LIST", "keywordValue": "ec2_DescribeRouteTables" }, "sourceFrequency": "DAILY" } ], "createdAt": "2020-12-07T15:18:29.217000-08:00", "lastUpdatedAt": "2022-03-24T12:06:55.323000-07:00", "createdBy": "john-doe", "tags": {} } ] }, { "id": "CloudTrail Checks", "name": "Control set 2 - CloudTrail Checks", "controls": [ { "arn": "arn:aws:auditmanager:us-east-1::control/control3-5678-90ab-cdef-example33333", "id": "control3-5678-90ab-cdef-example33333", "type": "Standard", "name": "Control 3 - CloudTrail Volume Events", "state": "END_OF_SUPPORT", "description": "CloudTrail eventName for volumes", "testingInformation": "CloudTrail eventName: CreateVolume\DetachVolume ", "controlSources": "AWS CloudTrail", "controlMappingSources": [ { "sourceId": "sourceid-72e6-44da-8486-example99999", "sourceSetUpOption": "System_Controls_Mapping", "sourceType": "AWS_Cloudtrail", "sourceKeyword": { "keywordInputType": "SELECT_FROM_LIST", "keywordValue": "ec2_CreateVolume" } }, { "sourceId": "sourceid-7389-47ca-887b-example00000", "sourceSetUpOption": "System_Controls_Mapping", "sourceType": "AWS_Cloudtrail", "sourceKeyword": { "keywordInputType": "SELECT_FROM_LIST", "keywordValue": "ec2_DetachVolume" } } ], "createdAt": "2020-12-07T15:18:29.217000-08:00", "lastUpdatedAt": "2022-03-24T12:06:55.193000-07:00", "createdBy": "john-doe", "tags": {} } ] } ], "createdAt": "2021-03-02T16:35:24.177000-08:00", "lastUpdatedAt": "2022-01-10T14:32:18.855000-08:00", "createdBy": "john-doe", "lastUpdatedBy": "jane-doe", "tags": {} } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/GetAssessmentFramework) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/GetAssessmentFramework) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/GetAssessmentFramework) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/GetAssessmentFramework) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/GetAssessmentFramework) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/GetAssessmentFramework) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/GetAssessmentFramework) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/GetAssessmentFramework) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/GetAssessmentFramework) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/GetAssessmentFramework) # GetAssessmentReportUrl **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Gets the URL of an assessment report in AWS Audit Manager. ## Request Syntax ``` GET /assessments/assessmentId/reports/assessmentReportId/url HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_GetAssessmentReportUrl_RequestSyntax) ** The unique identifier for the assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [assessmentReportId](#API_GetAssessmentReportUrl_RequestSyntax) ** The unique identifier for the assessment report. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "preSignedUrl": { "hyperlinkName": "string", "link": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [preSignedUrl](#API_GetAssessmentReportUrl_ResponseSyntax) ** Short for uniform resource locator. A URL is used as a unique identifier to locate a resource on the internet. Type: [URL](API_URL.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/GetAssessmentReportUrl) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/GetAssessmentReportUrl) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/GetAssessmentReportUrl) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/GetAssessmentReportUrl) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/GetAssessmentReportUrl) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/GetAssessmentReportUrl) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/GetAssessmentReportUrl) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/GetAssessmentReportUrl) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/GetAssessmentReportUrl) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/GetAssessmentReportUrl) # GetChangeLogs **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Gets a list of changelogs from AWS Audit Manager. ## Request Syntax ``` GET /assessments/assessmentId/changelogs?controlId=controlId&controlSetId=controlSetId&maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_GetChangeLogs_RequestSyntax) ** The unique identifier for the assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [controlId](#API_GetChangeLogs_RequestSyntax) ** The unique identifier for the control. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` ** [controlSetId](#API_GetChangeLogs_RequestSyntax) ** The unique identifier for the control set. Length Constraints: Minimum length of 1. Maximum length of 300. Pattern: `^[\w\W\s\S]*$` ** [maxResults](#API_GetChangeLogs_RequestSyntax) ** Represents the maximum number of results on a page or for an API request call. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_GetChangeLogs_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "changeLogs": [ { "action": "string", "createdAt": number, "createdBy": "string", "objectName": "string", "objectType": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [changeLogs](#API_GetChangeLogs_ResponseSyntax) ** The list of user activity for the control. Type: Array of [ChangeLog](API_ChangeLog.md) objects ** [nextToken](#API_GetChangeLogs_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/GetChangeLogs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/GetChangeLogs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/GetChangeLogs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/GetChangeLogs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/GetChangeLogs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/GetChangeLogs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/GetChangeLogs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/GetChangeLogs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/GetChangeLogs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/GetChangeLogs) # GetControl **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Gets information about a specified control. ## Request Syntax ``` GET /controls/controlId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [controlId](#API_GetControl_RequestSyntax) ** The identifier for the control. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "control": { "actionPlanInstructions": "string", "actionPlanTitle": "string", "arn": "string", "controlMappingSources": [ { "sourceDescription": "string", "sourceFrequency": "string", "sourceId": "string", "sourceKeyword": { "keywordInputType": "string", "keywordValue": "string" }, "sourceName": "string", "sourceSetUpOption": "string", "sourceType": "string", "troubleshootingText": "string" } ], "controlSources": "string", "createdAt": number, "createdBy": "string", "description": "string", "id": "string", "lastUpdatedAt": number, "lastUpdatedBy": "string", "name": "string", "state": "string", "tags": { "string" : "string" }, "testingInformation": "string", "type": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [control](#API_GetControl_ResponseSyntax) ** The details of the control that the `GetControl` API returned. Type: [Control](API_Control.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## Examples ### Getting information about a control This example shows a sample response for the `GetControl` API operation. This example returns details about a specific custom control. In this case, the control has three automated data sources. Each data source is a specific CloudTrail event (`ec2_ModifyInstanceAttribute`, `ec2_CreateImage`, and `ec2_RunInstances`). #### Sample Response ``` { "control": { "arn": "arn:aws:auditmanager:us-east-1:111122223333:control/a1b2c3d4-5678-90ab-cdef-example11111", "id": "a1b2c3d4-5678-90ab-cdef-example11111", "type": "Custom", "name": "1.0.1 - CloudTrail Instance Events_CUSTOM", "description": "CloudTrail eventName for instances", "testingInformation": "CloudTrail eventName:\n\n- CreateImage\n- RunInstances\n- ModifyInstanceAttribute ", "actionPlanTitle": "The title of my action plan", "actionPlanInstructions": "The details of my action plan instructions", "controlSources": "AWS CloudTrail", "controlMappingSources": [ { "sourceId": "sourceid-5678-90ab-cdef-example11111", "sourceName": "Data source 1", "sourceSetUpOption": "System_Controls_Mapping", "sourceType": "AWS_Cloudtrail", "sourceKeyword": { "keywordInputType": "SELECT_FROM_LIST", "keywordValue": "ec2_ModifyInstanceAttribute" } }, { "sourceId": "sourceid-5678-90ab-cdef-example22222", "sourceName": "Data source 2", "sourceSetUpOption": "System_Controls_Mapping", "sourceType": "AWS_Cloudtrail", "sourceKeyword": { "keywordInputType": "SELECT_FROM_LIST", "keywordValue": "ec2_CreateImage" } }, { "sourceId": "sourceid-5678-90ab-cdef-example33333", "sourceName": "Data source 3", "sourceSetUpOption": "System_Controls_Mapping", "sourceType": "AWS_Cloudtrail", "sourceKeyword": { "keywordInputType": "SELECT_FROM_LIST", "keywordValue": "ec2_RunInstances" } } ], "createdAt": "2023-03-13T12:00:58.943000-07:00", "lastUpdatedAt": "2023-03-13T12:00:58.943000-07:00", "createdBy": "john-doe", "lastUpdatedBy": "jane-doe", "state": "ACTIVE", "tags": { "Department": "Legal" } } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/GetControl) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/GetControl) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/GetControl) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/GetControl) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/GetControl) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/GetControl) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/GetControl) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/GetControl) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/GetControl) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/GetControl) # GetDelegations **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Gets a list of delegations from an audit owner to a delegate. ## Request Syntax ``` GET /delegations?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_GetDelegations_RequestSyntax) ** Represents the maximum number of results on a page or for an API request call. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_GetDelegations_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "delegations": [ { "assessmentId": "string", "assessmentName": "string", "controlSetName": "string", "creationTime": number, "id": "string", "roleArn": "string", "status": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [delegations](#API_GetDelegations_ResponseSyntax) ** The list of delegations that the `GetDelegations` API returned. Type: Array of [DelegationMetadata](API_DelegationMetadata.md) objects ** [nextToken](#API_GetDelegations_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/GetDelegations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/GetDelegations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/GetDelegations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/GetDelegations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/GetDelegations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/GetDelegations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/GetDelegations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/GetDelegations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/GetDelegations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/GetDelegations) # GetEvidence **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Gets information about a specified evidence item. ## Request Syntax ``` GET /assessments/assessmentId/controlSets/controlSetId/evidenceFolders/evidenceFolderId/evidence/evidenceId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_GetEvidence_RequestSyntax) ** The unique identifier for the assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [controlSetId](#API_GetEvidence_RequestSyntax) ** The unique identifier for the control set. Length Constraints: Minimum length of 1. Maximum length of 300. Pattern: `^[\w\W\s\S]*$` Required: Yes ** [evidenceFolderId](#API_GetEvidence_RequestSyntax) ** The unique identifier for the folder that the evidence is stored in. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [evidenceId](#API_GetEvidence_RequestSyntax) ** The unique identifier for the evidence. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "evidence": { "assessmentReportSelection": "string", "attributes": { "string" : "string" }, "awsAccountId": "string", "awsOrganization": "string", "complianceCheck": "string", "dataSource": "string", "eventName": "string", "eventSource": "string", "evidenceAwsAccountId": "string", "evidenceByType": "string", "evidenceFolderId": "string", "iamId": "string", "id": "string", "resourcesIncluded": [ { "arn": "string", "complianceCheck": "string", "value": "string" } ], "time": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [evidence](#API_GetEvidence_ResponseSyntax) ** The evidence that the `GetEvidence` API returned. Type: [Evidence](API_Evidence.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/GetEvidence) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/GetEvidence) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/GetEvidence) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/GetEvidence) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/GetEvidence) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/GetEvidence) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/GetEvidence) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/GetEvidence) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/GetEvidence) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/GetEvidence) # GetEvidenceByEvidenceFolder **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Gets all evidence from a specified evidence folder in AWS Audit Manager. ## Request Syntax ``` GET /assessments/assessmentId/controlSets/controlSetId/evidenceFolders/evidenceFolderId/evidence?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_GetEvidenceByEvidenceFolder_RequestSyntax) ** The identifier for the assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [controlSetId](#API_GetEvidenceByEvidenceFolder_RequestSyntax) ** The identifier for the control set. Length Constraints: Minimum length of 1. Maximum length of 300. Pattern: `^[\w\W\s\S]*$` Required: Yes ** [evidenceFolderId](#API_GetEvidenceByEvidenceFolder_RequestSyntax) ** The unique identifier for the folder that the evidence is stored in. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [maxResults](#API_GetEvidenceByEvidenceFolder_RequestSyntax) ** Represents the maximum number of results on a page or for an API request call. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_GetEvidenceByEvidenceFolder_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "evidence": [ { "assessmentReportSelection": "string", "attributes": { "string" : "string" }, "awsAccountId": "string", "awsOrganization": "string", "complianceCheck": "string", "dataSource": "string", "eventName": "string", "eventSource": "string", "evidenceAwsAccountId": "string", "evidenceByType": "string", "evidenceFolderId": "string", "iamId": "string", "id": "string", "resourcesIncluded": [ { "arn": "string", "complianceCheck": "string", "value": "string" } ], "time": number } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [evidence](#API_GetEvidenceByEvidenceFolder_ResponseSyntax) ** The list of evidence that the `GetEvidenceByEvidenceFolder` API returned. Type: Array of [Evidence](API_Evidence.md) objects ** [nextToken](#API_GetEvidenceByEvidenceFolder_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/GetEvidenceByEvidenceFolder) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/GetEvidenceByEvidenceFolder) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/GetEvidenceByEvidenceFolder) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/GetEvidenceByEvidenceFolder) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/GetEvidenceByEvidenceFolder) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/GetEvidenceByEvidenceFolder) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/GetEvidenceByEvidenceFolder) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/GetEvidenceByEvidenceFolder) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/GetEvidenceByEvidenceFolder) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/GetEvidenceByEvidenceFolder) # GetEvidenceFileUploadUrl **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). 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 ](https://docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#how-to-upload-manual-evidence-files) in the * AWS 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](https://docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#supported-manual-evidence-files) in the * AWS Audit Manager User Guide* For more information about Audit Manager service restrictions, see [Quotas and restrictions for AWS Audit Manager](https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html). ## Request Syntax ``` GET /evidenceFileUploadUrl?fileName=fileName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [fileName](#API_GetEvidenceFileUploadUrl_RequestSyntax) ** The file that you want to upload. For a list of supported file formats, see [Supported file types for manual evidence](https://docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#supported-manual-evidence-files) in the * AWS Audit Manager User Guide*. Length Constraints: Minimum length of 1. Maximum length of 300. Pattern: `[^\/]*` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "evidenceFileName": "string", "uploadUrl": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [evidenceFileName](#API_GetEvidenceFileUploadUrl_ResponseSyntax) ** The name of the uploaded manual evidence file that the presigned URL was generated for. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `.*\S.*` ** [uploadUrl](#API_GetEvidenceFileUploadUrl_ResponseSyntax) ** The presigned URL that was generated. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `.*\S.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ThrottlingException ** The request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/GetEvidenceFileUploadUrl) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/GetEvidenceFileUploadUrl) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/GetEvidenceFileUploadUrl) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/GetEvidenceFileUploadUrl) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/GetEvidenceFileUploadUrl) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/GetEvidenceFileUploadUrl) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/GetEvidenceFileUploadUrl) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/GetEvidenceFileUploadUrl) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/GetEvidenceFileUploadUrl) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/GetEvidenceFileUploadUrl) # GetEvidenceFolder **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Gets an evidence folder from a specified assessment in AWS Audit Manager. ## Request Syntax ``` GET /assessments/assessmentId/controlSets/controlSetId/evidenceFolders/evidenceFolderId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_GetEvidenceFolder_RequestSyntax) ** The unique identifier for the assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [controlSetId](#API_GetEvidenceFolder_RequestSyntax) ** The unique identifier for the control set. Length Constraints: Minimum length of 1. Maximum length of 300. Pattern: `^[\w\W\s\S]*$` Required: Yes ** [evidenceFolderId](#API_GetEvidenceFolder_RequestSyntax) ** The unique identifier for the folder that the evidence is stored in. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "evidenceFolder": { "assessmentId": "string", "assessmentReportSelectionCount": number, "author": "string", "controlId": "string", "controlName": "string", "controlSetId": "string", "dataSource": "string", "date": number, "evidenceAwsServiceSourceCount": number, "evidenceByTypeComplianceCheckCount": number, "evidenceByTypeComplianceCheckIssuesCount": number, "evidenceByTypeConfigurationDataCount": number, "evidenceByTypeManualCount": number, "evidenceByTypeUserActivityCount": number, "evidenceResourcesIncludedCount": number, "id": "string", "name": "string", "totalEvidence": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [evidenceFolder](#API_GetEvidenceFolder_ResponseSyntax) ** The folder that the evidence is stored in. Type: [AssessmentEvidenceFolder](API_AssessmentEvidenceFolder.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/GetEvidenceFolder) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/GetEvidenceFolder) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/GetEvidenceFolder) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/GetEvidenceFolder) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/GetEvidenceFolder) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/GetEvidenceFolder) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/GetEvidenceFolder) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/GetEvidenceFolder) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/GetEvidenceFolder) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/GetEvidenceFolder) # GetEvidenceFoldersByAssessment **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Gets the evidence folders from a specified assessment in AWS Audit Manager. ## Request Syntax ``` GET /assessments/assessmentId/evidenceFolders?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_GetEvidenceFoldersByAssessment_RequestSyntax) ** The unique identifier for the assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [maxResults](#API_GetEvidenceFoldersByAssessment_RequestSyntax) ** Represents the maximum number of results on a page or for an API request call. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_GetEvidenceFoldersByAssessment_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "evidenceFolders": [ { "assessmentId": "string", "assessmentReportSelectionCount": number, "author": "string", "controlId": "string", "controlName": "string", "controlSetId": "string", "dataSource": "string", "date": number, "evidenceAwsServiceSourceCount": number, "evidenceByTypeComplianceCheckCount": number, "evidenceByTypeComplianceCheckIssuesCount": number, "evidenceByTypeConfigurationDataCount": number, "evidenceByTypeManualCount": number, "evidenceByTypeUserActivityCount": number, "evidenceResourcesIncludedCount": number, "id": "string", "name": "string", "totalEvidence": number } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [evidenceFolders](#API_GetEvidenceFoldersByAssessment_ResponseSyntax) ** The list of evidence folders that the `GetEvidenceFoldersByAssessment` API returned. Type: Array of [AssessmentEvidenceFolder](API_AssessmentEvidenceFolder.md) objects ** [nextToken](#API_GetEvidenceFoldersByAssessment_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/GetEvidenceFoldersByAssessment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/GetEvidenceFoldersByAssessment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/GetEvidenceFoldersByAssessment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/GetEvidenceFoldersByAssessment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/GetEvidenceFoldersByAssessment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/GetEvidenceFoldersByAssessment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/GetEvidenceFoldersByAssessment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/GetEvidenceFoldersByAssessment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/GetEvidenceFoldersByAssessment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/GetEvidenceFoldersByAssessment) # GetEvidenceFoldersByAssessmentControl **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Gets a list of evidence folders that are associated with a specified control in an Audit Manager assessment. ## Request Syntax ``` GET /assessments/assessmentId/evidenceFolders-by-assessment-control/controlSetId/controlId?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_GetEvidenceFoldersByAssessmentControl_RequestSyntax) ** The identifier for the assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [controlId](#API_GetEvidenceFoldersByAssessmentControl_RequestSyntax) ** The identifier for the control. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [controlSetId](#API_GetEvidenceFoldersByAssessmentControl_RequestSyntax) ** The identifier for the control set. Length Constraints: Minimum length of 1. Maximum length of 300. Pattern: `^[\w\W\s\S]*$` Required: Yes ** [maxResults](#API_GetEvidenceFoldersByAssessmentControl_RequestSyntax) ** Represents the maximum number of results on a page or for an API request call. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_GetEvidenceFoldersByAssessmentControl_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "evidenceFolders": [ { "assessmentId": "string", "assessmentReportSelectionCount": number, "author": "string", "controlId": "string", "controlName": "string", "controlSetId": "string", "dataSource": "string", "date": number, "evidenceAwsServiceSourceCount": number, "evidenceByTypeComplianceCheckCount": number, "evidenceByTypeComplianceCheckIssuesCount": number, "evidenceByTypeConfigurationDataCount": number, "evidenceByTypeManualCount": number, "evidenceByTypeUserActivityCount": number, "evidenceResourcesIncludedCount": number, "id": "string", "name": "string", "totalEvidence": number } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [evidenceFolders](#API_GetEvidenceFoldersByAssessmentControl_ResponseSyntax) ** The list of evidence folders that the `GetEvidenceFoldersByAssessmentControl` API returned. Type: Array of [AssessmentEvidenceFolder](API_AssessmentEvidenceFolder.md) objects ** [nextToken](#API_GetEvidenceFoldersByAssessmentControl_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/GetEvidenceFoldersByAssessmentControl) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/GetEvidenceFoldersByAssessmentControl) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/GetEvidenceFoldersByAssessmentControl) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/GetEvidenceFoldersByAssessmentControl) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/GetEvidenceFoldersByAssessmentControl) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/GetEvidenceFoldersByAssessmentControl) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/GetEvidenceFoldersByAssessmentControl) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/GetEvidenceFoldersByAssessmentControl) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/GetEvidenceFoldersByAssessmentControl) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/GetEvidenceFoldersByAssessmentControl) # GetInsights **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Gets the latest analytics data for all your current active assessments. ## Request Syntax ``` GET /insights HTTP/1.1 ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "insights": { "activeAssessmentsCount": number, "assessmentControlsCountByNoncompliantEvidence": number, "compliantEvidenceCount": number, "inconclusiveEvidenceCount": number, "lastUpdated": number, "noncompliantEvidenceCount": number, "totalAssessmentControlsCount": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [insights](#API_GetInsights_ResponseSyntax) ** The analytics data that the `GetInsights` API returned. Type: [Insights](API_Insights.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/GetInsights) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/GetInsights) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/GetInsights) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/GetInsights) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/GetInsights) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/GetInsights) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/GetInsights) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/GetInsights) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/GetInsights) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/GetInsights) # GetInsightsByAssessment **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Gets the latest analytics data for a specific active assessment. ## Request Syntax ``` GET /insights/assessments/assessmentId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_GetInsightsByAssessment_RequestSyntax) ** The unique identifier for the assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "insights": { "assessmentControlsCountByNoncompliantEvidence": number, "compliantEvidenceCount": number, "inconclusiveEvidenceCount": number, "lastUpdated": number, "noncompliantEvidenceCount": number, "totalAssessmentControlsCount": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [insights](#API_GetInsightsByAssessment_ResponseSyntax) ** The assessment analytics data that the `GetInsightsByAssessment` API returned. Type: [InsightsByAssessment](API_InsightsByAssessment.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/GetInsightsByAssessment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/GetInsightsByAssessment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/GetInsightsByAssessment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/GetInsightsByAssessment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/GetInsightsByAssessment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/GetInsightsByAssessment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/GetInsightsByAssessment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/GetInsightsByAssessment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/GetInsightsByAssessment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/GetInsightsByAssessment) # GetOrganizationAdminAccount **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Gets the name of the delegated AWS administrator account for a specified organization. ## Request Syntax ``` GET /account/organizationAdminAccount HTTP/1.1 ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "adminAccountId": "string", "organizationId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [adminAccountId](#API_GetOrganizationAdminAccount_ResponseSyntax) ** The identifier for the administrator account. Type: String Length Constraints: Fixed length of 12. Pattern: `^[0-9]{12}$` ** [organizationId](#API_GetOrganizationAdminAccount_ResponseSyntax) ** The identifier for the organization. Type: String Length Constraints: Minimum length of 12. Maximum length of 34. Pattern: `o-[a-z0-9]{10,32}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/GetOrganizationAdminAccount) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/GetOrganizationAdminAccount) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/GetOrganizationAdminAccount) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/GetOrganizationAdminAccount) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/GetOrganizationAdminAccount) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/GetOrganizationAdminAccount) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/GetOrganizationAdminAccount) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/GetOrganizationAdminAccount) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/GetOrganizationAdminAccount) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/GetOrganizationAdminAccount) # GetServicesInScope Gets a list of the AWS services from which Audit Manager can collect evidence. Audit Manager defines which AWS services are in scope for an assessment. Audit Manager infers this scope by examining the assessment’s controls and their data sources, and then mapping this information to one or more of the corresponding AWS services that are in this list. **Note** For information about why it's no longer possible to specify services in scope manually, see [I can't edit the services in scope for my assessment](https://docs.aws.amazon.com/audit-manager/latest/userguide/evidence-collection-issues.html#unable-to-edit-services) in the *Troubleshooting* section of the AWS Audit Manager user guide. ## Request Syntax ``` GET /services HTTP/1.1 ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "serviceMetadata": [ { "category": "string", "description": "string", "displayName": "string", "name": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [serviceMetadata](#API_GetServicesInScope_ResponseSyntax) ** The metadata that's associated with the AWS service. Type: Array of [ServiceMetadata](API_ServiceMetadata.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## Examples ### Retrieving the list of available services for an assessment This is an example response for the `GetServicesInScope` API operation. You can use this response to see the supported AWS services that Audit Manager can collect evidence from. #### Sample Response ``` { "serviceMetadata": [ { "name": "ec2", "displayName": "Amazon Elastic Compute Cloud", "description": "Amazon Elastic Compute Cloud (Amazon EC2) is a web service that provides resizable computing capacityùliterally, servers in Amazon's data centersùthat you use to build and host your software systems.", "category": "Compute" }, { "name": "s3", "displayName": "Amazon Simple Storage Service", "description": "Amazon Simple Storage Service (Amazon S3) is storage for the internet.", "category": "Storage" }, { "name": "dynamodb", "displayName": "Amazon DynamoDB", "description": "Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability.", "category": "Database" }, { "name": "rds", "displayName": "Amazon Relational Database Service", "description": "Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. ", "category": "Database" }, { "name": "lambda", "displayName": "AWS Lambda", "description": "With AWS Lambda, you can run code without provisioning or managing servers. You pay only for the compute time that you consumeùthereÆs no charge when your code isnÆt running.", "category": "Compute" }, { "name": "networkmanager", "displayName": "Amazon Virtual Private Cloud", "description": "Amazon Virtual Private Cloud (Amazon VPC) enables you to launch Amazon Web Services (AWS) resources into a virtual network that you've defined.", "category": "Networking and content delivery" }, { "name": "lightsail", "displayName": "Amazon Lightsail", "description": "Amazon Lightsail helps developers get started using AWS to build websites or web applications.", "category": "Compute" }, { "name": "sagemaker", "displayName": "Amazon SageMaker", "description": "Amazon SageMaker is a fully managed machine learning service.", "category": "Machine learning" }, { "name": "cloudtrail", "displayName": "AWS CloudTrail", "description": "With AWS CloudTrail, you can monitor your AWS deployments in the cloud by getting a history of AWS API calls for your account, including API calls made via the AWS Management Console, the AWS SDKs, the command line tools, and higher-level AWS services.", "category": "Management and governance" }, { "name": "iam", "displayName": "AWS Identity and Access Management", "description": "AWS Identity and Access Management (IAM) is a web service for securely controlling access to AWS services. With IAM, you can centrally manage users, security credentials such as access keys, and permissions that control which AWS resources users and applications can access.", "category": "Security, identity, and compliance" }, { "name": "config", "displayName": "AWS Config", "description": "AWS Config provides a detailed view of the resources associated with your AWS account, including how they are configured, how they are related to one another, and how the configurations and their relationships have changed over time.", "category": "Management and governance" }, { "name": "securityhub", "displayName": "AWS Security Hub", "description": "AWS Security Hub provides you with a comprehensive view of the security state of your AWS resources.", "category": "Security, identity, and compliance" }, { "name": "a4b", "displayName": "Alexa for Business", "description": "Alexa for Business gives you the tools you need to manage Alexa devices, enroll users, and assign skills. You can build your own voice skills using the Alexa Skills Kit and the Alexa for Business API.", "category": "Business applications" }, { "name": "amplify", "displayName": "AWS Amplify", "description": "AWS Amplify enables developers to develop and deploy cloud-powered mobile and web apps. The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development.", "category": "Front-end web and mobile" }, { "name": "apigateway", "displayName": "Amazon API Gateway", "description": "Amazon API Gateway enables you to create and deploy your own REST and WebSocket APIs at any scale. You can create robust, secure, and scalable APIs that access AWS or other web services, as well as data thatÆs stored in the AWS Cloud.", "category": "Networking and content delivery" }, { "name": "appmesh", "displayName": "AWS App Mesh", "description": "AWS App Mesh makes it easy to monitor and control microservices running on AWS.", "category": "Networking and content delivery" }, { "name": "appconfig", "displayName": "AWS AppConfig", "description": "Use AWS AppConfig to quickly deploy application configurations to applications of any size. ", "category": "Management and governance" }, { "name": "appflow", "displayName": "Amazon AppFlow", "description": "Amazon AppFlow is a fully managed API integration service that you use to connect your software as a service (SaaS) applications to AWS services, and securely transfer data.", "category": "Application integration, analytics" }, { "name": "discovery", "displayName": "AWS Application Discovery Service", "description": "The AWS Application Discovery Service helps systems integrators quickly and reliably plan application migration projects by automatically identifying applications running in on-premises data centers, their associated dependencies, and their performance profile.", "category": "Migration and transfer" }, { "name": "appstream", "displayName": "Amazon AppStream 2.0", "description": "Amazon AppStream 2.0 is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications.", "category": "End user computing" }, { "name": "appsync", "displayName": "AWS AppSync", "description": "AWS AppSync is an enterprise level, fully managed GraphQL service with real-time data synchronization and offline programming features.", "category": "Front-end web and mobile" }, { "name": "athena", "displayName": "Amazon Athena", "description": "Amazon Athena is an interactive query service that makes it easy to analyze data in Amazon S3 using standard SQL. Athena is serverless, so there is no infrastructure to setup or manage, and you pay only for the queries you run.", "category": "Analytics" }, { "name": "autoscaling", "displayName": "Auto Scaling", "description": "AWS provides multiple services that you can use to scale your application. Auto scaling is enabled by Amazon CloudWatch and is available at no additional charge beyond the service fees for CloudWatch and the other AWS resources that you use.", "category": "Management and governance" }, { "name": "backup", "displayName": "AWS Backup", "description": "AWS Backup is a fully managed backup service that makes it easy to centralize and automate the backup of data across AWS services in the cloud as well as on premises.", "category": "Storage" }, { "name": "batch", "displayName": "AWS Batch", "description": "AWS Batch enables you to run batch computing workloads on the AWS Cloud. Batch computing is a common way for developers, scientists, and engineers to access large amounts of compute resources.", "category": "Compute" }, { "name": "budgets", "displayName": "AWS Billing and Cost Management", "description": "AWS Billing and Cost Management is a web service that provides features that helps you monitor your costs and pay your bill. Amazon Web Services (AWS) bills your account for usage, which ensures that you pay only for what you use.", "category": "Billing and cost management" }, { "name": "braket", "displayName": "Amazon Braket", "description": "Amazon Braket is a fully managed service that helps you get started with quantum computing by providing a development environment to explore and design quantum algorithms, test them on simulated quantum computers, and run them on your choice of different quantum hardware technologies.", "category": "Quantum computing" }, { "name": "acm", "displayName": "AWS Certificate Manager", "description": "AWS Certificate Manager (ACM) makes it easy to provision, manage, and deploy SSL/TLS certificates on AWS managed resources.", "category": "Cryptography and PKI" }, { "name": "acm-pca", "displayName": "AWS Certificate Manager Private Certificate Authority", "description": "AWS Certificate Manager (ACM) makes it easy to provision, manage, and deploy SSL/TLS certificates on AWS managed resources.", "category": "Cryptography and PKI" }, { "name": "chime", "displayName": "Amazon Chime", "description": "Amazon Chime is a secure, real-time, unified communications service that transforms meetings by making them more efficient and easier to conduct.", "category": "Business applications" }, { "name": "clouddirectory", "displayName": "Amazon Cloud Directory", "description": "Amazon Cloud Directory is a cloud-native directory that can store hundreds of millions of application-specific objects with multiple relationships and schemas.", "category": "Security, identity, and compliance" }, { "name": "servicediscovery", "displayName": "AWS Cloud Map", "description": "AWS Cloud Map lets you name and discover your cloud resources.", "category": "Networking and content delivery" }, { "name": "cloud9", "displayName": "AWS Cloud9", "description": "AWS Cloud9 is a cloud-based integrated development environment (IDE) that you use to write, run, and debug code.", "category": "Developer tools" }, { "name": "cloudformation", "displayName": "AWS CloudFormation", "description": "AWS CloudFormation enables you to create and provision AWS infrastructure deployments predictably and repeatedly.", "category": "Management and governance" }, { "name": "cloudfront", "displayName": "Amazon CloudFront", "description": "Amazon CloudFront speeds up distribution of your static and dynamic web content, such as .html, .css, .php, image, and media files. When users request your content, CloudFront delivers it through a worldwide network of edge locations that provide low latency and high performance.", "category": "Networking and content delivery" }, { "name": "cloudhsm", "displayName": "AWS CloudHSM", "description": "AWS CloudHSM offers secure cryptographic key storage for customers by providing managed hardware security modules in the AWS Cloud.", "category": "Cryptography and PKI" }, { "name": "cloudsearch", "displayName": "Amazon CloudSearch", "description": "Amazon CloudSearch is a fully managed service in the cloud that makes it easy to set up, manage, and scale a search solution for your website.", "category": "Analytics" }, { "name": "cloudwatch", "displayName": "Amazon CloudWatch", "description": "Amazon CloudWatch provides a reliable, scalable, and flexible monitoring solution that you can start using within minutes. You no longer need to set up, manage, and scale your own monitoring systems and infrastructure.", "category": "Management and governance" }, { "name": "codeartifact", "displayName": "AWS CodeArtifact", "description": "AWS CodeArtifact is a secure, scalable, and cost-effective artifact management service for software development.", "category": "Developer tools" }, { "name": "codebuild", "displayName": "AWS CodeBuild", "description": "AWS CodeBuild is a fully managed build service that compiles your source code, runs unit tests, and produces artifacts that are ready to deploy.", "category": "Developer tools" }, { "name": "codecommit", "displayName": "AWS CodeCommit", "description": "AWS CodeCommit is a version control service that enables you to privately store and manage Git repositories in the AWS cloud.", "category": "Developer tools" }, { "name": "codedeploy", "displayName": "AWS CodeDeploy", "description": "AWS CodeDeploy is a deployment service that enables developers to automate the deployment of applications to instances and to update the applications as required.", "category": "Developer tools" }, { "name": "codeguru-profiler", "displayName": "Amazon CodeGuru", "description": "CodeGuru provides intelligent recommendations for improving application performance, efficiency, and code quality in your Java applications.", "category": "Machine learning" }, { "name": "codepipeline", "displayName": "AWS CodePipeline", "description": "AWS CodePipeline is a continuous delivery service that enables you to model, visualize, and automate the steps required to release your software.", "category": "Developer tools" }, { "name": "codestar", "displayName": "AWS CodeStar", "description": "AWS CodeStar lets you quickly develop, build, and deploy applications on AWS.", "category": "Developer tools" }, { "name": "cognito-identity", "displayName": "Amazon Cognito", "description": "Amazon Cognito handles user authentication and authorization for your web and mobile apps.", "category": "Security, identity, and compliance" }, { "name": "comprehend", "displayName": "Amazon Comprehend", "description": "Amazon Comprehend uses natural language processing (NLP) to extract insights about the content of documents without the need of any special preprocessing.", "category": "Machine learning" }, { "name": "compute-optimizer", "displayName": "AWS Compute Optimizer", "description": "AWS Compute Optimizer recommends optimal AWS compute resources for your workloads.", "category": "Management and governance" }, { "name": "connect", "displayName": "Amazon Connect", "description": "Amazon Connect is a contact center as a service (CCaS) solution that offers easy, self-service configuration and enables dynamic, personal, and natural customer engagement at any scale.", "category": "Customer engagement" }, { "name": "data exchange", "displayName": "AWS Data Exchange", "description": "AWS Data Exchange is a service that makes it easy for customers to find, subscribe to, and use third-party data in the AWS Cloud.", "category": "Analytics" }, { "name": "datapipeline", "displayName": "AWS Data Pipeline", "description": "AWS Data Pipeline is a web service that you can use to automate the movement and transformation of data.", "category": "Analytics" }, { "name": "datasync", "displayName": "AWS DataSync", "description": "AWS DataSync is a data-transfer service that simplifies, automates, and accelerates moving and replicating data between on-premises storage systems and AWS storage services over the internet or AWS Direct Connect.", "category": "Migration and transfer" }, { "name": "detective", "displayName": "Amazon Detective", "description": "Amazon Detective makes it easy to analyze, investigate, and quickly identify the root cause of security findings or suspicious activities. ", "category": "Security, identity, and compliance" }, { "name": "devicefarm", "displayName": "AWS Device Farm", "description": "AWS Device Farm is an app testing service that enables you to test your iOS, Android and Fire OS apps on real, physical phones and tablets that are hosted by AWS.", "category": "Front-end web and mobile" }, { "name": "directconnect", "displayName": "AWS Direct Connect", "description": "AWS Direct Connect links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable.", "category": "Networking and content delivery" }, { "name": "ds", "displayName": "AWS Directory Service", "description": "AWS Directory Service provides multiple ways to set up and run Microsoft Active Directory with other AWS services such as Amazon EC2, Amazon RDS for SQL Server, Amazon FSx for Windows File Server, and AWS Single-Sign On. AWS Directory Service for Microsoft Active Directory, also known as AWS Managed Microsoft AD, enables your directory-aware workloads and AWS resources to use a managed Active Directory in the AWS Cloud.", "category": "Security, identity, and compliance" }, { "name": "imagebuilder", "displayName": "EC2 Image Builder", "description": "EC2 Image Builder is a fully-managed AWS service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date ôgoldenö server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.", "category": "Compute" }, { "name": "elasticbeanstalk", "displayName": "AWS Elastic Beanstalk", "description": "With AWS Elastic Beanstalk, you can quickly deploy and manage applications in the AWS Cloud without worrying about the infrastructure that runs those applications.", "category": "Compute" }, { "name": "ebs", "displayName": "Amazon Elastic Block Store", "description": "Amazon Elastic Block Store (Amazon EBS) is a web service that provides block level storage volumes for use with EC2 instances.", "category": "Storage" }, { "name": "ecr", "displayName": "Amazon Elastic Container Registry", "description": "Amazon Elastic Container Registry (Amazon ECR) is a fully managed Docker container registry that makes it easy for developers to store, manage, and deploy Docker container images.", "category": "Containers" }, { "name": "ecs", "displayName": "Amazon Elastic Container Service", "description": "Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster of Amazon EC2 instances.", "category": "Containers" }, { "name": "elasticfilesystem", "displayName": "Amazon Elastic File System", "description": "Amazon EFS provides file storage for your Amazon EC2 instances.", "category": "Storage" }, { "name": "elastic-inference", "displayName": "Amazon Elastic Inference", "description": "Amazon Elastic Inference is a service that allows you to attach low-cost GPU-powered acceleration to many Amazon machine instances in order to reduce the cost of running deep learning inference by up to 75%.", "category": "Machine learning" }, { "name": "eks", "displayName": "Amazon Elastic Kubernetes Service", "description": "Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on AWS without needing to install and operate your own Kubernetes clusters.", "category": "Containers" }, { "name": "elasticloadbalancing", "displayName": "Elastic Load Balancing", "description": "Elastic Load Balancing automatically distributes your incoming traffic across multiple targets, such as EC2 instances, containers, and IP addresses, in one or more Availability Zones.", "category": "Networking and content delivery" }, { "name": "elastictranscoder", "displayName": "Amazon Elastic Transcoder", "description": "Amazon Elastic Transcoder lets you convert media files that you have stored in Amazon S3 into media files in the formats required by consumer playback devices.", "category": "Media services" }, { "name": "elasticache", "displayName": "Amazon ElastiCache", "description": "Amazon ElastiCache makes it easy to set up, manage, and scale distributed in-memory cache environments in the AWS Cloud.", "category": "Database" }, { "name": "es", "displayName": "Amazon OpenSearch Service", "description": "Amazon OpenSearch Service is a fully managed service that makes it easy for you to deploy, secure, and run OpenSearch and Elasticsearch clusters cost effectively at scale.", "category": "Analytics" }, { "name": "mediaconnect", "displayName": "AWS Elemental MediaConnect", "description": "AWS Elemental MediaConnect is a reliable, secure, and flexible transport service for live video. ", "category": "Media services" }, { "name": "mediaconvert", "displayName": "AWS Elemental MediaConvert", "description": "AWS Elemental MediaConvert is a service that formats and compresses offline video content for delivery to televisions or connected devices.", "category": "Media services" }, { "name": "medialive", "displayName": "AWS Elemental MediaLive", "description": "AWS Elemental MediaLive is a video service that allows easy and reliable creation of live outputs for broadcast and streaming delivery.", "category": "Media services" }, { "name": "mediapackage", "displayName": "AWS Elemental MediaPackage", "description": "AWS Elemental MediaPackage is a just-in-time video packaging and origination service that delivers highly secure, scalable, and reliable video streams to a wide variety of playback devices. ", "category": "Media services" }, { "name": "mediastore", "displayName": "AWS Elemental MediaStore", "description": "AWS Elemental MediaStore is a video origination and storage service that offers the high performance, predictable low latency, and immediate consistency required for live origination.", "category": "Media services" }, { "name": "mediatailor", "displayName": "AWS Elemental MediaTailor", "description": "AWS Elemental MediaTailor is a personalization and monetization service that allows scalable server-side ad insertion.", "category": "Media services" }, { "name": "elasticmapreduce", "displayName": "Amazon EMR", "description": "Amazon EMR is a web service that makes it easy to process large amounts of data efficiently.", "category": "Analytics" }, { "name": "events", "displayName": "Amazon EventBridge", "description": "Amazon EventBridge is a serverless event bus service that makes it easy to connect your applications with data from a variety of sources.", "category": "Application integration" }, { "name": "fms", "displayName": "AWS Firewall Manager", "description": "AWS Firewall Manager simplifies your AWS WAF administration and maintenance tasks across multiple accounts and resources.", "category": "Security, identity, and compliance" }, { "name": "forecast", "displayName": "Amazon Forecast", "description": "Amazon Forecast is a fully managed deep learning service for time-series forecasting.", "category": "Machine learning" }, { "name": "frauddetector", "displayName": "Amazon Fraud Detector", "description": "Amazon Fraud Detector is a fully managed service that helps you detect suspicious online activities such as the creation of fake accounts and online payment fraud.", "category": "Machine learning" }, { "name": "fsx", "displayName": "Amazon FSx", "description": "Amazon FSx provides fully managed third-party file systems with the native compatibility and feature sets for workloads such as Microsoft Windowsûbased storage, high-performance computing, machine learning, and electronic design automation.", "category": "Storage" }, { "name": "gamelift", "displayName": "Amazon GameLift", "description": "GameLift provides solutions for hosting session-based multiplayer game servers in the cloud, including a fully managed service for deploying, operating, and scaling game servers.", "category": "Game development" }, { "name": "globalaccelerator", "displayName": "AWS Global Accelerator", "description": "AWS Global Accelerator is a network layer service in which you create accelerators to improve availability and performance for internet applications used by a global audience.", "category": "Networking and content delivery" }, { "name": "glue", "displayName": "AWS Glue", "description": "AWS Glue is a serverless data-preparation service. It makes it easy for data engineers, data analysts, data scientists, and extract, transform, and load (ETL) developers to extract, clean, enrich, normalize, and load data.", "category": "Analytics" }, { "name": "groundstation", "displayName": "AWS Ground Station", "description": "AWS Ground Station is a fully managed service that enables you to control satellite communications, process satellite data, and scale your satellite operations.", "category": "Satellite" }, { "name": "guardduty", "displayName": "Amazon GuardDuty", "description": "Amazon GuardDuty is a continuous security monitoring service. ", "category": "Security, identity, and compliance" }, { "name": "health", "displayName": "AWS Health", "description": "AWS Health provides personalized information about events that can affect your AWS infrastructure, guides you through scheduled changes, and accelerates the troubleshooting of issues that affect your AWS resources and accounts.", "category": "Management and governance" }, { "name": "honeycode", "displayName": "Amazon Honeycode", "description": "Amazon Honeycode is a fully managed service that allows you to quickly build mobile and web apps for teamsùwithout programming.", "category": "Business applications" }, { "name": "inspector", "displayName": "Amazon Inspector", "description": "Amazon Inspector is a security vulnerability assessment service that helps improve the security and compliance of your AWS resources. ", "category": "Security, identity, and compliance" }, { "name": "ivs", "displayName": "Amazon Interactive Video Service", "description": "Amazon Interactive Video Service (IVS) is a managed, live-video streaming service with ultra-low latency.", "category": "Media services" }, { "name": "iot1click", "displayName": "AWS IoT 1-Click", "description": "AWS IoT 1-Click is a service that makes it easy for simple devices to trigger AWS Lambda functions that execute a specific action.", "category": "Internet of Things (IoT)" }, { "name": "iotanalytics", "displayName": "AWS IoT Analytics", "description": "AWS IoT Analytics is a managed service that provides advanced data analysis for IoT devices.", "category": "Internet of Things (IoT)" }, { "name": "iot", "displayName": "AWS IoT Core", "description": "AWS IoT enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, and smart appliances) and the AWS Cloud over MQTT and HTTP.", "category": "Internet of Things (IoT)" }, { "name": "iotevents", "displayName": "AWS IoT Events", "description": "AWS IoT Events is a managed service that lets you monitor your equipment or device fleets for failures or changes in operation, and trigger actions when such events occur.", "category": "Internet of Things (IoT)" }, { "name": "greengrass", "displayName": "AWS IoT Greengrass", "description": "AWS IoT Greengrass seamlessly extends AWS onto physical devices so they can act locally on the data they generate, while still using the cloud for management, analytics, and durable storage.", "category": "Internet of Things (IoT)" }, { "name": "iotsitewise", "displayName": "AWS IoT SiteWise", "description": "Easily collect, organize, and analyze data from industrial equipment at scale.", "category": "Internet of Things (IoT)" }, { "name": "iotthingsgraph", "displayName": "AWS IoT Things Graph", "description": "AWS IoT Things Graph is an integrated set of tools that enable developers to build IoT applications using devices and services that use different data representation standards and communication protocols.", "category": "Internet of Things (IoT)" }, { "name": "kendra", "displayName": "Amazon Kendra", "description": "Amazon Kendra is a search service, powered by machine learning, that enables users to search unstructured text using natural language.", "category": "Machine learning" }, { "name": "kms", "displayName": "AWS Key Management Service", "description": "AWS Key Management Service (KMS) is an encryption and key management service scaled for the cloud.", "category": "Cryptography and PKI" }, { "name": "kinesis", "displayName": "Amazon Kinesis", "description": "Amazon Kinesis makes it easy to collect, process, and analyze video and data streams in real time.", "category": "Analytics" }, { "name": "lakeformation", "displayName": "AWS Lake Formation", "description": "AWS Lake Formation is a managed service that makes it easy to set up, secure, and manage your data lakes.", "category": "Analytics" }, { "name": "lex", "displayName": "Amazon Lex", "description": "Amazon Lex is an AWS service for building conversational interfaces into applications using voice and text.", "category": "Machine learning" }, { "name": "license-manager", "displayName": "AWS License Manager", "description": "AWS License Manager streamlines the process of bringing software vendor licenses to the cloud.", "category": "Management and governance" }, { "name": "machinelearning", "displayName": "Amazon Machine Learning", "description": "Amazon Machine Learning makes it easy for developers to build smart applications, including applications for fraud detection, demand forecasting, targeted marketing, and click prediction.", "category": "Machine learning" }, { "name": "macie", "displayName": "Amazon Macie", "description": "Amazon Macie is a fully managed data security and data privacy service that uses machine learning and pattern matching to discover, classify, and help you protect your sensitive data in Amazon S3.", "category": "Security, identity, and compliance" }, { "name": "managedblockchain", "displayName": "Amazon Managed Blockchain", "description": "Amazon Managed Blockchain is a fully managed service that makes it easy to create and manage scalable blockchain networks using popular open source frameworks.", "category": "Blockchain" }, { "name": "kafka", "displayName": "Amazon Managed Streaming for Apache Kafka", "description": "Amazon Managed Streaming for Apache Kafka (Amazon MSK) is a fully managed service that makes it easy for you to build and run applications that use Apache Kafka to process streaming data.", "category": "Analytics" }, { "name": "entitlement-marketplace", "displayName": "AWS Marketplace", "description": "AWS Marketplace is an online store where you can buy or sell software that runs on Amazon Web Services (AWS).", "category": "Additional resources" }, { "name": "migrationhub", "displayName": "AWS Migration Hub", "description": "AWS Migration Hub provides a single location to track migration tasks across multiple AWS tools and partner solutions. With Migration Hub, you can choose the AWS and partner migration tools that best fit your needs while providing visibility into the status of your migration projects.", "category": "Migration and transfer" }, { "name": "amazonmq", "displayName": "Amazon MQ", "description": "Amazon MQ is a managed message broker service that makes it easy to set up and operate message brokers in the cloud.", "category": "Application integration" }, { "name": "opsworks", "displayName": "AWS OpsWorks", "description": "AWS OpsWorks provides a simple and flexible way to create and manage stacks and applications.", "category": "Management and governance" }, { "name": "organizations", "displayName": "AWS Organizations", "description": "AWS Organizations is an account management service that lets you consolidate multiple AWS accounts into an organization that you create and centrally manage. ", "category": "Management and governance" }, { "name": "outposts", "displayName": "AWS Outposts", "description": "AWS Outposts brings native AWS services, infrastructure, and operating models to virtually any data center, co-location space, or on-premises facility. ", "category": "Compute" }, { "name": "personalize", "displayName": "Amazon Personalize", "description": "Real-time personalization and recommendations, based on the same technology used at Amazon.com.", "category": "Machine learning" }, { "name": "pinpoint", "displayName": "Amazon Pinpoint", "description": "Amazon Pinpoint helps you engage your customers by sending them email, SMS and voice messages, and push notifications.", "category": "Customer engagement" }, { "name": "polly", "displayName": "Amazon Polly", "description": "Amazon Polly is a Text-to-Speech (TTS) cloud service that converts text into lifelike speech.", "category": "Machine learning" }, { "name": "qldb", "displayName": "Amazon Quantum Ledger Database", "description": "Amazon Quantum Ledger Database (Amazon QLDB) is a fully managed ledger database that provides a transparent, immutable, and cryptographically verifiable transaction log owned by a central trusted authority. ", "category": "Database" }, { "name": "quicksight", "displayName": "Amazon QuickSight", "description": "Amazon QuickSight is a fast business analytics service to build visualizations, perform ad hoc analysis, and quickly get business insights from your data.", "category": "Analytics" }, { "name": "redshift", "displayName": "Amazon Redshift", "description": "Amazon Redshift is a fast, fully managed, petabyte-scale data warehouse service that makes it simple and cost-effective to efficiently analyze all your data using your existing business intelligence tools.", "category": "Analytics" }, { "name": "rekognition", "displayName": "Amazon Rekognition", "description": "Amazon Rekognition makes it easy to add image and video analysis to your applications.", "category": "Machine learning" }, { "name": "ram", "displayName": "AWS Resource Access Manager", "description": "AWS Resource Access Manager (AWS RAM) enables you to share your resources with any AWS account or organization in AWS Organizations. ", "category": "Security, identity, and compliance" }, { "name": "resource-groups", "displayName": "AWS Resource Groups and Tag Editor", "description": "AWS Resource Groups lets you organize AWS resources into groups, tag resources using virtually any criteria, and manage, monitor, and automate tasks on grouped resources.", "category": "Security, identity, and compliance" }, { "name": "robomaker", "displayName": "AWS RoboMaker", "description": "AWS RoboMaker is a service that makes it easy to develop, simulate, and deploy intelligent robotics applications at scale.", "category": "Robotics" }, { "name": "route53", "displayName": "Amazon Route 53", "description": "Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service.", "category": "Networking and content delivery" }, { "name": "savingsplans", "displayName": "Savings Plans", "description": "Savings Plans is a flexible pricing model that helps you save a significant percentage on Amazon EC2 and Fargate usage.", "category": "Billing and cost management" }, { "name": "secretsmanager", "displayName": "AWS Secrets Manager", "description": "AWS Secrets Manager helps you to securely encrypt, store, and retrieve credentials for your databases and other services.", "category": "Security, identity, and compliance" }, { "name": "sms", "displayName": "AWS Server Migration Service", "description": "AWS Server Migration Service (AWS SMS) combines data collection tools with automated server replication to speed the migration of on-premises servers to AWS.", "category": "Migration and transfer" }, { "name": "serverlessrepo", "displayName": "AWS Serverless Application Repository", "description": "The AWS Serverless Application Repository is a managed repository for serverless applications.", "category": "Compute" }, { "name": "servicecatalog", "displayName": "AWS Service Catalog", "description": "AWS Service Catalog enables IT administrators to create, manage, and distribute portfolios of approved products to end users, who can then access the products they need in a personalized portal.", "category": "Management and governance" }, { "name": "servicequotas", "displayName": "Service Quotas", "description": "Service Quotas is a service for viewing and managing your quotas easily and at scale as your AWS workloads grow. ", "category": "Management and governance" }, { "name": "shield", "displayName": "AWS Shield", "description": "AWS provides two levels of protection against DDoS attacks: AWS Shield Standard and AWS Shield Advanced.", "category": "Security, identity, and compliance" }, { "name": "signer", "displayName": "AWS Signer", "description": "With AWS Signer, you can cryptographically sign computer code for AWS Lambda applications and AWS-supported IoT devices.", "category": "Cryptography and PKI" }, { "name": "ses", "displayName": "Amazon Simple Email Service", "description": "Amazon Simple Email Service (Amazon SES) is an email sending and receiving service that provides an easy, cost-effective way for you to send email.", "category": "Customer engagement" }, { "name": "sns", "displayName": "Amazon Simple Notification Service", "description": "Amazon Simple Notification Service (Amazon SNS) is a web service that enables applications, end-users, and devices to instantly send and receive notifications from the cloud.", "category": "Application integration, front-end web and mobile" }, { "name": "sqs", "displayName": "Amazon Simple Queue Service", "description": "mazon Simple Queue Service (Amazon SQS) is a fully managed message queuing service that makes it easy to decouple and scale microservices, distributed systems, and serverless applications. ", "category": "Application integration" }, { "name": "glacier", "displayName": "Amazon Simple Storage Service Glacier", "description": "Amazon Simple Storage Service Glacier (Amazon S3 Glacier) is a storage service optimized for infrequently used data, or \"cold data.\"", "category": "Storage" }, { "name": "swf", "displayName": "Amazon Simple Workflow Service", "description": "Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that coordinate work across distributed components.", "category": "Application integration" }, { "name": "sdb", "displayName": "Amazon SimpleDB", "description": "Amazon SimpleDB is a highly available, scalable, and flexible non-relational data store that enables you to store and query data items using web service requests.", "category": "Database" }, { "name": "sso", "displayName": "AWS Single Sign-On", "description": "AWS Single Sign-On (AWS SSO) is a cloud-based service that simplifies managing SSO access to AWS accounts and business applications. ", "category": "Security, identity, and compliance" }, { "name": "snowball", "displayName": "AWS Snow Family", "description": "The AWS Snow Family is a service that helps customers who need to run operations in austere, non-data center environments, and in locations where there's no consistent network connectivity.", "category": "Migration and transfer" }, { "name": "states", "displayName": "AWS Step Functions", "description": "AWS Step Functions makes it easy to coordinate the components of distributed applications as a series of steps in a visual workflow.", "category": "Application integration" }, { "name": "storagegateway", "displayName": "AWS Storage Gateway", "description": "AWS Storage Gateway is a service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between your on-premises IT environment and the AWS storage infrastructure in the cloud.", "category": "Storage" }, { "name": "support", "displayName": "AWS Support", "description": "AWS Support provides a mix of tools and technology, people, and programs designed to proactively help you optimize performance, lower costs, and innovate faster.", "category": "Customer enablement services" }, { "name": "ssm", "displayName": "AWS Systems Manager", "description": "Use AWS Systems Manager to organize, monitor, and automate management tasks on your AWS resources.", "category": "Management and governance" }, { "name": "textract", "displayName": "Amazon Textract", "description": "Amazon Textract enables you to add document text detection and analysis to your applications.", "category": "Machine learning" }, { "name": "timestream", "displayName": "Amazon Timestream", "description": "With Amazon Timestream, you can easily store and analyze sensor data for IoT applications, metrics for DevOps use cases, and telemetry for application monitoring scenarios such as clickstream data analysis.", "category": "Database" }, { "name": "transcribe", "displayName": "Amazon Transcribe", "description": "Amazon Transcribe provides transcription services for your audio files. It uses advanced machine learning technologies to recognize spoken words and transcribe them into text.", "category": "Machine learning" }, { "name": "transfer", "displayName": "AWS Transfer Family", "description": "AWS Transfer Family is a secure transfer service that stores your data in Amazon S3 and simplifies the migration of Secure File Transfer Protocol (SFTP), File Transfer Protocol Secure (FTPS), and File Transfer Protocol (FTP) workflows to AWS.", "category": "Migration and transfer" }, { "name": "translate", "displayName": "Amazon Translate", "description": "Amazon Translate is a neural machine translation service for translating text to and from English across a breadth of supported languages.", "category": "Machine learning" }, { "name": "waf", "displayName": "AWS WAF", "description": "AWS WAF is a web application firewall that lets you monitor web requests that are forwarded to Amazon CloudFront distributions or an Application Load Balancer.", "category": "Security, identity, and compliance" }, { "name": "workdocs", "displayName": "Amazon WorkDocs", "description": "Amazon WorkDocs is a fully managed, secure enterprise storage and sharing service with strong administrative controls and feedback capabilities that improve user productivity.", "category": "End user computing" }, { "name": "worklink", "displayName": "Amazon WorkLink", "description": "Amazon WorkLink is a fully managed, cloud-based service that enables secure, one-click access to internal websites and web apps from mobile devices.", "category": "End user computing" }, { "name": "workmail", "displayName": "Amazon WorkMail", "description": "Amazon WorkMail is a managed email and calendaring service that offers strong security controls and support for existing desktop and mobile clients.", "category": "Business applications" }, { "name": "workspaces", "displayName": "Amazon WorkSpaces", "description": "Amazon WorkSpaces offers an easy way to provide a cloud-based desktop experience to your end users.", "category": "End user computing" }, { "name": "xray", "displayName": "AWS X-Ray", "description": "AWS X-Ray makes it easy for developers to analyze the behavior of their distributed applications by providing request tracing, exception collection, and profiling capabilities.", "category": "Developer tools" } ] } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/GetServicesInScope) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/GetServicesInScope) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/GetServicesInScope) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/GetServicesInScope) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/GetServicesInScope) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/GetServicesInScope) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/GetServicesInScope) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/GetServicesInScope) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/GetServicesInScope) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/GetServicesInScope) # GetSettings **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Gets the settings for a specified AWS account. ## Request Syntax ``` GET /settings/attribute HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [attribute](#API_GetSettings_RequestSyntax) ** The list of setting attribute enum values. Valid Values: `ALL | IS_AWS_ORG_ENABLED | SNS_TOPIC | DEFAULT_ASSESSMENT_REPORTS_DESTINATION | DEFAULT_PROCESS_OWNERS | EVIDENCE_FINDER_ENABLEMENT | DEREGISTRATION_POLICY | DEFAULT_EXPORT_DESTINATION` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "settings": { "defaultAssessmentReportsDestination": { "destination": "string", "destinationType": "string" }, "defaultExportDestination": { "destination": "string", "destinationType": "string" }, "defaultProcessOwners": [ { "roleArn": "string", "roleType": "string" } ], "deregistrationPolicy": { "deleteResources": "string" }, "evidenceFinderEnablement": { "backfillStatus": "string", "enablementStatus": "string", "error": "string", "eventDataStoreArn": "string" }, "isAwsOrgEnabled": boolean, "kmsKey": "string", "snsTopic": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [settings](#API_GetSettings_ResponseSyntax) ** The settings object that holds all supported Audit Manager settings. Type: [Settings](API_Settings.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ## Examples ### Confirming the status of evidence finder This is an example response for the `GetSettings` API operation, where the `attribute` parameter is set to `EVIDENCE_FINDER_ENABLEMENT`. This response returns the following evidence finder settings: + `eventDataStoreArn` shows the ARN of the event data store that was created when evidence finder was enabled. + `enablementStatus` shows the current status of evidence finder. In this case, `ENABLED` indicates that evidence finder was successfully enabled. + `backfillStatus` shows the current status of the evidence data backfill. In this case, `IN_PROGRESS` indicates that the backfill is not yet complete. #### Sample Response ``` { "settings": { "evidenceFinderEnablement": { "eventDataStoreArn": "arn:aws:cloudtrail:us-east-1:111122223333:eventdatastore/1q2w3e4r-2w3e-4r5t-6y7u-1q2w3e4r5t6y", "enablementStatus": "ENABLED", "backfillStatus": "IN_PROGRESS" } } } ``` ### Reviewing your data retention settings This is an example response for the `GetSettings` API operation, where the `attribute` parameter is set to `DEREGISTRATION_POLICY`. This response returns your current data retention preferences. In this case, `deleteResources` has a value of `DEFAULT`. This indicates that your Audit Manager data is subject to default data retention policies. For more information about data retention, see [Data Protection](https://docs.aws.amazon.com/audit-manager/latest/userguide/data-protection.html) in the * AWS Audit Manager User Guide.* #### Sample Response ``` { "settings": { "deregistrationPolicy": { "deleteResources": "DEFAULT" } } } ``` ### Reviewing your Audit Manager notification settings This is an example response for the `GetSettings` API operation, where the `attribute` parameter is set to `SNS_TOPIC`. If an SNS topic is in use, the response returns the ARN for that topic. #### Sample Response ``` { "settings": { "snsTopic": "arn:aws:sns:us-east-1:111122223333:my-assessment-topic" } } ``` ### Reviewing the default audit owners for your Audit Manager assessments This is an example response for the `GetSettings` API operation, where the `attribute` parameter is set to `DEFAULT_PROCESS_OWNERS`. If one or more default audit owners were specified, the response returns the ARN for each audit owner's role. #### Sample Response ``` { "settings": { "defaultProcessOwners": [ { "roleType": "PROCESS_OWNER", "roleArn": "arn:aws:iam::111122223333:role/Administrator" } ] } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/GetSettings) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/GetSettings) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/GetSettings) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/GetSettings) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/GetSettings) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/GetSettings) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/GetSettings) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/GetSettings) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/GetSettings) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/GetSettings) # ListAssessmentControlInsightsByControlDomain **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Lists the latest analytics data for controls within a specific control domain and a specific active assessment. **Note** 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. ## Request Syntax ``` GET /insights/controls-by-assessment?assessmentId=assessmentId&controlDomainId=controlDomainId&maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_ListAssessmentControlInsightsByControlDomain_RequestSyntax) ** The unique identifier for the active assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [controlDomainId](#API_ListAssessmentControlInsightsByControlDomain_RequestSyntax) ** The unique identifier for the control domain. Audit Manager supports the control domains that are provided by AWS Control Catalog. For information about how to find a list of available control domains, see [https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html](https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html) in the AWS Control Catalog API Reference. Length Constraints: Minimum length of 13. Maximum length of 2048. Pattern: `^arn:.*:controlcatalog:.*:.*:domain/.*|UNCATEGORIZED|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [maxResults](#API_ListAssessmentControlInsightsByControlDomain_RequestSyntax) ** Represents the maximum number of results on a page or for an API request call. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_ListAssessmentControlInsightsByControlDomain_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "controlInsightsByAssessment": [ { "controlSetName": "string", "evidenceInsights": { "compliantEvidenceCount": number, "inconclusiveEvidenceCount": number, "noncompliantEvidenceCount": number }, "id": "string", "lastUpdated": number, "name": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [controlInsightsByAssessment](#API_ListAssessmentControlInsightsByControlDomain_ResponseSyntax) ** The assessment control analytics data that the `ListAssessmentControlInsightsByControlDomain` API returned. Type: Array of [ControlInsightsMetadataByAssessmentItem](API_ControlInsightsMetadataByAssessmentItem.md) objects ** [nextToken](#API_ListAssessmentControlInsightsByControlDomain_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/ListAssessmentControlInsightsByControlDomain) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/ListAssessmentControlInsightsByControlDomain) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/ListAssessmentControlInsightsByControlDomain) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/ListAssessmentControlInsightsByControlDomain) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/ListAssessmentControlInsightsByControlDomain) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/ListAssessmentControlInsightsByControlDomain) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/ListAssessmentControlInsightsByControlDomain) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/ListAssessmentControlInsightsByControlDomain) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/ListAssessmentControlInsightsByControlDomain) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/ListAssessmentControlInsightsByControlDomain) # ListAssessmentFrameworks **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Returns a list of the frameworks that are available in the Audit Manager framework library. ## Request Syntax ``` GET /assessmentFrameworks?frameworkType=frameworkType&maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [frameworkType](#API_ListAssessmentFrameworks_RequestSyntax) ** The type of framework, such as a standard framework or a custom framework. Valid Values: `Standard | Custom` Required: Yes ** [maxResults](#API_ListAssessmentFrameworks_RequestSyntax) ** Represents the maximum number of results on a page or for an API request call. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_ListAssessmentFrameworks_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "frameworkMetadataList": [ { "arn": "string", "complianceType": "string", "controlsCount": number, "controlSetsCount": number, "createdAt": number, "description": "string", "id": "string", "lastUpdatedAt": number, "logo": "string", "name": "string", "type": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [frameworkMetadataList](#API_ListAssessmentFrameworks_ResponseSyntax) ** A list of metadata that the `ListAssessmentFrameworks` API returns for each framework. Type: Array of [AssessmentFrameworkMetadata](API_AssessmentFrameworkMetadata.md) objects ** [nextToken](#API_ListAssessmentFrameworks_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## Examples ### Retrieving a list of custom frameworks This shows a sample response that the `ListAssessmentFrameworks` operation might return if you had two custom frameworks in your AWS account. #### Sample Response ``` { "frameworkMetadataList": [ { "arn": "arn:aws:auditmanager:us-east-1:111122223333:assessmentFramework/a1b2c3d4-5678-90ab-cdef-example11111", "id": "a1b2c3d4-5678-90ab-cdef-example11111", "type": "Custom", "name": "My custom framework", "description": "My custom framework for internal audits", "complianceType": "Internal", "controlsCount": 3, "controlSetsCount": 1, "createdAt": "2022-03-29T14:57:31.634000-07:00", "lastUpdatedAt": "2022-03-29T14:57:31.635000-07:00" }, { "arn": "arn:aws:auditmanager:us-east-1:111122223333:assessmentFramework/a1b2c3d4-5678-90ab-cdef-example22222", "id": "a1b2c3d4-5678-90ab-cdef-example22222", "type": "Custom", "name": "My custom HIPAA framework", "description": "My custom framework for HIPAA audits", "complianceType": "HIPAA", "controlsCount": 4, "controlSetsCount": 2, "createdAt": "2021-03-02T16:35:24.177000-08:00", "lastUpdatedAt": "2022-01-10T14:32:18.855000-08:00" } ] } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/ListAssessmentFrameworks) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/ListAssessmentFrameworks) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/ListAssessmentFrameworks) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/ListAssessmentFrameworks) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/ListAssessmentFrameworks) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/ListAssessmentFrameworks) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/ListAssessmentFrameworks) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/ListAssessmentFrameworks) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/ListAssessmentFrameworks) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/ListAssessmentFrameworks) # ListAssessmentFrameworkShareRequests **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Returns a list of sent or received share requests for custom frameworks in AWS Audit Manager. ## Request Syntax ``` GET /assessmentFrameworkShareRequests?maxResults=maxResults&nextToken=nextToken&requestType=requestType HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListAssessmentFrameworkShareRequests_RequestSyntax) ** Represents the maximum number of results on a page or for an API request call. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_ListAssessmentFrameworkShareRequests_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ** [requestType](#API_ListAssessmentFrameworkShareRequests_RequestSyntax) ** Specifies whether the share request is a sent request or a received request. Valid Values: `SENT | RECEIVED` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "assessmentFrameworkShareRequests": [ { "comment": "string", "complianceType": "string", "creationTime": number, "customControlsCount": number, "destinationAccount": "string", "destinationRegion": "string", "expirationTime": number, "frameworkDescription": "string", "frameworkId": "string", "frameworkName": "string", "id": "string", "lastUpdated": number, "sourceAccount": "string", "standardControlsCount": number, "status": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [assessmentFrameworkShareRequests](#API_ListAssessmentFrameworkShareRequests_ResponseSyntax) ** The list of share requests that the `ListAssessmentFrameworkShareRequests` API returned. Type: Array of [AssessmentFrameworkShareRequest](API_AssessmentFrameworkShareRequest.md) objects ** [nextToken](#API_ListAssessmentFrameworkShareRequests_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/ListAssessmentFrameworkShareRequests) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/ListAssessmentFrameworkShareRequests) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/ListAssessmentFrameworkShareRequests) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/ListAssessmentFrameworkShareRequests) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/ListAssessmentFrameworkShareRequests) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/ListAssessmentFrameworkShareRequests) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/ListAssessmentFrameworkShareRequests) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/ListAssessmentFrameworkShareRequests) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/ListAssessmentFrameworkShareRequests) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/ListAssessmentFrameworkShareRequests) # ListAssessmentReports **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Returns a list of assessment reports created in AWS Audit Manager. ## Request Syntax ``` GET /assessmentReports?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListAssessmentReports_RequestSyntax) ** Represents the maximum number of results on a page or for an API request call. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_ListAssessmentReports_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "assessmentReports": [ { "assessmentId": "string", "assessmentName": "string", "author": "string", "creationTime": number, "description": "string", "id": "string", "name": "string", "status": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [assessmentReports](#API_ListAssessmentReports_ResponseSyntax) ** The list of assessment reports that the `ListAssessmentReports` API returned. Type: Array of [AssessmentReportMetadata](API_AssessmentReportMetadata.md) objects ** [nextToken](#API_ListAssessmentReports_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/ListAssessmentReports) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/ListAssessmentReports) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/ListAssessmentReports) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/ListAssessmentReports) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/ListAssessmentReports) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/ListAssessmentReports) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/ListAssessmentReports) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/ListAssessmentReports) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/ListAssessmentReports) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/ListAssessmentReports) # ListAssessments **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Returns a list of current and past assessments from AWS Audit Manager. ## Request Syntax ``` GET /assessments?maxResults=maxResults&nextToken=nextToken&status=status HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListAssessments_RequestSyntax) ** Represents the maximum number of results on a page or for an API request call. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_ListAssessments_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ** [status](#API_ListAssessments_RequestSyntax) ** The current status of the assessment. Valid Values: `ACTIVE | INACTIVE` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "assessmentMetadata": [ { "complianceType": "string", "creationTime": number, "delegations": [ { "assessmentId": "string", "assessmentName": "string", "comment": "string", "controlSetId": "string", "createdBy": "string", "creationTime": number, "id": "string", "lastUpdated": number, "roleArn": "string", "roleType": "string", "status": "string" } ], "id": "string", "lastUpdated": number, "name": "string", "roles": [ { "roleArn": "string", "roleType": "string" } ], "status": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [assessmentMetadata](#API_ListAssessments_ResponseSyntax) ** The metadata that the `ListAssessments` API returns for each assessment. Type: Array of [AssessmentMetadataItem](API_AssessmentMetadataItem.md) objects ** [nextToken](#API_ListAssessments_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## Examples ### Retrieving a list of assessments This shows a sample response that the `ListAssessments` operation might return if you had three active assessments. #### Sample Response ``` { "assessmentMetadata": [ { "name": "my GxP assessment", "id": "a1b2c3d4-5678-90ab-cdef-example11111", "complianceType": "GxP 21 CFR Part 11", "status": "ACTIVE", "roles": [ { "roleType": "PROCESS_OWNER", "roleArn": "arn:aws:iam::111122223333:role/Administrator" } ], "delegations": [], "creationTime": "2022-12-20T16:38:09.215000-08:00", "lastUpdated": "2022-12-20T16:38:09.397000-08:00" }, { "name": "My control tower assessment", "id": "a1b2c3d4-5678-90ab-cdef-example22222", "complianceType": "AWS Control Tower Guardrails", "status": "ACTIVE", "roles": [ { "roleType": "PROCESS_OWNER", "roleArn": "arn:aws:iam::111122223333:role/Administrator" } ], "delegations": [], "creationTime": "2022-02-23T10:25:41.083000-08:00", "lastUpdated": "2022-02-23T17:06:54.132000-08:00" }, { "name": "My PCI DSS assessment", "id": "a1b2c3d4-5678-90ab-cdef-example33333", "complianceType": "PCI DSS", "status": "ACTIVE", "roles": [ { "roleType": "PROCESS_OWNER", "roleArn": "arn:aws:iam::111122223333:role/Administrator" } ], "delegations": [], "creationTime": "2022-02-23T09:34:42.850000-08:00", "lastUpdated": "2022-02-23T09:34:42.982000-08:00" } ] } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/ListAssessments) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/ListAssessments) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/ListAssessments) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/ListAssessments) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/ListAssessments) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/ListAssessments) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/ListAssessments) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/ListAssessments) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/ListAssessments) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/ListAssessments) # ListControlDomainInsights **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Lists the latest analytics data for control domains across all of your active assessments. Audit Manager supports the control domains that are provided by AWS Control Catalog. For information about how to find a list of available control domains, see [https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html](https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html) in the AWS Control Catalog API Reference. **Note** 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. ## Request Syntax ``` GET /insights/control-domains?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListControlDomainInsights_RequestSyntax) ** Represents the maximum number of results on a page or for an API request call. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_ListControlDomainInsights_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "controlDomainInsights": [ { "controlsCountByNoncompliantEvidence": number, "evidenceInsights": { "compliantEvidenceCount": number, "inconclusiveEvidenceCount": number, "noncompliantEvidenceCount": number }, "id": "string", "lastUpdated": number, "name": "string", "totalControlsCount": number } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [controlDomainInsights](#API_ListControlDomainInsights_ResponseSyntax) ** The control domain analytics data that the `ListControlDomainInsights` API returned. Type: Array of [ControlDomainInsights](API_ControlDomainInsights.md) objects ** [nextToken](#API_ListControlDomainInsights_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/ListControlDomainInsights) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/ListControlDomainInsights) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/ListControlDomainInsights) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/ListControlDomainInsights) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/ListControlDomainInsights) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/ListControlDomainInsights) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/ListControlDomainInsights) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/ListControlDomainInsights) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/ListControlDomainInsights) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/ListControlDomainInsights) # ListControlDomainInsightsByAssessment **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Lists analytics data for control domains within a specified active assessment. Audit Manager supports the control domains that are provided by AWS Control Catalog. For information about how to find a list of available control domains, see [https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html](https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html) in the AWS Control Catalog API Reference. **Note** 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. ## Request Syntax ``` GET /insights/control-domains-by-assessment?assessmentId=assessmentId&maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_ListControlDomainInsightsByAssessment_RequestSyntax) ** The unique identifier for the active assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [maxResults](#API_ListControlDomainInsightsByAssessment_RequestSyntax) ** Represents the maximum number of results on a page or for an API request call. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_ListControlDomainInsightsByAssessment_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "controlDomainInsights": [ { "controlsCountByNoncompliantEvidence": number, "evidenceInsights": { "compliantEvidenceCount": number, "inconclusiveEvidenceCount": number, "noncompliantEvidenceCount": number }, "id": "string", "lastUpdated": number, "name": "string", "totalControlsCount": number } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [controlDomainInsights](#API_ListControlDomainInsightsByAssessment_ResponseSyntax) ** The control domain analytics data that the `ListControlDomainInsightsByAssessment` API returned. Type: Array of [ControlDomainInsights](API_ControlDomainInsights.md) objects ** [nextToken](#API_ListControlDomainInsightsByAssessment_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/ListControlDomainInsightsByAssessment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/ListControlDomainInsightsByAssessment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/ListControlDomainInsightsByAssessment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/ListControlDomainInsightsByAssessment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/ListControlDomainInsightsByAssessment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/ListControlDomainInsightsByAssessment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/ListControlDomainInsightsByAssessment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/ListControlDomainInsightsByAssessment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/ListControlDomainInsightsByAssessment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/ListControlDomainInsightsByAssessment) # ListControlInsightsByControlDomain **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Lists the latest analytics data for controls within a specific control domain across all active assessments. **Note** 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. ## Request Syntax ``` GET /insights/controls?controlDomainId=controlDomainId&maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [controlDomainId](#API_ListControlInsightsByControlDomain_RequestSyntax) ** The unique identifier for the control domain. Audit Manager supports the control domains that are provided by AWS Control Catalog. For information about how to find a list of available control domains, see [https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html](https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html) in the AWS Control Catalog API Reference. Length Constraints: Minimum length of 13. Maximum length of 2048. Pattern: `^arn:.*:controlcatalog:.*:.*:domain/.*|UNCATEGORIZED|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [maxResults](#API_ListControlInsightsByControlDomain_RequestSyntax) ** Represents the maximum number of results on a page or for an API request call. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_ListControlInsightsByControlDomain_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "controlInsightsMetadata": [ { "evidenceInsights": { "compliantEvidenceCount": number, "inconclusiveEvidenceCount": number, "noncompliantEvidenceCount": number }, "id": "string", "lastUpdated": number, "name": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [controlInsightsMetadata](#API_ListControlInsightsByControlDomain_ResponseSyntax) ** The control analytics data that the `ListControlInsightsByControlDomain` API returned. Type: Array of [ControlInsightsMetadataItem](API_ControlInsightsMetadataItem.md) objects ** [nextToken](#API_ListControlInsightsByControlDomain_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/ListControlInsightsByControlDomain) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/ListControlInsightsByControlDomain) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/ListControlInsightsByControlDomain) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/ListControlInsightsByControlDomain) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/ListControlInsightsByControlDomain) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/ListControlInsightsByControlDomain) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/ListControlInsightsByControlDomain) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/ListControlInsightsByControlDomain) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/ListControlInsightsByControlDomain) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/ListControlInsightsByControlDomain) # ListControls **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Returns a list of controls from AWS Audit Manager. ## Request Syntax ``` GET /controls?controlCatalogId=controlCatalogId&controlType=controlType&maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [controlCatalogId](#API_ListControls_RequestSyntax) ** A filter that narrows the list of controls to a specific resource from the AWS Control Catalog. To use this parameter, specify the ARN of the Control Catalog resource. You can specify either a control domain, a control objective, or a common control. For information about how to find the ARNs for these resources, see [https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html](https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html), [https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListObjectives.html](https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListObjectives.html), and [https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListCommonControls.html](https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListCommonControls.html). You can only filter by one Control Catalog resource at a time. Specifying multiple resource ARNs isn’t currently supported. If you want to filter by more than one ARN, we recommend that you run the `ListControls` operation separately for each ARN. Alternatively, specify `UNCATEGORIZED` to list controls that aren't mapped to a Control Catalog resource. For example, this operation might return a list of custom controls that don't belong to any control domain or control objective. Length Constraints: Minimum length of 13. Maximum length of 2048. Pattern: `^arn:.*:controlcatalog:.*|UNCATEGORIZED` ** [controlType](#API_ListControls_RequestSyntax) ** A filter that narrows the list of controls to a specific type. Valid Values: `Standard | Custom | Core` Required: Yes ** [maxResults](#API_ListControls_RequestSyntax) ** The maximum number of results on a page or for an API request call. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_ListControls_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "controlMetadataList": [ { "arn": "string", "controlSources": "string", "createdAt": number, "id": "string", "lastUpdatedAt": number, "name": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [controlMetadataList](#API_ListControls_ResponseSyntax) ** A list of metadata that the `ListControls` API returns for each control. Type: Array of [ControlMetadata](API_ControlMetadata.md) objects ** [nextToken](#API_ListControls_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## Examples ### Retrieving a list of custom controls This shows a sample response that the `ListControls` operation might return if you had three custom controls. #### Sample Response ``` { "controlMetadataList": [ { "arn": "arn:aws:auditmanager:us-east-1:111122223333:control/a1b2c3d4-5678-90ab-cdef-example11111", "id": "a1b2c3d4-5678-90ab-cdef-example11111", "name": "Example custom control", "controlSources": "AWS API calls, AWS Config, Manual", "createdAt": "2022-03-28T18:08:24.446000-07:00", "lastUpdatedAt": "2022-03-28T18:08:24.446000-07:00" }, { "arn": "arn:aws:auditmanager:us-east-1:111122223333:control/a1b2c3d4-5678-90ab-cdef-example22222", "id": "a1b2c3d4-5678-90ab-cdef-example22222", "name": "Another custom control", "controlSources": "AWS API calls, AWS Config, Manual", "createdAt": "2022-03-28T17:45:15.622000-07:00", "lastUpdatedAt": "2022-03-28T18:06:56.171000-07:00" }, { "arn": "arn:aws:auditmanager:us-east-1:111122223333:control/a1b2c3d4-5678-90ab-cdef-example33333", "id": "a1b2c3d4-5678-90ab-cdef-example33333", "name": "Custom control - CloudTrail Volume Events", "controlSources": "AWS CloudTrail", "createdAt": "2021-03-08T11:31:12.468000-08:00", "lastUpdatedAt": "2022-01-10T14:13:37.979000-08:00" } ] } ``` ### Retrieving a list of core controls This example shows how you can use the `ListControls` operation to return a filtered list of core controls that fall under a specific control domain (*Asset management*). **To retrieve a list of core controls** 1. Use the [https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html](https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html) operation to see the control domains that you can use as filters. Find the control domain that you want to use as a filter (*Asset management*), and take note of its ARN. 1. Use the `ListControls` operation and use the following attributes as filters: + Use `ControlType` and specify `Core` as the value. + Use `ControlCatalogId` and specify the control domain ARN that you got from step 1. The sample request uses the following ARN as a filter: + This ARN represents the Asset management control domain: `arn:aws:controlcatalog:::domain/d4msesd9vvmzmmuvlv06m92uq` The sample response shows the results that the `ListControls` operation might return if two core controls matched the domain criteria of *Asset management*. #### Sample Request ``` aws auditmanager list-controls --controlType Core --controlCatalogId "arn:aws:controlcatalog:::domain/d4msesd9vvmzmmuvlv06m92uq" ``` #### Sample Response ``` { "controlMetadataList": [ { "arn": "arn:aws:auditmanager:us-west-2::control/a1b2c3d4-5678-90ab-cdef-example11111", "controlSources": "Manual", "createdAt": 1.681511681787E9, "id": "a1b2c3d4-5678-90ab-cdef-example11111", "lastUpdatedAt": 1.681511681788E9, "name": "164.312(a)(2)(iii)" }, { "arn": "arn:aws:auditmanager:us-west-2::control/a1b2c3d4-5678-90ab-cdef-example22222", "controlSources": "AWS API calls, AWS Config, AWS Security Hub", "createdAt": 1.681511681787E9, "id": "a1b2c3d4-5678-90ab-cdef-example22222", "lastUpdatedAt": 1.681511681788E9, "name": "164.312(c)(1)" } ], "nextToken": "string" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/ListControls) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/ListControls) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/ListControls) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/ListControls) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/ListControls) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/ListControls) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/ListControls) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/ListControls) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/ListControls) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/ListControls) # ListKeywordsForDataSource **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Returns a list of keywords that are pre-mapped to the specified control data source. ## Request Syntax ``` GET /dataSourceKeywords?maxResults=maxResults&nextToken=nextToken&source=source HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListKeywordsForDataSource_RequestSyntax) ** Represents the maximum number of results on a page or for an API request call. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_ListKeywordsForDataSource_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ** [source](#API_ListKeywordsForDataSource_RequestSyntax) ** The control mapping data source that the keywords apply to. Valid Values: `AWS_Cloudtrail | AWS_Config | AWS_Security_Hub | AWS_API_Call | MANUAL` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "keywords": [ "string" ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [keywords](#API_ListKeywordsForDataSource_ResponseSyntax) ** The list of keywords for the control mapping source. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `^[a-zA-Z_0-9-\s().:\/]+$` ** [nextToken](#API_ListKeywordsForDataSource_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/ListKeywordsForDataSource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/ListKeywordsForDataSource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/ListKeywordsForDataSource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/ListKeywordsForDataSource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/ListKeywordsForDataSource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/ListKeywordsForDataSource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/ListKeywordsForDataSource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/ListKeywordsForDataSource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/ListKeywordsForDataSource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/ListKeywordsForDataSource) # ListNotifications **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Returns a list of all AWS Audit Manager notifications. ## Request Syntax ``` GET /notifications?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListNotifications_RequestSyntax) ** Represents the maximum number of results on a page or for an API request call. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_ListNotifications_RequestSyntax) ** The pagination token that's used to fetch the next set of results. Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "notifications": [ { "assessmentId": "string", "assessmentName": "string", "controlSetId": "string", "controlSetName": "string", "description": "string", "eventTime": number, "id": "string", "source": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [nextToken](#API_ListNotifications_ResponseSyntax) ** The pagination token that's used to fetch the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[A-Za-z0-9+\/=]*$` ** [notifications](#API_ListNotifications_ResponseSyntax) ** The returned list of notifications. Type: Array of [Notification](API_Notification.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/ListNotifications) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/ListNotifications) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/ListNotifications) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/ListNotifications) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/ListNotifications) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/ListNotifications) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/ListNotifications) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/ListNotifications) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/ListNotifications) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/ListNotifications) # ListTagsForResource **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Returns a list of tags for the specified resource in AWS Audit Manager. ## Request Syntax ``` GET /tags/resourceArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [resourceArn](#API_ListTagsForResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `^arn:.*:auditmanager:.*` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [tags](#API_ListTagsForResource_ResponseSyntax) ** The list of tags that the `ListTagsForResource` API returned. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `.{0,255}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/ListTagsForResource) # RegisterAccount **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Enables AWS Audit Manager for the specified AWS account. ## Request Syntax ``` POST /account/registerAccount HTTP/1.1 Content-type: application/json { "delegatedAdminAccount": "string", "kmsKey": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [delegatedAdminAccount](#API_RegisterAccount_RequestSyntax) ** The delegated administrator account for Audit Manager. Type: String Length Constraints: Fixed length of 12. Pattern: `^[0-9]{12}$` Required: No ** [kmsKey](#API_RegisterAccount_RequestSyntax) ** The AWS KMS key details. Type: String Length Constraints: Minimum length of 7. Maximum length of 2048. Pattern: `^arn:.*:kms:.*|DEFAULT` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [status](#API_RegisterAccount_ResponseSyntax) ** The status of the account registration request. Type: String Valid Values: `ACTIVE | INACTIVE | PENDING_ACTIVATION` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ThrottlingException ** The request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/RegisterAccount) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/RegisterAccount) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/RegisterAccount) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/RegisterAccount) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/RegisterAccount) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/RegisterAccount) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/RegisterAccount) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/RegisterAccount) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/RegisterAccount) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/RegisterAccount) # RegisterOrganizationAdminAccount **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Enables an AWS account within the organization as the delegated administrator for AWS Audit Manager. ## Request Syntax ``` POST /account/registerOrganizationAdminAccount HTTP/1.1 Content-type: application/json { "adminAccountId": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [adminAccountId](#API_RegisterOrganizationAdminAccount_RequestSyntax) ** The identifier for the delegated administrator account. Type: String Length Constraints: Fixed length of 12. Pattern: `^[0-9]{12}$` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "adminAccountId": "string", "organizationId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [adminAccountId](#API_RegisterOrganizationAdminAccount_ResponseSyntax) ** The identifier for the delegated administrator account. Type: String Length Constraints: Fixed length of 12. Pattern: `^[0-9]{12}$` ** [organizationId](#API_RegisterOrganizationAdminAccount_ResponseSyntax) ** The identifier for the organization. Type: String Length Constraints: Minimum length of 12. Maximum length of 34. Pattern: `o-[a-z0-9]{10,32}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ThrottlingException ** The request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/RegisterOrganizationAdminAccount) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/RegisterOrganizationAdminAccount) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/RegisterOrganizationAdminAccount) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/RegisterOrganizationAdminAccount) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/RegisterOrganizationAdminAccount) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/RegisterOrganizationAdminAccount) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/RegisterOrganizationAdminAccount) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/RegisterOrganizationAdminAccount) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/RegisterOrganizationAdminAccount) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/RegisterOrganizationAdminAccount) # StartAssessmentFrameworkShare **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Creates a share request for a custom framework in AWS 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) AWS Region. Audit Manager also stores a backup of the same snapshot in the US West (Oregon) AWS 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](https://docs.aws.amazon.com/audit-manager/latest/userguide/framework-sharing.html#framework-sharing-resend), 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 AWS account under the AWS Region that was specified in the share request. **Important** When you invoke the `StartAssessmentFrameworkShare` API, you are about to share a custom framework with another AWS 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 AWS, 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](https://docs.aws.amazon.com/audit-manager/latest/userguide/share-custom-framework-concepts-and-terminology.html#eligibility) in the * AWS Audit Manager User Guide*. ## Request Syntax ``` POST /assessmentFrameworks/frameworkId/shareRequests HTTP/1.1 Content-type: application/json { "comment": "string", "destinationAccount": "string", "destinationRegion": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [frameworkId](#API_StartAssessmentFrameworkShare_RequestSyntax) ** The unique identifier for the custom framework to be shared. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [comment](#API_StartAssessmentFrameworkShare_RequestSyntax) ** An optional comment from the sender about the share request. Type: String Length Constraints: Maximum length of 500. Pattern: `^[\w\W\s\S]*$` Required: No ** [destinationAccount](#API_StartAssessmentFrameworkShare_RequestSyntax) ** The AWS account of the recipient. Type: String Length Constraints: Fixed length of 12. Pattern: `^[0-9]{12}$` Required: Yes ** [destinationRegion](#API_StartAssessmentFrameworkShare_RequestSyntax) ** The AWS Region of the recipient. Type: String Pattern: `^[a-z]{2}-[a-z]+-[0-9]{1}$` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "assessmentFrameworkShareRequest": { "comment": "string", "complianceType": "string", "creationTime": number, "customControlsCount": number, "destinationAccount": "string", "destinationRegion": "string", "expirationTime": number, "frameworkDescription": "string", "frameworkId": "string", "frameworkName": "string", "id": "string", "lastUpdated": number, "sourceAccount": "string", "standardControlsCount": number, "status": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [assessmentFrameworkShareRequest](#API_StartAssessmentFrameworkShare_ResponseSyntax) ** The share request that's created by the `StartAssessmentFrameworkShare` API. Type: [AssessmentFrameworkShareRequest](API_AssessmentFrameworkShareRequest.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/StartAssessmentFrameworkShare) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/StartAssessmentFrameworkShare) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/StartAssessmentFrameworkShare) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/StartAssessmentFrameworkShare) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/StartAssessmentFrameworkShare) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/StartAssessmentFrameworkShare) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/StartAssessmentFrameworkShare) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/StartAssessmentFrameworkShare) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/StartAssessmentFrameworkShare) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/StartAssessmentFrameworkShare) # TagResource **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Tags the specified resource in AWS Audit Manager. ## Request Syntax ``` POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [resourceArn](#API_TagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `^arn:.*:auditmanager:.*` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [tags](#API_TagResource_RequestSyntax) ** The tags that are associated with the resource. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `.{0,255}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/TagResource) # UntagResource **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Removes a tag from a resource in AWS Audit Manager. ## Request Syntax ``` DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [resourceArn](#API_UntagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the specified resource. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `^arn:.*:auditmanager:.*` Required: Yes ** [tagKeys](#API_UntagResource_RequestSyntax) ** The name or key of the tag. Array Members: Minimum number of 1 item. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/UntagResource) # UpdateAssessment **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Edits an Audit Manager assessment. ## Request Syntax ``` PUT /assessments/assessmentId HTTP/1.1 Content-type: application/json { "assessmentDescription": "string", "assessmentName": "string", "assessmentReportsDestination": { "destination": "string", "destinationType": "string" }, "roles": [ { "roleArn": "string", "roleType": "string" } ], "scope": { "awsAccounts": [ { "emailAddress": "string", "id": "string", "name": "string" } ], "awsServices": [ { "serviceName": "string" } ] } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_UpdateAssessment_RequestSyntax) ** The unique identifier for the assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [assessmentDescription](#API_UpdateAssessment_RequestSyntax) ** The description of the assessment. Type: String Length Constraints: Maximum length of 1000. Pattern: `^[\w\W\s\S]*$` Required: No ** [assessmentName](#API_UpdateAssessment_RequestSyntax) ** The name of the assessment to be updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 300. Pattern: `^[^\\]*$` Required: No ** [assessmentReportsDestination](#API_UpdateAssessment_RequestSyntax) ** The assessment report storage destination for the assessment that's being updated. Type: [AssessmentReportsDestination](API_AssessmentReportsDestination.md) object Required: No ** [roles](#API_UpdateAssessment_RequestSyntax) ** The list of roles for the assessment. Type: Array of [Role](API_Role.md) objects Required: No ** [scope](#API_UpdateAssessment_RequestSyntax) ** The scope of the assessment. Type: [Scope](API_Scope.md) object Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "assessment": { "arn": "string", "awsAccount": { "emailAddress": "string", "id": "string", "name": "string" }, "framework": { "arn": "string", "controlSets": [ { "controls": [ { "assessmentReportEvidenceCount": number, "comments": [ { "authorName": "string", "commentBody": "string", "postedDate": number } ], "description": "string", "evidenceCount": number, "evidenceSources": [ "string" ], "id": "string", "name": "string", "response": "string", "status": "string" } ], "delegations": [ { "assessmentId": "string", "assessmentName": "string", "comment": "string", "controlSetId": "string", "createdBy": "string", "creationTime": number, "id": "string", "lastUpdated": number, "roleArn": "string", "roleType": "string", "status": "string" } ], "description": "string", "id": "string", "manualEvidenceCount": number, "roles": [ { "roleArn": "string", "roleType": "string" } ], "status": "string", "systemEvidenceCount": number } ], "id": "string", "metadata": { "complianceType": "string", "description": "string", "logo": "string", "name": "string" } }, "metadata": { "assessmentReportsDestination": { "destination": "string", "destinationType": "string" }, "complianceType": "string", "creationTime": number, "delegations": [ { "assessmentId": "string", "assessmentName": "string", "comment": "string", "controlSetId": "string", "createdBy": "string", "creationTime": number, "id": "string", "lastUpdated": number, "roleArn": "string", "roleType": "string", "status": "string" } ], "description": "string", "id": "string", "lastUpdated": number, "name": "string", "roles": [ { "roleArn": "string", "roleType": "string" } ], "scope": { "awsAccounts": [ { "emailAddress": "string", "id": "string", "name": "string" } ], "awsServices": [ { "serviceName": "string" } ] }, "status": "string" }, "tags": { "string" : "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [assessment](#API_UpdateAssessment_ResponseSyntax) ** The response object for the `UpdateAssessment` API. This is the name of the updated assessment. Type: [Assessment](API_Assessment.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ServiceQuotaExceededException ** You've reached your account quota for this resource type. To perform the requested action, delete some existing resources or [request a quota increase](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) from the Service Quotas console. For a list of Audit Manager service quotas, see [Quotas and restrictions for AWS Audit Manager](https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html). HTTP Status Code: 402 ** ThrottlingException ** The request was denied due to request throttling. HTTP Status Code: 429 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/UpdateAssessment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/UpdateAssessment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/UpdateAssessment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/UpdateAssessment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/UpdateAssessment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/UpdateAssessment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/UpdateAssessment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/UpdateAssessment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/UpdateAssessment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/UpdateAssessment) # UpdateAssessmentControl **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Updates a control within an assessment in AWS Audit Manager. ## Request Syntax ``` PUT /assessments/assessmentId/controlSets/controlSetId/controls/controlId HTTP/1.1 Content-type: application/json { "commentBody": "string", "controlStatus": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_UpdateAssessmentControl_RequestSyntax) ** The unique identifier for the assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [controlId](#API_UpdateAssessmentControl_RequestSyntax) ** The unique identifier for the control. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [controlSetId](#API_UpdateAssessmentControl_RequestSyntax) ** The unique identifier for the control set. Length Constraints: Minimum length of 1. Maximum length of 300. Pattern: `^[\w\W\s\S]*$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [commentBody](#API_UpdateAssessmentControl_RequestSyntax) ** The comment body text for the control. Type: String Length Constraints: Maximum length of 500. Pattern: `^[\w\W\s\S]*$` Required: No ** [controlStatus](#API_UpdateAssessmentControl_RequestSyntax) ** The status of the control. Type: String Valid Values: `UNDER_REVIEW | REVIEWED | INACTIVE` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "control": { "assessmentReportEvidenceCount": number, "comments": [ { "authorName": "string", "commentBody": "string", "postedDate": number } ], "description": "string", "evidenceCount": number, "evidenceSources": [ "string" ], "id": "string", "name": "string", "response": "string", "status": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [control](#API_UpdateAssessmentControl_ResponseSyntax) ** The name of the updated control set that the `UpdateAssessmentControl` API returned. Type: [AssessmentControl](API_AssessmentControl.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/UpdateAssessmentControl) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/UpdateAssessmentControl) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/UpdateAssessmentControl) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/UpdateAssessmentControl) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/UpdateAssessmentControl) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/UpdateAssessmentControl) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/UpdateAssessmentControl) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/UpdateAssessmentControl) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/UpdateAssessmentControl) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/UpdateAssessmentControl) # UpdateAssessmentControlSetStatus **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Updates the status of a control set in an Audit Manager assessment. ## Request Syntax ``` PUT /assessments/assessmentId/controlSets/controlSetId/status HTTP/1.1 Content-type: application/json { "comment": "string", "status": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_UpdateAssessmentControlSetStatus_RequestSyntax) ** The unique identifier for the assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ** [controlSetId](#API_UpdateAssessmentControlSetStatus_RequestSyntax) ** The unique identifier for the control set. Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `.*` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [comment](#API_UpdateAssessmentControlSetStatus_RequestSyntax) ** The comment that's related to the status update. Type: String Length Constraints: Maximum length of 350. Pattern: `^[\w\W\s\S]*$` Required: Yes ** [status](#API_UpdateAssessmentControlSetStatus_RequestSyntax) ** The status of the control set that's being updated. Type: String Valid Values: `ACTIVE | UNDER_REVIEW | REVIEWED` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "controlSet": { "controls": [ { "assessmentReportEvidenceCount": number, "comments": [ { "authorName": "string", "commentBody": "string", "postedDate": number } ], "description": "string", "evidenceCount": number, "evidenceSources": [ "string" ], "id": "string", "name": "string", "response": "string", "status": "string" } ], "delegations": [ { "assessmentId": "string", "assessmentName": "string", "comment": "string", "controlSetId": "string", "createdBy": "string", "creationTime": number, "id": "string", "lastUpdated": number, "roleArn": "string", "roleType": "string", "status": "string" } ], "description": "string", "id": "string", "manualEvidenceCount": number, "roles": [ { "roleArn": "string", "roleType": "string" } ], "status": "string", "systemEvidenceCount": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [controlSet](#API_UpdateAssessmentControlSetStatus_ResponseSyntax) ** The name of the updated control set that the `UpdateAssessmentControlSetStatus` API returned. Type: [AssessmentControlSet](API_AssessmentControlSet.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/UpdateAssessmentControlSetStatus) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/UpdateAssessmentControlSetStatus) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/UpdateAssessmentControlSetStatus) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/UpdateAssessmentControlSetStatus) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/UpdateAssessmentControlSetStatus) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/UpdateAssessmentControlSetStatus) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/UpdateAssessmentControlSetStatus) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/UpdateAssessmentControlSetStatus) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/UpdateAssessmentControlSetStatus) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/UpdateAssessmentControlSetStatus) # UpdateAssessmentFramework **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Updates a custom framework in AWS Audit Manager. ## Request Syntax ``` PUT /assessmentFrameworks/frameworkId HTTP/1.1 Content-type: application/json { "complianceType": "string", "controlSets": [ { "controls": [ { "id": "string" } ], "id": "string", "name": "string" } ], "description": "string", "name": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [frameworkId](#API_UpdateAssessmentFramework_RequestSyntax) ** The unique identifier for the framework. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [complianceType](#API_UpdateAssessmentFramework_RequestSyntax) ** The compliance type that the new custom framework supports, such as CIS or HIPAA. Type: String Length Constraints: Maximum length of 100. Pattern: `^[\w\W\s\S]*$` Required: No ** [controlSets](#API_UpdateAssessmentFramework_RequestSyntax) ** The control sets that are associated with the framework. The `Controls` object returns a partial response when called through Framework APIs. For a complete `Controls` object, use `GetControl`. Type: Array of [UpdateAssessmentFrameworkControlSet](API_UpdateAssessmentFrameworkControlSet.md) objects Array Members: Minimum number of 1 item. Required: Yes ** [description](#API_UpdateAssessmentFramework_RequestSyntax) ** The description of the updated framework. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: `^[\w\W\s\S]*$` Required: No ** [name](#API_UpdateAssessmentFramework_RequestSyntax) ** The name of the framework to be updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 300. Pattern: `^[^\\]*$` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "framework": { "arn": "string", "complianceType": "string", "controlSets": [ { "controls": [ { "actionPlanInstructions": "string", "actionPlanTitle": "string", "arn": "string", "controlMappingSources": [ { "sourceDescription": "string", "sourceFrequency": "string", "sourceId": "string", "sourceKeyword": { "keywordInputType": "string", "keywordValue": "string" }, "sourceName": "string", "sourceSetUpOption": "string", "sourceType": "string", "troubleshootingText": "string" } ], "controlSources": "string", "createdAt": number, "createdBy": "string", "description": "string", "id": "string", "lastUpdatedAt": number, "lastUpdatedBy": "string", "name": "string", "state": "string", "tags": { "string" : "string" }, "testingInformation": "string", "type": "string" } ], "id": "string", "name": "string" } ], "controlSources": "string", "createdAt": number, "createdBy": "string", "description": "string", "id": "string", "lastUpdatedAt": number, "lastUpdatedBy": "string", "logo": "string", "name": "string", "tags": { "string" : "string" }, "type": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [framework](#API_UpdateAssessmentFramework_ResponseSyntax) ** The framework object. Type: [Framework](API_Framework.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ServiceQuotaExceededException ** You've reached your account quota for this resource type. To perform the requested action, delete some existing resources or [request a quota increase](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) from the Service Quotas console. For a list of Audit Manager service quotas, see [Quotas and restrictions for AWS Audit Manager](https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html). HTTP Status Code: 402 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/UpdateAssessmentFramework) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/UpdateAssessmentFramework) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/UpdateAssessmentFramework) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/UpdateAssessmentFramework) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/UpdateAssessmentFramework) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/UpdateAssessmentFramework) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/UpdateAssessmentFramework) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/UpdateAssessmentFramework) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/UpdateAssessmentFramework) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/UpdateAssessmentFramework) # UpdateAssessmentFrameworkShare **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Updates a share request for a custom framework in AWS Audit Manager. ## Request Syntax ``` PUT /assessmentFrameworkShareRequests/requestId HTTP/1.1 Content-type: application/json { "action": "string", "requestType": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [requestId](#API_UpdateAssessmentFrameworkShare_RequestSyntax) ** The unique identifier for the share request. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [action](#API_UpdateAssessmentFrameworkShare_RequestSyntax) ** Specifies the update action for the share request. Type: String Valid Values: `ACCEPT | DECLINE | REVOKE` Required: Yes ** [requestType](#API_UpdateAssessmentFrameworkShare_RequestSyntax) ** Specifies whether the share request is a sent request or a received request. Type: String Valid Values: `SENT | RECEIVED` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "assessmentFrameworkShareRequest": { "comment": "string", "complianceType": "string", "creationTime": number, "customControlsCount": number, "destinationAccount": "string", "destinationRegion": "string", "expirationTime": number, "frameworkDescription": "string", "frameworkId": "string", "frameworkName": "string", "id": "string", "lastUpdated": number, "sourceAccount": "string", "standardControlsCount": number, "status": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [assessmentFrameworkShareRequest](#API_UpdateAssessmentFrameworkShare_ResponseSyntax) ** The updated share request that's returned by the `UpdateAssessmentFrameworkShare` operation. Type: [AssessmentFrameworkShareRequest](API_AssessmentFrameworkShareRequest.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ServiceQuotaExceededException ** You've reached your account quota for this resource type. To perform the requested action, delete some existing resources or [request a quota increase](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) from the Service Quotas console. For a list of Audit Manager service quotas, see [Quotas and restrictions for AWS Audit Manager](https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html). HTTP Status Code: 402 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/UpdateAssessmentFrameworkShare) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/UpdateAssessmentFrameworkShare) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/UpdateAssessmentFrameworkShare) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/UpdateAssessmentFrameworkShare) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/UpdateAssessmentFrameworkShare) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/UpdateAssessmentFrameworkShare) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/UpdateAssessmentFrameworkShare) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/UpdateAssessmentFrameworkShare) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/UpdateAssessmentFrameworkShare) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/UpdateAssessmentFrameworkShare) # UpdateAssessmentStatus **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Updates the status of an assessment in AWS Audit Manager. ## Request Syntax ``` PUT /assessments/assessmentId/status HTTP/1.1 Content-type: application/json { "status": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [assessmentId](#API_UpdateAssessmentStatus_RequestSyntax) ** The unique identifier for the assessment. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [status](#API_UpdateAssessmentStatus_RequestSyntax) ** The current status of the assessment. Type: String Valid Values: `ACTIVE | INACTIVE` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "assessment": { "arn": "string", "awsAccount": { "emailAddress": "string", "id": "string", "name": "string" }, "framework": { "arn": "string", "controlSets": [ { "controls": [ { "assessmentReportEvidenceCount": number, "comments": [ { "authorName": "string", "commentBody": "string", "postedDate": number } ], "description": "string", "evidenceCount": number, "evidenceSources": [ "string" ], "id": "string", "name": "string", "response": "string", "status": "string" } ], "delegations": [ { "assessmentId": "string", "assessmentName": "string", "comment": "string", "controlSetId": "string", "createdBy": "string", "creationTime": number, "id": "string", "lastUpdated": number, "roleArn": "string", "roleType": "string", "status": "string" } ], "description": "string", "id": "string", "manualEvidenceCount": number, "roles": [ { "roleArn": "string", "roleType": "string" } ], "status": "string", "systemEvidenceCount": number } ], "id": "string", "metadata": { "complianceType": "string", "description": "string", "logo": "string", "name": "string" } }, "metadata": { "assessmentReportsDestination": { "destination": "string", "destinationType": "string" }, "complianceType": "string", "creationTime": number, "delegations": [ { "assessmentId": "string", "assessmentName": "string", "comment": "string", "controlSetId": "string", "createdBy": "string", "creationTime": number, "id": "string", "lastUpdated": number, "roleArn": "string", "roleType": "string", "status": "string" } ], "description": "string", "id": "string", "lastUpdated": number, "name": "string", "roles": [ { "roleArn": "string", "roleType": "string" } ], "scope": { "awsAccounts": [ { "emailAddress": "string", "id": "string", "name": "string" } ], "awsServices": [ { "serviceName": "string" } ] }, "status": "string" }, "tags": { "string" : "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [assessment](#API_UpdateAssessmentStatus_ResponseSyntax) ** The name of the updated assessment that the `UpdateAssessmentStatus` API returned. Type: [Assessment](API_Assessment.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ServiceQuotaExceededException ** You've reached your account quota for this resource type. To perform the requested action, delete some existing resources or [request a quota increase](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) from the Service Quotas console. For a list of Audit Manager service quotas, see [Quotas and restrictions for AWS Audit Manager](https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html). HTTP Status Code: 402 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/UpdateAssessmentStatus) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/UpdateAssessmentStatus) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/UpdateAssessmentStatus) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/UpdateAssessmentStatus) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/UpdateAssessmentStatus) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/UpdateAssessmentStatus) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/UpdateAssessmentStatus) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/UpdateAssessmentStatus) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/UpdateAssessmentStatus) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/UpdateAssessmentStatus) # UpdateControl **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Updates a custom control in AWS Audit Manager. ## Request Syntax ``` PUT /controls/controlId HTTP/1.1 Content-type: application/json { "actionPlanInstructions": "string", "actionPlanTitle": "string", "controlMappingSources": [ { "sourceDescription": "string", "sourceFrequency": "string", "sourceId": "string", "sourceKeyword": { "keywordInputType": "string", "keywordValue": "string" }, "sourceName": "string", "sourceSetUpOption": "string", "sourceType": "string", "troubleshootingText": "string" } ], "description": "string", "name": "string", "testingInformation": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [controlId](#API_UpdateControl_RequestSyntax) ** The identifier for the control. Length Constraints: Fixed length of 36. Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [actionPlanInstructions](#API_UpdateControl_RequestSyntax) ** The recommended actions to carry out if the control isn't fulfilled. Type: String Length Constraints: Maximum length of 1000. Pattern: `^[\w\W\s\S]*$` Required: No ** [actionPlanTitle](#API_UpdateControl_RequestSyntax) ** The title of the action plan for remediating the control. Type: String Length Constraints: Maximum length of 300. Pattern: `^[\w\W\s\S]*$` Required: No ** [controlMappingSources](#API_UpdateControl_RequestSyntax) ** The data mapping sources for the control. Type: Array of [ControlMappingSource](API_ControlMappingSource.md) objects Array Members: Minimum number of 1 item. Required: Yes ** [description](#API_UpdateControl_RequestSyntax) ** The optional description of the control. Type: String Length Constraints: Maximum length of 1000. Pattern: `^[\w\W\s\S]*$` Required: No ** [name](#API_UpdateControl_RequestSyntax) ** The name of the updated control. Type: String Length Constraints: Minimum length of 1. Maximum length of 300. Pattern: `^[^\\]*$` Required: Yes ** [testingInformation](#API_UpdateControl_RequestSyntax) ** The steps that you should follow to determine if the control is met. Type: String Length Constraints: Maximum length of 1000. Pattern: `^[\w\W\s\S]*$` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "control": { "actionPlanInstructions": "string", "actionPlanTitle": "string", "arn": "string", "controlMappingSources": [ { "sourceDescription": "string", "sourceFrequency": "string", "sourceId": "string", "sourceKeyword": { "keywordInputType": "string", "keywordValue": "string" }, "sourceName": "string", "sourceSetUpOption": "string", "sourceType": "string", "troubleshootingText": "string" } ], "controlSources": "string", "createdAt": number, "createdBy": "string", "description": "string", "id": "string", "lastUpdatedAt": number, "lastUpdatedBy": "string", "name": "string", "state": "string", "tags": { "string" : "string" }, "testingInformation": "string", "type": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [control](#API_UpdateControl_ResponseSyntax) ** The name of the updated control set that the `UpdateControl` API returned. Type: [Control](API_Control.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/UpdateControl) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/UpdateControl) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/UpdateControl) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/UpdateControl) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/UpdateControl) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/UpdateControl) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/UpdateControl) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/UpdateControl) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/UpdateControl) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/UpdateControl) # UpdateSettings **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Updates Audit Manager settings for the current account. ## Request Syntax ``` PUT /settings HTTP/1.1 Content-type: application/json { "defaultAssessmentReportsDestination": { "destination": "string", "destinationType": "string" }, "defaultExportDestination": { "destination": "string", "destinationType": "string" }, "defaultProcessOwners": [ { "roleArn": "string", "roleType": "string" } ], "deregistrationPolicy": { "deleteResources": "string" }, "evidenceFinderEnabled": boolean, "kmsKey": "string", "snsTopic": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [defaultAssessmentReportsDestination](#API_UpdateSettings_RequestSyntax) ** The default S3 destination bucket for storing assessment reports. Type: [AssessmentReportsDestination](API_AssessmentReportsDestination.md) object Required: No ** [defaultExportDestination](#API_UpdateSettings_RequestSyntax) ** The default S3 destination bucket for storing evidence finder exports. Type: [DefaultExportDestination](API_DefaultExportDestination.md) object Required: No ** [defaultProcessOwners](#API_UpdateSettings_RequestSyntax) ** A list of the default audit owners. Type: Array of [Role](API_Role.md) objects Required: No ** [deregistrationPolicy](#API_UpdateSettings_RequestSyntax) ** 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. Type: [DeregistrationPolicy](API_DeregistrationPolicy.md) object Required: No ** [evidenceFinderEnabled](#API_UpdateSettings_RequestSyntax) ** 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](https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeregisterAccount.html) and then [re-register](https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_RegisterAccount.html) Audit Manager. Type: Boolean Required: No ** [kmsKey](#API_UpdateSettings_RequestSyntax) ** The AWS KMS key details. Type: String Length Constraints: Minimum length of 7. Maximum length of 2048. Pattern: `^arn:.*:kms:.*|DEFAULT` Required: No ** [snsTopic](#API_UpdateSettings_RequestSyntax) ** The Amazon Simple Notification Service (Amazon SNS) topic that AWS Audit Manager sends notifications to. Type: String Length Constraints: Minimum length of 4. Maximum length of 2048. Pattern: `^arn:.*:sns:.*|NONE` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "settings": { "defaultAssessmentReportsDestination": { "destination": "string", "destinationType": "string" }, "defaultExportDestination": { "destination": "string", "destinationType": "string" }, "defaultProcessOwners": [ { "roleArn": "string", "roleType": "string" } ], "deregistrationPolicy": { "deleteResources": "string" }, "evidenceFinderEnablement": { "backfillStatus": "string", "enablementStatus": "string", "error": "string", "eventDataStoreArn": "string" }, "isAwsOrgEnabled": boolean, "kmsKey": "string", "snsTopic": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [settings](#API_UpdateSettings_ResponseSyntax) ** The current list of settings. Type: [Settings](API_Settings.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## Examples ### Enabling evidence finder This is an example response for the `GetSettings` API operation, where the `evidenceFinderEnabled` parameter was used to enable evidence finder. This response returns the following `evidenceFinderEnablement` data: + `enablementStatus` shows the current status of evidence finder. In this case, `ENABLE_IN_PROGRESS` indicates that you requested to enable evidence finder, and an event data store is being created to support evidence finder queries. + `backfillStatus` shows the current status of the evidence data backfill. In this case, `NOT_STARTED` indicates that the backfill hasn’t started yet. #### Sample Response ``` { "settings": { "isAwsOrgEnabled": false, "snsTopic": "arn:aws:sns:us-east-1:111122223333:my-assessment-topic", "defaultAssessmentReportsDestination": { "destinationType": "S3", "destination": "s3://my-assessment-report-destination" }, "defaultProcessOwners": [ { "roleType": "PROCESS_OWNER", "roleArn": "arn:aws:iam::111122223333:role/Administrator" } ], "kmsKey": "DEFAULT", "evidenceFinderEnablement": { "enablementStatus": "ENABLE_IN_PROGRESS", "backfillStatus": "NOT_STARTED" } } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/UpdateSettings) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/UpdateSettings) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/UpdateSettings) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/UpdateSettings) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/UpdateSettings) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/UpdateSettings) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/UpdateSettings) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/UpdateSettings) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/UpdateSettings) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/UpdateSettings) # ValidateAssessmentReportIntegrity **Important** AWS Audit Manager will no longer be open to new customers starting April 30, 2026. If you would like to use Audit Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [AWS Audit Manager availability change](https://docs.aws.amazon.com/audit-manager/latest/userguide/audit-manager-availability-change.html). Validates the integrity of an assessment report in AWS Audit Manager. ## Request Syntax ``` POST /assessmentReports/integrity HTTP/1.1 Content-type: application/json { "s3RelativePath": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [s3RelativePath](#API_ValidateAssessmentReportIntegrity_RequestSyntax) ** The relative path of the Amazon S3 bucket that the assessment report is stored in. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `^(S|s)3:\/\/[a-zA-Z0-9\-\.\(\)\'\*\_\!\=\+\@\:\s\,\?\/]+$` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "signatureAlgorithm": "string", "signatureDateTime": "string", "signatureKeyId": "string", "signatureValid": boolean, "validationErrors": [ "string" ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [signatureAlgorithm](#API_ValidateAssessmentReportIntegrity_ResponseSyntax) ** The signature algorithm that's used to code sign the assessment report file. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `.*` ** [signatureDateTime](#API_ValidateAssessmentReportIntegrity_ResponseSyntax) ** The date and time signature that specifies when the assessment report was created. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `.*` ** [signatureKeyId](#API_ValidateAssessmentReportIntegrity_ResponseSyntax) ** The unique identifier for the validation signature key. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `.*` ** [signatureValid](#API_ValidateAssessmentReportIntegrity_ResponseSyntax) ** Specifies whether the signature key is valid. Type: Boolean ** [validationErrors](#API_ValidateAssessmentReportIntegrity_ResponseSyntax) ** Represents any errors that occurred when validating the assessment report. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `.*\S.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. HTTP Status Code: 403 ** InternalServerException ** An internal service error occurred during the processing of your request. Try again later. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource that's specified in the request can't be found. ** resourceId ** The unique identifier for the resource. ** resourceType ** The type of resource that's affected by the error. HTTP Status Code: 404 ** ValidationException ** The request has invalid or missing parameters. ** fields ** The fields that caused the error, if applicable. ** reason ** The reason the request failed validation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/auditmanager-2017-07-25/ValidateAssessmentReportIntegrity) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/auditmanager-2017-07-25/ValidateAssessmentReportIntegrity) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/auditmanager-2017-07-25/ValidateAssessmentReportIntegrity) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/auditmanager-2017-07-25/ValidateAssessmentReportIntegrity) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/auditmanager-2017-07-25/ValidateAssessmentReportIntegrity) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/auditmanager-2017-07-25/ValidateAssessmentReportIntegrity) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/auditmanager-2017-07-25/ValidateAssessmentReportIntegrity) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/auditmanager-2017-07-25/ValidateAssessmentReportIntegrity) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/auditmanager-2017-07-25/ValidateAssessmentReportIntegrity) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/auditmanager-2017-07-25/ValidateAssessmentReportIntegrity)