AssociateAssessmentReportEvidenceFolder

$result = $client->associateAssessmentReportEvidenceFolder([/* ... */]);
$promise = $client->associateAssessmentReportEvidenceFolderAsync([/* ... */]);

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

Parameter Syntax

$result = $client->associateAssessmentReportEvidenceFolder([
    'assessmentId' => '<string>', // REQUIRED
    'evidenceFolderId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

ResourceNotFoundException:

The resource that's specified in the request can't be found.

BatchAssociateAssessmentReportEvidence

$result = $client->batchAssociateAssessmentReportEvidence([/* ... */]);
$promise = $client->batchAssociateAssessmentReportEvidenceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchAssociateAssessmentReportEvidence([
    'assessmentId' => '<string>', // REQUIRED
    'evidenceFolderId' => '<string>', // REQUIRED
    'evidenceIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'errorCode' => '<string>',
            'errorMessage' => '<string>',
            'evidenceId' => '<string>',
        ],
        // ...
    ],
    'evidenceIds' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

ResourceNotFoundException:

The resource that's specified in the request can't be found.

BatchCreateDelegationByAssessment

$result = $client->batchCreateDelegationByAssessment([/* ... */]);
$promise = $client->batchCreateDelegationByAssessmentAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchCreateDelegationByAssessment([
    'assessmentId' => '<string>', // REQUIRED
    'createDelegationRequests' => [ // REQUIRED
        [
            'comment' => '<string>',
            'controlSetId' => '<string>',
            'roleArn' => '<string>',
            'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'delegations' => [
        [
            'assessmentId' => '<string>',
            'assessmentName' => '<string>',
            'comment' => '<string>',
            'controlSetId' => '<string>',
            'createdBy' => '<string>',
            'creationTime' => <DateTime>,
            'id' => '<string>',
            'lastUpdated' => <DateTime>,
            'roleArn' => '<string>',
            'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
            'status' => 'IN_PROGRESS|UNDER_REVIEW|COMPLETE',
        ],
        // ...
    ],
    'errors' => [
        [
            'createDelegationRequest' => [
                'comment' => '<string>',
                'controlSetId' => '<string>',
                'roleArn' => '<string>',
                'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
            ],
            'errorCode' => '<string>',
            'errorMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

AccessDeniedException:

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

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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

BatchDeleteDelegationByAssessment

$result = $client->batchDeleteDelegationByAssessment([/* ... */]);
$promise = $client->batchDeleteDelegationByAssessmentAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchDeleteDelegationByAssessment([
    'assessmentId' => '<string>', // REQUIRED
    'delegationIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'delegationId' => '<string>',
            'errorCode' => '<string>',
            'errorMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

AccessDeniedException:

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

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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

BatchDisassociateAssessmentReportEvidence

$result = $client->batchDisassociateAssessmentReportEvidence([/* ... */]);
$promise = $client->batchDisassociateAssessmentReportEvidenceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchDisassociateAssessmentReportEvidence([
    'assessmentId' => '<string>', // REQUIRED
    'evidenceFolderId' => '<string>', // REQUIRED
    'evidenceIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'errorCode' => '<string>',
            'errorMessage' => '<string>',
            'evidenceId' => '<string>',
        ],
        // ...
    ],
    'evidenceIds' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

ResourceNotFoundException:

The resource that's specified in the request can't be found.

BatchImportEvidenceToAssessmentControl

$result = $client->batchImportEvidenceToAssessmentControl([/* ... */]);
$promise = $client->batchImportEvidenceToAssessmentControlAsync([/* ... */]);

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

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

The following restrictions apply to this action:

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

• Maximum size of an individual evidence file: 100 MB

• Number of daily manual evidence uploads per control: 100

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

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

Parameter Syntax

$result = $client->batchImportEvidenceToAssessmentControl([
    'assessmentId' => '<string>', // REQUIRED
    'controlId' => '<string>', // REQUIRED
    'controlSetId' => '<string>', // REQUIRED
    'manualEvidence' => [ // REQUIRED
        [
            'evidenceFileName' => '<string>',
            's3ResourcePath' => '<string>',
            'textResponse' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'errorCode' => '<string>',
            'errorMessage' => '<string>',
            'manualEvidence' => [
                'evidenceFileName' => '<string>',
                's3ResourcePath' => '<string>',
                'textResponse' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

AccessDeniedException:

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

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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

ThrottlingException:

The request was denied due to request throttling.

CreateAssessment

$result = $client->createAssessment([/* ... */]);
$promise = $client->createAssessmentAsync([/* ... */]);

Creates an assessment in Audit Manager.

Parameter Syntax

$result = $client->createAssessment([
    'assessmentReportsDestination' => [ // REQUIRED
        'destination' => '<string>',
        'destinationType' => 'S3',
    ],
    'description' => '<string>',
    'frameworkId' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'roles' => [ // REQUIRED
        [
            'roleArn' => '<string>', // REQUIRED
            'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER', // REQUIRED
        ],
        // ...
    ],
    'scope' => [ // REQUIRED
        'awsAccounts' => [
            [
                'emailAddress' => '<string>',
                'id' => '<string>',
                'name' => '<string>',
            ],
            // ...
        ],
        'awsServices' => [
            [
                'serviceName' => '<string>',
            ],
            // ...
        ],
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'assessment' => [
        'arn' => '<string>',
        'awsAccount' => [
            'emailAddress' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
        ],
        'framework' => [
            'arn' => '<string>',
            'controlSets' => [
                [
                    'controls' => [
                        [
                            'assessmentReportEvidenceCount' => <integer>,
                            'comments' => [
                                [
                                    'authorName' => '<string>',
                                    'commentBody' => '<string>',
                                    'postedDate' => <DateTime>,
                                ],
                                // ...
                            ],
                            'description' => '<string>',
                            'evidenceCount' => <integer>,
                            'evidenceSources' => ['<string>', ...],
                            'id' => '<string>',
                            'name' => '<string>',
                            'response' => 'MANUAL|AUTOMATE|DEFER|IGNORE',
                            'status' => 'UNDER_REVIEW|REVIEWED|INACTIVE',
                        ],
                        // ...
                    ],
                    'delegations' => [
                        [
                            'assessmentId' => '<string>',
                            'assessmentName' => '<string>',
                            'comment' => '<string>',
                            'controlSetId' => '<string>',
                            'createdBy' => '<string>',
                            'creationTime' => <DateTime>,
                            'id' => '<string>',
                            'lastUpdated' => <DateTime>,
                            'roleArn' => '<string>',
                            'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
                            'status' => 'IN_PROGRESS|UNDER_REVIEW|COMPLETE',
                        ],
                        // ...
                    ],
                    'description' => '<string>',
                    'id' => '<string>',
                    'manualEvidenceCount' => <integer>,
                    'roles' => [
                        [
                            'roleArn' => '<string>',
                            'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
                        ],
                        // ...
                    ],
                    'status' => 'ACTIVE|UNDER_REVIEW|REVIEWED',
                    'systemEvidenceCount' => <integer>,
                ],
                // ...
            ],
            'id' => '<string>',
            'metadata' => [
                'complianceType' => '<string>',
                'description' => '<string>',
                'logo' => '<string>',
                'name' => '<string>',
            ],
        ],
        'metadata' => [
            'assessmentReportsDestination' => [
                'destination' => '<string>',
                'destinationType' => 'S3',
            ],
            'complianceType' => '<string>',
            'creationTime' => <DateTime>,
            'delegations' => [
                [
                    'assessmentId' => '<string>',
                    'assessmentName' => '<string>',
                    'comment' => '<string>',
                    'controlSetId' => '<string>',
                    'createdBy' => '<string>',
                    'creationTime' => <DateTime>,
                    'id' => '<string>',
                    'lastUpdated' => <DateTime>,
                    'roleArn' => '<string>',
                    'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
                    'status' => 'IN_PROGRESS|UNDER_REVIEW|COMPLETE',
                ],
                // ...
            ],
            'description' => '<string>',
            'id' => '<string>',
            'lastUpdated' => <DateTime>,
            'name' => '<string>',
            'roles' => [
                [
                    'roleArn' => '<string>',
                    'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
                ],
                // ...
            ],
            'scope' => [
                'awsAccounts' => [
                    [
                        'emailAddress' => '<string>',
                        'id' => '<string>',
                        'name' => '<string>',
                    ],
                    // ...
                ],
                'awsServices' => [
                    [
                        'serviceName' => '<string>',
                    ],
                    // ...
                ],
            ],
            'status' => 'ACTIVE|INACTIVE',
        ],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

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 from the Service Quotas console. For a list of Audit Manager service quotas, see Quotas and restrictions for Audit Manager.

ThrottlingException:

The request was denied due to request throttling.

CreateAssessmentFramework

$result = $client->createAssessmentFramework([/* ... */]);
$promise = $client->createAssessmentFrameworkAsync([/* ... */]);

Creates a custom framework in Audit Manager.

Parameter Syntax

$result = $client->createAssessmentFramework([
    'complianceType' => '<string>',
    'controlSets' => [ // REQUIRED
        [
            'controls' => [
                [
                    'id' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'name' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'framework' => [
        'arn' => '<string>',
        'complianceType' => '<string>',
        'controlSets' => [
            [
                'controls' => [
                    [
                        'actionPlanInstructions' => '<string>',
                        'actionPlanTitle' => '<string>',
                        'arn' => '<string>',
                        'controlMappingSources' => [
                            [
                                'sourceDescription' => '<string>',
                                'sourceFrequency' => 'DAILY|WEEKLY|MONTHLY',
                                'sourceId' => '<string>',
                                'sourceKeyword' => [
                                    'keywordInputType' => 'SELECT_FROM_LIST|UPLOAD_FILE|INPUT_TEXT',
                                    'keywordValue' => '<string>',
                                ],
                                'sourceName' => '<string>',
                                'sourceSetUpOption' => 'System_Controls_Mapping|Procedural_Controls_Mapping',
                                'sourceType' => 'AWS_Cloudtrail|AWS_Config|AWS_Security_Hub|AWS_API_Call|MANUAL|Common_Control|Core_Control',
                                'troubleshootingText' => '<string>',
                            ],
                            // ...
                        ],
                        'controlSources' => '<string>',
                        'createdAt' => <DateTime>,
                        'createdBy' => '<string>',
                        'description' => '<string>',
                        'id' => '<string>',
                        'lastUpdatedAt' => <DateTime>,
                        'lastUpdatedBy' => '<string>',
                        'name' => '<string>',
                        'state' => 'ACTIVE|END_OF_SUPPORT',
                        'tags' => ['<string>', ...],
                        'testingInformation' => '<string>',
                        'type' => 'Standard|Custom|Core',
                    ],
                    // ...
                ],
                'id' => '<string>',
                'name' => '<string>',
            ],
            // ...
        ],
        'controlSources' => '<string>',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'description' => '<string>',
        'id' => '<string>',
        'lastUpdatedAt' => <DateTime>,
        'lastUpdatedBy' => '<string>',
        'logo' => '<string>',
        'name' => '<string>',
        'tags' => ['<string>', ...],
        'type' => 'Standard|Custom',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

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 from the Service Quotas console. For a list of Audit Manager service quotas, see Quotas and restrictions for Audit Manager.

CreateAssessmentReport

$result = $client->createAssessmentReport([/* ... */]);
$promise = $client->createAssessmentReportAsync([/* ... */]);

Creates an assessment report for the specified assessment.

Parameter Syntax

$result = $client->createAssessmentReport([
    'assessmentId' => '<string>', // REQUIRED
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'queryStatement' => '<string>',
]);

Parameter Details

Result Syntax

[
    'assessmentReport' => [
        'assessmentId' => '<string>',
        'assessmentName' => '<string>',
        'author' => '<string>',
        'awsAccountId' => '<string>',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'id' => '<string>',
        'name' => '<string>',
        'status' => 'COMPLETE|IN_PROGRESS|FAILED',
    ],
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

ResourceNotFoundException:

The resource that's specified in the request can't be found.

CreateControl

$result = $client->createControl([/* ... */]);
$promise = $client->createControlAsync([/* ... */]);

Creates a new custom control in Audit Manager.

Parameter Syntax

$result = $client->createControl([
    'actionPlanInstructions' => '<string>',
    'actionPlanTitle' => '<string>',
    'controlMappingSources' => [ // REQUIRED
        [
            'sourceDescription' => '<string>',
            'sourceFrequency' => 'DAILY|WEEKLY|MONTHLY',
            'sourceKeyword' => [
                'keywordInputType' => 'SELECT_FROM_LIST|UPLOAD_FILE|INPUT_TEXT',
                'keywordValue' => '<string>',
            ],
            'sourceName' => '<string>',
            'sourceSetUpOption' => 'System_Controls_Mapping|Procedural_Controls_Mapping',
            'sourceType' => 'AWS_Cloudtrail|AWS_Config|AWS_Security_Hub|AWS_API_Call|MANUAL|Common_Control|Core_Control',
            'troubleshootingText' => '<string>',
        ],
        // ...
    ],
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'testingInformation' => '<string>',
]);

Parameter Details

Result Syntax

[
    'control' => [
        'actionPlanInstructions' => '<string>',
        'actionPlanTitle' => '<string>',
        'arn' => '<string>',
        'controlMappingSources' => [
            [
                'sourceDescription' => '<string>',
                'sourceFrequency' => 'DAILY|WEEKLY|MONTHLY',
                'sourceId' => '<string>',
                'sourceKeyword' => [
                    'keywordInputType' => 'SELECT_FROM_LIST|UPLOAD_FILE|INPUT_TEXT',
                    'keywordValue' => '<string>',
                ],
                'sourceName' => '<string>',
                'sourceSetUpOption' => 'System_Controls_Mapping|Procedural_Controls_Mapping',
                'sourceType' => 'AWS_Cloudtrail|AWS_Config|AWS_Security_Hub|AWS_API_Call|MANUAL|Common_Control|Core_Control',
                'troubleshootingText' => '<string>',
            ],
            // ...
        ],
        'controlSources' => '<string>',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'description' => '<string>',
        'id' => '<string>',
        'lastUpdatedAt' => <DateTime>,
        'lastUpdatedBy' => '<string>',
        'name' => '<string>',
        'state' => 'ACTIVE|END_OF_SUPPORT',
        'tags' => ['<string>', ...],
        'testingInformation' => '<string>',
        'type' => 'Standard|Custom|Core',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

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 from the Service Quotas console. For a list of Audit Manager service quotas, see Quotas and restrictions for Audit Manager.

DeleteAssessment

$result = $client->deleteAssessment([/* ... */]);
$promise = $client->deleteAssessmentAsync([/* ... */]);

Deletes an assessment in Audit Manager.

Parameter Syntax

$result = $client->deleteAssessment([
    'assessmentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

DeleteAssessmentFramework

$result = $client->deleteAssessmentFramework([/* ... */]);
$promise = $client->deleteAssessmentFrameworkAsync([/* ... */]);

Deletes a custom framework in Audit Manager.

Parameter Syntax

$result = $client->deleteAssessmentFramework([
    'frameworkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

DeleteAssessmentFrameworkShare

$result = $client->deleteAssessmentFrameworkShare([/* ... */]);
$promise = $client->deleteAssessmentFrameworkShareAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteAssessmentFrameworkShare([
    'requestId' => '<string>', // REQUIRED
    'requestType' => 'SENT|RECEIVED', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

DeleteAssessmentReport

$result = $client->deleteAssessmentReport([/* ... */]);
$promise = $client->deleteAssessmentReportAsync([/* ... */]);

Deletes an assessment report in Audit Manager.

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

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

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

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

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

Parameter Syntax

$result = $client->deleteAssessmentReport([
    'assessmentId' => '<string>', // REQUIRED
    'assessmentReportId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

ResourceNotFoundException:

The resource that's specified in the request can't be found.

DeleteControl

$result = $client->deleteControl([/* ... */]);
$promise = $client->deleteControlAsync([/* ... */]);

Deletes a custom control in Audit Manager.

Parameter Syntax

$result = $client->deleteControl([
    'controlId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

DeregisterAccount

$result = $client->deregisterAccount([/* ... */]);
$promise = $client->deregisterAccountAsync([/* ... */]);

Deregisters an account in Audit Manager.

Parameter Syntax

$result = $client->deregisterAccount([
]);

Parameter Details

Result Syntax

[
    'status' => 'ACTIVE|INACTIVE|PENDING_ACTIVATION',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

ResourceNotFoundException:

The resource that's specified in the request can't be found.

DeregisterOrganizationAdminAccount

$result = $client->deregisterOrganizationAdminAccount([/* ... */]);
$promise = $client->deregisterOrganizationAdminAccountAsync([/* ... */]);

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

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

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

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

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

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

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

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

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

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

Parameter Syntax

$result = $client->deregisterOrganizationAdminAccount([
    'adminAccountId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

ResourceNotFoundException:

The resource that's specified in the request can't be found.

DisassociateAssessmentReportEvidenceFolder

$result = $client->disassociateAssessmentReportEvidenceFolder([/* ... */]);
$promise = $client->disassociateAssessmentReportEvidenceFolderAsync([/* ... */]);

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

Parameter Syntax

$result = $client->disassociateAssessmentReportEvidenceFolder([
    'assessmentId' => '<string>', // REQUIRED
    'evidenceFolderId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

ResourceNotFoundException:

The resource that's specified in the request can't be found.

GetAccountStatus

$result = $client->getAccountStatus([/* ... */]);
$promise = $client->getAccountStatusAsync([/* ... */]);

Gets the registration status of an account in Audit Manager.

Parameter Syntax

$result = $client->getAccountStatus([
]);

Parameter Details

Result Syntax

[
    'status' => 'ACTIVE|INACTIVE|PENDING_ACTIVATION',
]

Result Details

Errors

InternalServerException:

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

GetAssessment

$result = $client->getAssessment([/* ... */]);
$promise = $client->getAssessmentAsync([/* ... */]);

Gets information about a specified assessment.

Parameter Syntax

$result = $client->getAssessment([
    'assessmentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'assessment' => [
        'arn' => '<string>',
        'awsAccount' => [
            'emailAddress' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
        ],
        'framework' => [
            'arn' => '<string>',
            'controlSets' => [
                [
                    'controls' => [
                        [
                            'assessmentReportEvidenceCount' => <integer>,
                            'comments' => [
                                [
                                    'authorName' => '<string>',
                                    'commentBody' => '<string>',
                                    'postedDate' => <DateTime>,
                                ],
                                // ...
                            ],
                            'description' => '<string>',
                            'evidenceCount' => <integer>,
                            'evidenceSources' => ['<string>', ...],
                            'id' => '<string>',
                            'name' => '<string>',
                            'response' => 'MANUAL|AUTOMATE|DEFER|IGNORE',
                            'status' => 'UNDER_REVIEW|REVIEWED|INACTIVE',
                        ],
                        // ...
                    ],
                    'delegations' => [
                        [
                            'assessmentId' => '<string>',
                            'assessmentName' => '<string>',
                            'comment' => '<string>',
                            'controlSetId' => '<string>',
                            'createdBy' => '<string>',
                            'creationTime' => <DateTime>,
                            'id' => '<string>',
                            'lastUpdated' => <DateTime>,
                            'roleArn' => '<string>',
                            'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
                            'status' => 'IN_PROGRESS|UNDER_REVIEW|COMPLETE',
                        ],
                        // ...
                    ],
                    'description' => '<string>',
                    'id' => '<string>',
                    'manualEvidenceCount' => <integer>,
                    'roles' => [
                        [
                            'roleArn' => '<string>',
                            'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
                        ],
                        // ...
                    ],
                    'status' => 'ACTIVE|UNDER_REVIEW|REVIEWED',
                    'systemEvidenceCount' => <integer>,
                ],
                // ...
            ],
            'id' => '<string>',
            'metadata' => [
                'complianceType' => '<string>',
                'description' => '<string>',
                'logo' => '<string>',
                'name' => '<string>',
            ],
        ],
        'metadata' => [
            'assessmentReportsDestination' => [
                'destination' => '<string>',
                'destinationType' => 'S3',
            ],
            'complianceType' => '<string>',
            'creationTime' => <DateTime>,
            'delegations' => [
                [
                    'assessmentId' => '<string>',
                    'assessmentName' => '<string>',
                    'comment' => '<string>',
                    'controlSetId' => '<string>',
                    'createdBy' => '<string>',
                    'creationTime' => <DateTime>,
                    'id' => '<string>',
                    'lastUpdated' => <DateTime>,
                    'roleArn' => '<string>',
                    'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
                    'status' => 'IN_PROGRESS|UNDER_REVIEW|COMPLETE',
                ],
                // ...
            ],
            'description' => '<string>',
            'id' => '<string>',
            'lastUpdated' => <DateTime>,
            'name' => '<string>',
            'roles' => [
                [
                    'roleArn' => '<string>',
                    'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
                ],
                // ...
            ],
            'scope' => [
                'awsAccounts' => [
                    [
                        'emailAddress' => '<string>',
                        'id' => '<string>',
                        'name' => '<string>',
                    ],
                    // ...
                ],
                'awsServices' => [
                    [
                        'serviceName' => '<string>',
                    ],
                    // ...
                ],
            ],
            'status' => 'ACTIVE|INACTIVE',
        ],
        'tags' => ['<string>', ...],
    ],
    'userRole' => [
        'roleArn' => '<string>',
        'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

GetAssessmentFramework

$result = $client->getAssessmentFramework([/* ... */]);
$promise = $client->getAssessmentFrameworkAsync([/* ... */]);

Gets information about a specified framework.

Parameter Syntax

$result = $client->getAssessmentFramework([
    'frameworkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'framework' => [
        'arn' => '<string>',
        'complianceType' => '<string>',
        'controlSets' => [
            [
                'controls' => [
                    [
                        'actionPlanInstructions' => '<string>',
                        'actionPlanTitle' => '<string>',
                        'arn' => '<string>',
                        'controlMappingSources' => [
                            [
                                'sourceDescription' => '<string>',
                                'sourceFrequency' => 'DAILY|WEEKLY|MONTHLY',
                                'sourceId' => '<string>',
                                'sourceKeyword' => [
                                    'keywordInputType' => 'SELECT_FROM_LIST|UPLOAD_FILE|INPUT_TEXT',
                                    'keywordValue' => '<string>',
                                ],
                                'sourceName' => '<string>',
                                'sourceSetUpOption' => 'System_Controls_Mapping|Procedural_Controls_Mapping',
                                'sourceType' => 'AWS_Cloudtrail|AWS_Config|AWS_Security_Hub|AWS_API_Call|MANUAL|Common_Control|Core_Control',
                                'troubleshootingText' => '<string>',
                            ],
                            // ...
                        ],
                        'controlSources' => '<string>',
                        'createdAt' => <DateTime>,
                        'createdBy' => '<string>',
                        'description' => '<string>',
                        'id' => '<string>',
                        'lastUpdatedAt' => <DateTime>,
                        'lastUpdatedBy' => '<string>',
                        'name' => '<string>',
                        'state' => 'ACTIVE|END_OF_SUPPORT',
                        'tags' => ['<string>', ...],
                        'testingInformation' => '<string>',
                        'type' => 'Standard|Custom|Core',
                    ],
                    // ...
                ],
                'id' => '<string>',
                'name' => '<string>',
            ],
            // ...
        ],
        'controlSources' => '<string>',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'description' => '<string>',
        'id' => '<string>',
        'lastUpdatedAt' => <DateTime>,
        'lastUpdatedBy' => '<string>',
        'logo' => '<string>',
        'name' => '<string>',
        'tags' => ['<string>', ...],
        'type' => 'Standard|Custom',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

GetAssessmentReportUrl

$result = $client->getAssessmentReportUrl([/* ... */]);
$promise = $client->getAssessmentReportUrlAsync([/* ... */]);

Gets the URL of an assessment report in Audit Manager.

Parameter Syntax

$result = $client->getAssessmentReportUrl([
    'assessmentId' => '<string>', // REQUIRED
    'assessmentReportId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'preSignedUrl' => [
        'hyperlinkName' => '<string>',
        'link' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

ResourceNotFoundException:

The resource that's specified in the request can't be found.

GetChangeLogs

$result = $client->getChangeLogs([/* ... */]);
$promise = $client->getChangeLogsAsync([/* ... */]);

Gets a list of changelogs from Audit Manager.

Parameter Syntax

$result = $client->getChangeLogs([
    'assessmentId' => '<string>', // REQUIRED
    'controlId' => '<string>',
    'controlSetId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'changeLogs' => [
        [
            'action' => 'CREATE|UPDATE_METADATA|ACTIVE|INACTIVE|DELETE|UNDER_REVIEW|REVIEWED|IMPORT_EVIDENCE',
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'objectName' => '<string>',
            'objectType' => 'ASSESSMENT|CONTROL_SET|CONTROL|DELEGATION|ASSESSMENT_REPORT',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

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

ResourceNotFoundException:

The resource that's specified in the request can't be found.

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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

GetControl

$result = $client->getControl([/* ... */]);
$promise = $client->getControlAsync([/* ... */]);

Gets information about a specified control.

Parameter Syntax

$result = $client->getControl([
    'controlId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'control' => [
        'actionPlanInstructions' => '<string>',
        'actionPlanTitle' => '<string>',
        'arn' => '<string>',
        'controlMappingSources' => [
            [
                'sourceDescription' => '<string>',
                'sourceFrequency' => 'DAILY|WEEKLY|MONTHLY',
                'sourceId' => '<string>',
                'sourceKeyword' => [
                    'keywordInputType' => 'SELECT_FROM_LIST|UPLOAD_FILE|INPUT_TEXT',
                    'keywordValue' => '<string>',
                ],
                'sourceName' => '<string>',
                'sourceSetUpOption' => 'System_Controls_Mapping|Procedural_Controls_Mapping',
                'sourceType' => 'AWS_Cloudtrail|AWS_Config|AWS_Security_Hub|AWS_API_Call|MANUAL|Common_Control|Core_Control',
                'troubleshootingText' => '<string>',
            ],
            // ...
        ],
        'controlSources' => '<string>',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'description' => '<string>',
        'id' => '<string>',
        'lastUpdatedAt' => <DateTime>,
        'lastUpdatedBy' => '<string>',
        'name' => '<string>',
        'state' => 'ACTIVE|END_OF_SUPPORT',
        'tags' => ['<string>', ...],
        'testingInformation' => '<string>',
        'type' => 'Standard|Custom|Core',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

GetDelegations

$result = $client->getDelegations([/* ... */]);
$promise = $client->getDelegationsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getDelegations([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'delegations' => [
        [
            'assessmentId' => '<string>',
            'assessmentName' => '<string>',
            'controlSetName' => '<string>',
            'creationTime' => <DateTime>,
            'id' => '<string>',
            'roleArn' => '<string>',
            'status' => 'IN_PROGRESS|UNDER_REVIEW|COMPLETE',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

GetEvidence

$result = $client->getEvidence([/* ... */]);
$promise = $client->getEvidenceAsync([/* ... */]);

Gets information about a specified evidence item.

Parameter Syntax

$result = $client->getEvidence([
    'assessmentId' => '<string>', // REQUIRED
    'controlSetId' => '<string>', // REQUIRED
    'evidenceFolderId' => '<string>', // REQUIRED
    'evidenceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'evidence' => [
        'assessmentReportSelection' => '<string>',
        'attributes' => ['<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' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

GetEvidenceByEvidenceFolder

$result = $client->getEvidenceByEvidenceFolder([/* ... */]);
$promise = $client->getEvidenceByEvidenceFolderAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getEvidenceByEvidenceFolder([
    'assessmentId' => '<string>', // REQUIRED
    'controlSetId' => '<string>', // REQUIRED
    'evidenceFolderId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'evidence' => [
        [
            'assessmentReportSelection' => '<string>',
            'attributes' => ['<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' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

GetEvidenceFileUploadUrl

$result = $client->getEvidenceFileUploadUrl([/* ... */]);
$promise = $client->getEvidenceFileUploadUrlAsync([/* ... */]);

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

The following restrictions apply to this operation:

• Maximum size of an individual evidence file: 100 MB

• Number of daily manual evidence uploads per control: 100

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

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

Parameter Syntax

$result = $client->getEvidenceFileUploadUrl([
    'fileName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'evidenceFileName' => '<string>',
    'uploadUrl' => '<string>',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

ThrottlingException:

The request was denied due to request throttling.

GetEvidenceFolder

$result = $client->getEvidenceFolder([/* ... */]);
$promise = $client->getEvidenceFolderAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getEvidenceFolder([
    'assessmentId' => '<string>', // REQUIRED
    'controlSetId' => '<string>', // REQUIRED
    'evidenceFolderId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'evidenceFolder' => [
        'assessmentId' => '<string>',
        'assessmentReportSelectionCount' => <integer>,
        'author' => '<string>',
        'controlId' => '<string>',
        'controlName' => '<string>',
        'controlSetId' => '<string>',
        'dataSource' => '<string>',
        'date' => <DateTime>,
        'evidenceAwsServiceSourceCount' => <integer>,
        'evidenceByTypeComplianceCheckCount' => <integer>,
        'evidenceByTypeComplianceCheckIssuesCount' => <integer>,
        'evidenceByTypeConfigurationDataCount' => <integer>,
        'evidenceByTypeManualCount' => <integer>,
        'evidenceByTypeUserActivityCount' => <integer>,
        'evidenceResourcesIncludedCount' => <integer>,
        'id' => '<string>',
        'name' => '<string>',
        'totalEvidence' => <integer>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

GetEvidenceFoldersByAssessment

$result = $client->getEvidenceFoldersByAssessment([/* ... */]);
$promise = $client->getEvidenceFoldersByAssessmentAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getEvidenceFoldersByAssessment([
    'assessmentId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'evidenceFolders' => [
        [
            'assessmentId' => '<string>',
            'assessmentReportSelectionCount' => <integer>,
            'author' => '<string>',
            'controlId' => '<string>',
            'controlName' => '<string>',
            'controlSetId' => '<string>',
            'dataSource' => '<string>',
            'date' => <DateTime>,
            'evidenceAwsServiceSourceCount' => <integer>,
            'evidenceByTypeComplianceCheckCount' => <integer>,
            'evidenceByTypeComplianceCheckIssuesCount' => <integer>,
            'evidenceByTypeConfigurationDataCount' => <integer>,
            'evidenceByTypeManualCount' => <integer>,
            'evidenceByTypeUserActivityCount' => <integer>,
            'evidenceResourcesIncludedCount' => <integer>,
            'id' => '<string>',
            'name' => '<string>',
            'totalEvidence' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

AccessDeniedException:

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

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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

GetEvidenceFoldersByAssessmentControl

$result = $client->getEvidenceFoldersByAssessmentControl([/* ... */]);
$promise = $client->getEvidenceFoldersByAssessmentControlAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getEvidenceFoldersByAssessmentControl([
    'assessmentId' => '<string>', // REQUIRED
    'controlId' => '<string>', // REQUIRED
    'controlSetId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'evidenceFolders' => [
        [
            'assessmentId' => '<string>',
            'assessmentReportSelectionCount' => <integer>,
            'author' => '<string>',
            'controlId' => '<string>',
            'controlName' => '<string>',
            'controlSetId' => '<string>',
            'dataSource' => '<string>',
            'date' => <DateTime>,
            'evidenceAwsServiceSourceCount' => <integer>,
            'evidenceByTypeComplianceCheckCount' => <integer>,
            'evidenceByTypeComplianceCheckIssuesCount' => <integer>,
            'evidenceByTypeConfigurationDataCount' => <integer>,
            'evidenceByTypeManualCount' => <integer>,
            'evidenceByTypeUserActivityCount' => <integer>,
            'evidenceResourcesIncludedCount' => <integer>,
            'id' => '<string>',
            'name' => '<string>',
            'totalEvidence' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

GetInsights

$result = $client->getInsights([/* ... */]);
$promise = $client->getInsightsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getInsights([
]);

Parameter Details

Result Syntax

[
    'insights' => [
        'activeAssessmentsCount' => <integer>,
        'assessmentControlsCountByNoncompliantEvidence' => <integer>,
        'compliantEvidenceCount' => <integer>,
        'inconclusiveEvidenceCount' => <integer>,
        'lastUpdated' => <DateTime>,
        'noncompliantEvidenceCount' => <integer>,
        'totalAssessmentControlsCount' => <integer>,
    ],
]

Result Details

Errors

AccessDeniedException:

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

InternalServerException:

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

GetInsightsByAssessment

$result = $client->getInsightsByAssessment([/* ... */]);
$promise = $client->getInsightsByAssessmentAsync([/* ... */]);

Gets the latest analytics data for a specific active assessment.

Parameter Syntax

$result = $client->getInsightsByAssessment([
    'assessmentId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'insights' => [
        'assessmentControlsCountByNoncompliantEvidence' => <integer>,
        'compliantEvidenceCount' => <integer>,
        'inconclusiveEvidenceCount' => <integer>,
        'lastUpdated' => <DateTime>,
        'noncompliantEvidenceCount' => <integer>,
        'totalAssessmentControlsCount' => <integer>,
    ],
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The resource that's specified in the request can't be found.

AccessDeniedException:

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

InternalServerException:

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

GetOrganizationAdminAccount

$result = $client->getOrganizationAdminAccount([/* ... */]);
$promise = $client->getOrganizationAdminAccountAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getOrganizationAdminAccount([
]);

Parameter Details

Result Syntax

[
    'adminAccountId' => '<string>',
    'organizationId' => '<string>',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

ResourceNotFoundException:

The resource that's specified in the request can't be found.

GetServicesInScope

$result = $client->getServicesInScope([/* ... */]);
$promise = $client->getServicesInScopeAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->getServicesInScope([
]);

Parameter Details

Result Syntax

[
    'serviceMetadata' => [
        [
            'category' => '<string>',
            'description' => '<string>',
            'displayName' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

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

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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

GetSettings

$result = $client->getSettings([/* ... */]);
$promise = $client->getSettingsAsync([/* ... */]);

Gets the settings for a specified Amazon Web Services account.

Parameter Syntax

$result = $client->getSettings([
    'attribute' => 'ALL|IS_AWS_ORG_ENABLED|SNS_TOPIC|DEFAULT_ASSESSMENT_REPORTS_DESTINATION|DEFAULT_PROCESS_OWNERS|EVIDENCE_FINDER_ENABLEMENT|DEREGISTRATION_POLICY|DEFAULT_EXPORT_DESTINATION', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'settings' => [
        'defaultAssessmentReportsDestination' => [
            'destination' => '<string>',
            'destinationType' => 'S3',
        ],
        'defaultExportDestination' => [
            'destination' => '<string>',
            'destinationType' => 'S3',
        ],
        'defaultProcessOwners' => [
            [
                'roleArn' => '<string>',
                'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
            ],
            // ...
        ],
        'deregistrationPolicy' => [
            'deleteResources' => 'ALL|DEFAULT',
        ],
        'evidenceFinderEnablement' => [
            'backfillStatus' => 'NOT_STARTED|IN_PROGRESS|COMPLETED',
            'enablementStatus' => 'ENABLED|DISABLED|ENABLE_IN_PROGRESS|DISABLE_IN_PROGRESS',
            'error' => '<string>',
            'eventDataStoreArn' => '<string>',
        ],
        'isAwsOrgEnabled' => true || false,
        'kmsKey' => '<string>',
        'snsTopic' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

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

InternalServerException:

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

ListAssessmentControlInsightsByControlDomain

$result = $client->listAssessmentControlInsightsByControlDomain([/* ... */]);
$promise = $client->listAssessmentControlInsightsByControlDomainAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listAssessmentControlInsightsByControlDomain([
    'assessmentId' => '<string>', // REQUIRED
    'controlDomainId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'controlInsightsByAssessment' => [
        [
            'controlSetName' => '<string>',
            'evidenceInsights' => [
                'compliantEvidenceCount' => <integer>,
                'inconclusiveEvidenceCount' => <integer>,
                'noncompliantEvidenceCount' => <integer>,
            ],
            'id' => '<string>',
            'lastUpdated' => <DateTime>,
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The resource that's specified in the request can't be found.

AccessDeniedException:

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

InternalServerException:

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

ListAssessmentFrameworkShareRequests

$result = $client->listAssessmentFrameworkShareRequests([/* ... */]);
$promise = $client->listAssessmentFrameworkShareRequestsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listAssessmentFrameworkShareRequests([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'requestType' => 'SENT|RECEIVED', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'assessmentFrameworkShareRequests' => [
        [
            'comment' => '<string>',
            'complianceType' => '<string>',
            'creationTime' => <DateTime>,
            'customControlsCount' => <integer>,
            'destinationAccount' => '<string>',
            'destinationRegion' => '<string>',
            'expirationTime' => <DateTime>,
            'frameworkDescription' => '<string>',
            'frameworkId' => '<string>',
            'frameworkName' => '<string>',
            'id' => '<string>',
            'lastUpdated' => <DateTime>,
            'sourceAccount' => '<string>',
            'standardControlsCount' => <integer>,
            'status' => 'ACTIVE|REPLICATING|SHARED|EXPIRING|FAILED|EXPIRED|DECLINED|REVOKED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

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

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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

ListAssessmentFrameworks

$result = $client->listAssessmentFrameworks([/* ... */]);
$promise = $client->listAssessmentFrameworksAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listAssessmentFrameworks([
    'frameworkType' => 'Standard|Custom', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'frameworkMetadataList' => [
        [
            'arn' => '<string>',
            'complianceType' => '<string>',
            'controlSetsCount' => <integer>,
            'controlsCount' => <integer>,
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'id' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'logo' => '<string>',
            'name' => '<string>',
            'type' => 'Standard|Custom',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

ListAssessmentReports

$result = $client->listAssessmentReports([/* ... */]);
$promise = $client->listAssessmentReportsAsync([/* ... */]);

Returns a list of assessment reports created in Audit Manager.

Parameter Syntax

$result = $client->listAssessmentReports([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'assessmentReports' => [
        [
            'assessmentId' => '<string>',
            'assessmentName' => '<string>',
            'author' => '<string>',
            'creationTime' => <DateTime>,
            'description' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'status' => 'COMPLETE|IN_PROGRESS|FAILED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

ListAssessments

$result = $client->listAssessments([/* ... */]);
$promise = $client->listAssessmentsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listAssessments([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'status' => 'ACTIVE|INACTIVE',
]);

Parameter Details

Result Syntax

[
    'assessmentMetadata' => [
        [
            'complianceType' => '<string>',
            'creationTime' => <DateTime>,
            'delegations' => [
                [
                    'assessmentId' => '<string>',
                    'assessmentName' => '<string>',
                    'comment' => '<string>',
                    'controlSetId' => '<string>',
                    'createdBy' => '<string>',
                    'creationTime' => <DateTime>,
                    'id' => '<string>',
                    'lastUpdated' => <DateTime>,
                    'roleArn' => '<string>',
                    'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
                    'status' => 'IN_PROGRESS|UNDER_REVIEW|COMPLETE',
                ],
                // ...
            ],
            'id' => '<string>',
            'lastUpdated' => <DateTime>,
            'name' => '<string>',
            'roles' => [
                [
                    'roleArn' => '<string>',
                    'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
                ],
                // ...
            ],
            'status' => 'ACTIVE|INACTIVE',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

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

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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

ListControlDomainInsights

$result = $client->listControlDomainInsights([/* ... */]);
$promise = $client->listControlDomainInsightsAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->listControlDomainInsights([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'controlDomainInsights' => [
        [
            'controlsCountByNoncompliantEvidence' => <integer>,
            'evidenceInsights' => [
                'compliantEvidenceCount' => <integer>,
                'inconclusiveEvidenceCount' => <integer>,
                'noncompliantEvidenceCount' => <integer>,
            ],
            'id' => '<string>',
            'lastUpdated' => <DateTime>,
            'name' => '<string>',
            'totalControlsCount' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

AccessDeniedException:

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

InternalServerException:

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

ValidationException:

The request has invalid or missing parameters.

ListControlDomainInsightsByAssessment

$result = $client->listControlDomainInsightsByAssessment([/* ... */]);
$promise = $client->listControlDomainInsightsByAssessmentAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->listControlDomainInsightsByAssessment([
    'assessmentId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'controlDomainInsights' => [
        [
            'controlsCountByNoncompliantEvidence' => <integer>,
            'evidenceInsights' => [
                'compliantEvidenceCount' => <integer>,
                'inconclusiveEvidenceCount' => <integer>,
                'noncompliantEvidenceCount' => <integer>,
            ],
            'id' => '<string>',
            'lastUpdated' => <DateTime>,
            'name' => '<string>',
            'totalControlsCount' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The resource that's specified in the request can't be found.

AccessDeniedException:

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

InternalServerException:

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

ListControlInsightsByControlDomain

$result = $client->listControlInsightsByControlDomain([/* ... */]);
$promise = $client->listControlInsightsByControlDomainAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listControlInsightsByControlDomain([
    'controlDomainId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'controlInsightsMetadata' => [
        [
            'evidenceInsights' => [
                'compliantEvidenceCount' => <integer>,
                'inconclusiveEvidenceCount' => <integer>,
                'noncompliantEvidenceCount' => <integer>,
            ],
            'id' => '<string>',
            'lastUpdated' => <DateTime>,
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

AccessDeniedException:

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

InternalServerException:

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

ValidationException:

The request has invalid or missing parameters.

ListControls

$result = $client->listControls([/* ... */]);
$promise = $client->listControlsAsync([/* ... */]);

Returns a list of controls from Audit Manager.

Parameter Syntax

$result = $client->listControls([
    'controlCatalogId' => '<string>',
    'controlType' => 'Standard|Custom|Core', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'controlMetadataList' => [
        [
            'arn' => '<string>',
            'controlSources' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

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

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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

ListKeywordsForDataSource

$result = $client->listKeywordsForDataSource([/* ... */]);
$promise = $client->listKeywordsForDataSourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listKeywordsForDataSource([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'source' => 'AWS_Cloudtrail|AWS_Config|AWS_Security_Hub|AWS_API_Call|MANUAL', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'keywords' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

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

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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

ListNotifications

$result = $client->listNotifications([/* ... */]);
$promise = $client->listNotificationsAsync([/* ... */]);

Returns a list of all Audit Manager notifications.

Parameter Syntax

$result = $client->listNotifications([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'notifications' => [
        [
            'assessmentId' => '<string>',
            'assessmentName' => '<string>',
            'controlSetId' => '<string>',
            'controlSetName' => '<string>',
            'description' => '<string>',
            'eventTime' => <DateTime>,
            'id' => '<string>',
            'source' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

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

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

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

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The resource that's specified in the request can't be found.

RegisterAccount

$result = $client->registerAccount([/* ... */]);
$promise = $client->registerAccountAsync([/* ... */]);

Enables Audit Manager for the specified Amazon Web Services account.

Parameter Syntax

$result = $client->registerAccount([
    'delegatedAdminAccount' => '<string>',
    'kmsKey' => '<string>',
]);

Parameter Details

Result Syntax

[
    'status' => 'ACTIVE|INACTIVE|PENDING_ACTIVATION',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

ResourceNotFoundException:

The resource that's specified in the request can't be found.

ThrottlingException:

The request was denied due to request throttling.

RegisterOrganizationAdminAccount

$result = $client->registerOrganizationAdminAccount([/* ... */]);
$promise = $client->registerOrganizationAdminAccountAsync([/* ... */]);

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

Parameter Syntax

$result = $client->registerOrganizationAdminAccount([
    'adminAccountId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'adminAccountId' => '<string>',
    'organizationId' => '<string>',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

ResourceNotFoundException:

The resource that's specified in the request can't be found.

StartAssessmentFrameworkShare

$result = $client->startAssessmentFrameworkShare([/* ... */]);
$promise = $client->startAssessmentFrameworkShareAsync([/* ... */]);

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

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

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

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

• The sender revokes the share request.

• The recipient declines the share request.

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

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

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

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

Parameter Syntax

$result = $client->startAssessmentFrameworkShare([
    'comment' => '<string>',
    'destinationAccount' => '<string>', // REQUIRED
    'destinationRegion' => '<string>', // REQUIRED
    'frameworkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'assessmentFrameworkShareRequest' => [
        'comment' => '<string>',
        'complianceType' => '<string>',
        'creationTime' => <DateTime>,
        'customControlsCount' => <integer>,
        'destinationAccount' => '<string>',
        'destinationRegion' => '<string>',
        'expirationTime' => <DateTime>,
        'frameworkDescription' => '<string>',
        'frameworkId' => '<string>',
        'frameworkName' => '<string>',
        'id' => '<string>',
        'lastUpdated' => <DateTime>,
        'sourceAccount' => '<string>',
        'standardControlsCount' => <integer>,
        'status' => 'ACTIVE|REPLICATING|SHARED|EXPIRING|FAILED|EXPIRED|DECLINED|REVOKED',
    ],
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

ResourceNotFoundException:

The resource that's specified in the request can't be found.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Tags the specified resource in Audit Manager.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The resource that's specified in the request can't be found.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes a tag from a resource in Audit Manager.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The resource that's specified in the request can't be found.

UpdateAssessment

$result = $client->updateAssessment([/* ... */]);
$promise = $client->updateAssessmentAsync([/* ... */]);

Edits an Audit Manager assessment.

Parameter Syntax

$result = $client->updateAssessment([
    'assessmentDescription' => '<string>',
    'assessmentId' => '<string>', // REQUIRED
    'assessmentName' => '<string>',
    'assessmentReportsDestination' => [
        'destination' => '<string>',
        'destinationType' => 'S3',
    ],
    'roles' => [
        [
            'roleArn' => '<string>', // REQUIRED
            'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER', // REQUIRED
        ],
        // ...
    ],
    'scope' => [ // REQUIRED
        'awsAccounts' => [
            [
                'emailAddress' => '<string>',
                'id' => '<string>',
                'name' => '<string>',
            ],
            // ...
        ],
        'awsServices' => [
            [
                'serviceName' => '<string>',
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'assessment' => [
        'arn' => '<string>',
        'awsAccount' => [
            'emailAddress' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
        ],
        'framework' => [
            'arn' => '<string>',
            'controlSets' => [
                [
                    'controls' => [
                        [
                            'assessmentReportEvidenceCount' => <integer>,
                            'comments' => [
                                [
                                    'authorName' => '<string>',
                                    'commentBody' => '<string>',
                                    'postedDate' => <DateTime>,
                                ],
                                // ...
                            ],
                            'description' => '<string>',
                            'evidenceCount' => <integer>,
                            'evidenceSources' => ['<string>', ...],
                            'id' => '<string>',
                            'name' => '<string>',
                            'response' => 'MANUAL|AUTOMATE|DEFER|IGNORE',
                            'status' => 'UNDER_REVIEW|REVIEWED|INACTIVE',
                        ],
                        // ...
                    ],
                    'delegations' => [
                        [
                            'assessmentId' => '<string>',
                            'assessmentName' => '<string>',
                            'comment' => '<string>',
                            'controlSetId' => '<string>',
                            'createdBy' => '<string>',
                            'creationTime' => <DateTime>,
                            'id' => '<string>',
                            'lastUpdated' => <DateTime>,
                            'roleArn' => '<string>',
                            'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
                            'status' => 'IN_PROGRESS|UNDER_REVIEW|COMPLETE',
                        ],
                        // ...
                    ],
                    'description' => '<string>',
                    'id' => '<string>',
                    'manualEvidenceCount' => <integer>,
                    'roles' => [
                        [
                            'roleArn' => '<string>',
                            'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
                        ],
                        // ...
                    ],
                    'status' => 'ACTIVE|UNDER_REVIEW|REVIEWED',
                    'systemEvidenceCount' => <integer>,
                ],
                // ...
            ],
            'id' => '<string>',
            'metadata' => [
                'complianceType' => '<string>',
                'description' => '<string>',
                'logo' => '<string>',
                'name' => '<string>',
            ],
        ],
        'metadata' => [
            'assessmentReportsDestination' => [
                'destination' => '<string>',
                'destinationType' => 'S3',
            ],
            'complianceType' => '<string>',
            'creationTime' => <DateTime>,
            'delegations' => [
                [
                    'assessmentId' => '<string>',
                    'assessmentName' => '<string>',
                    'comment' => '<string>',
                    'controlSetId' => '<string>',
                    'createdBy' => '<string>',
                    'creationTime' => <DateTime>,
                    'id' => '<string>',
                    'lastUpdated' => <DateTime>,
                    'roleArn' => '<string>',
                    'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
                    'status' => 'IN_PROGRESS|UNDER_REVIEW|COMPLETE',
                ],
                // ...
            ],
            'description' => '<string>',
            'id' => '<string>',
            'lastUpdated' => <DateTime>,
            'name' => '<string>',
            'roles' => [
                [
                    'roleArn' => '<string>',
                    'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
                ],
                // ...
            ],
            'scope' => [
                'awsAccounts' => [
                    [
                        'emailAddress' => '<string>',
                        'id' => '<string>',
                        'name' => '<string>',
                    ],
                    // ...
                ],
                'awsServices' => [
                    [
                        'serviceName' => '<string>',
                    ],
                    // ...
                ],
            ],
            'status' => 'ACTIVE|INACTIVE',
        ],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

ThrottlingException:

The request was denied due to request throttling.

UpdateAssessmentControl

$result = $client->updateAssessmentControl([/* ... */]);
$promise = $client->updateAssessmentControlAsync([/* ... */]);

Updates a control within an assessment in Audit Manager.

Parameter Syntax

$result = $client->updateAssessmentControl([
    'assessmentId' => '<string>', // REQUIRED
    'commentBody' => '<string>',
    'controlId' => '<string>', // REQUIRED
    'controlSetId' => '<string>', // REQUIRED
    'controlStatus' => 'UNDER_REVIEW|REVIEWED|INACTIVE',
]);

Parameter Details

Result Syntax

[
    'control' => [
        'assessmentReportEvidenceCount' => <integer>,
        'comments' => [
            [
                'authorName' => '<string>',
                'commentBody' => '<string>',
                'postedDate' => <DateTime>,
            ],
            // ...
        ],
        'description' => '<string>',
        'evidenceCount' => <integer>,
        'evidenceSources' => ['<string>', ...],
        'id' => '<string>',
        'name' => '<string>',
        'response' => 'MANUAL|AUTOMATE|DEFER|IGNORE',
        'status' => 'UNDER_REVIEW|REVIEWED|INACTIVE',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

UpdateAssessmentControlSetStatus

$result = $client->updateAssessmentControlSetStatus([/* ... */]);
$promise = $client->updateAssessmentControlSetStatusAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateAssessmentControlSetStatus([
    'assessmentId' => '<string>', // REQUIRED
    'comment' => '<string>', // REQUIRED
    'controlSetId' => '<string>', // REQUIRED
    'status' => 'ACTIVE|UNDER_REVIEW|REVIEWED', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'controlSet' => [
        'controls' => [
            [
                'assessmentReportEvidenceCount' => <integer>,
                'comments' => [
                    [
                        'authorName' => '<string>',
                        'commentBody' => '<string>',
                        'postedDate' => <DateTime>,
                    ],
                    // ...
                ],
                'description' => '<string>',
                'evidenceCount' => <integer>,
                'evidenceSources' => ['<string>', ...],
                'id' => '<string>',
                'name' => '<string>',
                'response' => 'MANUAL|AUTOMATE|DEFER|IGNORE',
                'status' => 'UNDER_REVIEW|REVIEWED|INACTIVE',
            ],
            // ...
        ],
        'delegations' => [
            [
                'assessmentId' => '<string>',
                'assessmentName' => '<string>',
                'comment' => '<string>',
                'controlSetId' => '<string>',
                'createdBy' => '<string>',
                'creationTime' => <DateTime>,
                'id' => '<string>',
                'lastUpdated' => <DateTime>,
                'roleArn' => '<string>',
                'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
                'status' => 'IN_PROGRESS|UNDER_REVIEW|COMPLETE',
            ],
            // ...
        ],
        'description' => '<string>',
        'id' => '<string>',
        'manualEvidenceCount' => <integer>,
        'roles' => [
            [
                'roleArn' => '<string>',
                'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
            ],
            // ...
        ],
        'status' => 'ACTIVE|UNDER_REVIEW|REVIEWED',
        'systemEvidenceCount' => <integer>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

UpdateAssessmentFramework

$result = $client->updateAssessmentFramework([/* ... */]);
$promise = $client->updateAssessmentFrameworkAsync([/* ... */]);

Updates a custom framework in Audit Manager.

Parameter Syntax

$result = $client->updateAssessmentFramework([
    'complianceType' => '<string>',
    'controlSets' => [ // REQUIRED
        [
            'controls' => [ // REQUIRED
                [
                    'id' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'id' => '<string>',
            'name' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'description' => '<string>',
    'frameworkId' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'framework' => [
        'arn' => '<string>',
        'complianceType' => '<string>',
        'controlSets' => [
            [
                'controls' => [
                    [
                        'actionPlanInstructions' => '<string>',
                        'actionPlanTitle' => '<string>',
                        'arn' => '<string>',
                        'controlMappingSources' => [
                            [
                                'sourceDescription' => '<string>',
                                'sourceFrequency' => 'DAILY|WEEKLY|MONTHLY',
                                'sourceId' => '<string>',
                                'sourceKeyword' => [
                                    'keywordInputType' => 'SELECT_FROM_LIST|UPLOAD_FILE|INPUT_TEXT',
                                    'keywordValue' => '<string>',
                                ],
                                'sourceName' => '<string>',
                                'sourceSetUpOption' => 'System_Controls_Mapping|Procedural_Controls_Mapping',
                                'sourceType' => 'AWS_Cloudtrail|AWS_Config|AWS_Security_Hub|AWS_API_Call|MANUAL|Common_Control|Core_Control',
                                'troubleshootingText' => '<string>',
                            ],
                            // ...
                        ],
                        'controlSources' => '<string>',
                        'createdAt' => <DateTime>,
                        'createdBy' => '<string>',
                        'description' => '<string>',
                        'id' => '<string>',
                        'lastUpdatedAt' => <DateTime>,
                        'lastUpdatedBy' => '<string>',
                        'name' => '<string>',
                        'state' => 'ACTIVE|END_OF_SUPPORT',
                        'tags' => ['<string>', ...],
                        'testingInformation' => '<string>',
                        'type' => 'Standard|Custom|Core',
                    ],
                    // ...
                ],
                'id' => '<string>',
                'name' => '<string>',
            ],
            // ...
        ],
        'controlSources' => '<string>',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'description' => '<string>',
        'id' => '<string>',
        'lastUpdatedAt' => <DateTime>,
        'lastUpdatedBy' => '<string>',
        'logo' => '<string>',
        'name' => '<string>',
        'tags' => ['<string>', ...],
        'type' => 'Standard|Custom',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

UpdateAssessmentFrameworkShare

$result = $client->updateAssessmentFrameworkShare([/* ... */]);
$promise = $client->updateAssessmentFrameworkShareAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateAssessmentFrameworkShare([
    'action' => 'ACCEPT|DECLINE|REVOKE', // REQUIRED
    'requestId' => '<string>', // REQUIRED
    'requestType' => 'SENT|RECEIVED', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'assessmentFrameworkShareRequest' => [
        'comment' => '<string>',
        'complianceType' => '<string>',
        'creationTime' => <DateTime>,
        'customControlsCount' => <integer>,
        'destinationAccount' => '<string>',
        'destinationRegion' => '<string>',
        'expirationTime' => <DateTime>,
        'frameworkDescription' => '<string>',
        'frameworkId' => '<string>',
        'frameworkName' => '<string>',
        'id' => '<string>',
        'lastUpdated' => <DateTime>,
        'sourceAccount' => '<string>',
        'standardControlsCount' => <integer>,
        'status' => 'ACTIVE|REPLICATING|SHARED|EXPIRING|FAILED|EXPIRED|DECLINED|REVOKED',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

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 from the Service Quotas console. For a list of Audit Manager service quotas, see Quotas and restrictions for Audit Manager.

UpdateAssessmentStatus

$result = $client->updateAssessmentStatus([/* ... */]);
$promise = $client->updateAssessmentStatusAsync([/* ... */]);

Updates the status of an assessment in Audit Manager.

Parameter Syntax

$result = $client->updateAssessmentStatus([
    'assessmentId' => '<string>', // REQUIRED
    'status' => 'ACTIVE|INACTIVE', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'assessment' => [
        'arn' => '<string>',
        'awsAccount' => [
            'emailAddress' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
        ],
        'framework' => [
            'arn' => '<string>',
            'controlSets' => [
                [
                    'controls' => [
                        [
                            'assessmentReportEvidenceCount' => <integer>,
                            'comments' => [
                                [
                                    'authorName' => '<string>',
                                    'commentBody' => '<string>',
                                    'postedDate' => <DateTime>,
                                ],
                                // ...
                            ],
                            'description' => '<string>',
                            'evidenceCount' => <integer>,
                            'evidenceSources' => ['<string>', ...],
                            'id' => '<string>',
                            'name' => '<string>',
                            'response' => 'MANUAL|AUTOMATE|DEFER|IGNORE',
                            'status' => 'UNDER_REVIEW|REVIEWED|INACTIVE',
                        ],
                        // ...
                    ],
                    'delegations' => [
                        [
                            'assessmentId' => '<string>',
                            'assessmentName' => '<string>',
                            'comment' => '<string>',
                            'controlSetId' => '<string>',
                            'createdBy' => '<string>',
                            'creationTime' => <DateTime>,
                            'id' => '<string>',
                            'lastUpdated' => <DateTime>,
                            'roleArn' => '<string>',
                            'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
                            'status' => 'IN_PROGRESS|UNDER_REVIEW|COMPLETE',
                        ],
                        // ...
                    ],
                    'description' => '<string>',
                    'id' => '<string>',
                    'manualEvidenceCount' => <integer>,
                    'roles' => [
                        [
                            'roleArn' => '<string>',
                            'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
                        ],
                        // ...
                    ],
                    'status' => 'ACTIVE|UNDER_REVIEW|REVIEWED',
                    'systemEvidenceCount' => <integer>,
                ],
                // ...
            ],
            'id' => '<string>',
            'metadata' => [
                'complianceType' => '<string>',
                'description' => '<string>',
                'logo' => '<string>',
                'name' => '<string>',
            ],
        ],
        'metadata' => [
            'assessmentReportsDestination' => [
                'destination' => '<string>',
                'destinationType' => 'S3',
            ],
            'complianceType' => '<string>',
            'creationTime' => <DateTime>,
            'delegations' => [
                [
                    'assessmentId' => '<string>',
                    'assessmentName' => '<string>',
                    'comment' => '<string>',
                    'controlSetId' => '<string>',
                    'createdBy' => '<string>',
                    'creationTime' => <DateTime>,
                    'id' => '<string>',
                    'lastUpdated' => <DateTime>,
                    'roleArn' => '<string>',
                    'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
                    'status' => 'IN_PROGRESS|UNDER_REVIEW|COMPLETE',
                ],
                // ...
            ],
            'description' => '<string>',
            'id' => '<string>',
            'lastUpdated' => <DateTime>,
            'name' => '<string>',
            'roles' => [
                [
                    'roleArn' => '<string>',
                    'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
                ],
                // ...
            ],
            'scope' => [
                'awsAccounts' => [
                    [
                        'emailAddress' => '<string>',
                        'id' => '<string>',
                        'name' => '<string>',
                    ],
                    // ...
                ],
                'awsServices' => [
                    [
                        'serviceName' => '<string>',
                    ],
                    // ...
                ],
            ],
            'status' => 'ACTIVE|INACTIVE',
        ],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

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 from the Service Quotas console. For a list of Audit Manager service quotas, see Quotas and restrictions for Audit Manager.

UpdateControl

$result = $client->updateControl([/* ... */]);
$promise = $client->updateControlAsync([/* ... */]);

Updates a custom control in Audit Manager.

Parameter Syntax

$result = $client->updateControl([
    'actionPlanInstructions' => '<string>',
    'actionPlanTitle' => '<string>',
    'controlId' => '<string>', // REQUIRED
    'controlMappingSources' => [ // REQUIRED
        [
            'sourceDescription' => '<string>',
            'sourceFrequency' => 'DAILY|WEEKLY|MONTHLY',
            'sourceId' => '<string>',
            'sourceKeyword' => [
                'keywordInputType' => 'SELECT_FROM_LIST|UPLOAD_FILE|INPUT_TEXT',
                'keywordValue' => '<string>',
            ],
            'sourceName' => '<string>',
            'sourceSetUpOption' => 'System_Controls_Mapping|Procedural_Controls_Mapping',
            'sourceType' => 'AWS_Cloudtrail|AWS_Config|AWS_Security_Hub|AWS_API_Call|MANUAL|Common_Control|Core_Control',
            'troubleshootingText' => '<string>',
        ],
        // ...
    ],
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'testingInformation' => '<string>',
]);

Parameter Details

Result Syntax

[
    'control' => [
        'actionPlanInstructions' => '<string>',
        'actionPlanTitle' => '<string>',
        'arn' => '<string>',
        'controlMappingSources' => [
            [
                'sourceDescription' => '<string>',
                'sourceFrequency' => 'DAILY|WEEKLY|MONTHLY',
                'sourceId' => '<string>',
                'sourceKeyword' => [
                    'keywordInputType' => 'SELECT_FROM_LIST|UPLOAD_FILE|INPUT_TEXT',
                    'keywordValue' => '<string>',
                ],
                'sourceName' => '<string>',
                'sourceSetUpOption' => 'System_Controls_Mapping|Procedural_Controls_Mapping',
                'sourceType' => 'AWS_Cloudtrail|AWS_Config|AWS_Security_Hub|AWS_API_Call|MANUAL|Common_Control|Core_Control',
                'troubleshootingText' => '<string>',
            ],
            // ...
        ],
        'controlSources' => '<string>',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'description' => '<string>',
        'id' => '<string>',
        'lastUpdatedAt' => <DateTime>,
        'lastUpdatedBy' => '<string>',
        'name' => '<string>',
        'state' => 'ACTIVE|END_OF_SUPPORT',
        'tags' => ['<string>', ...],
        'testingInformation' => '<string>',
        'type' => 'Standard|Custom|Core',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource that's specified in the request can't be found.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

UpdateSettings

$result = $client->updateSettings([/* ... */]);
$promise = $client->updateSettingsAsync([/* ... */]);

Updates Audit Manager settings for the current account.

Parameter Syntax

$result = $client->updateSettings([
    'defaultAssessmentReportsDestination' => [
        'destination' => '<string>',
        'destinationType' => 'S3',
    ],
    'defaultExportDestination' => [
        'destination' => '<string>',
        'destinationType' => 'S3',
    ],
    'defaultProcessOwners' => [
        [
            'roleArn' => '<string>', // REQUIRED
            'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER', // REQUIRED
        ],
        // ...
    ],
    'deregistrationPolicy' => [
        'deleteResources' => 'ALL|DEFAULT',
    ],
    'evidenceFinderEnabled' => true || false,
    'kmsKey' => '<string>',
    'snsTopic' => '<string>',
]);

Parameter Details

Result Syntax

[
    'settings' => [
        'defaultAssessmentReportsDestination' => [
            'destination' => '<string>',
            'destinationType' => 'S3',
        ],
        'defaultExportDestination' => [
            'destination' => '<string>',
            'destinationType' => 'S3',
        ],
        'defaultProcessOwners' => [
            [
                'roleArn' => '<string>',
                'roleType' => 'PROCESS_OWNER|RESOURCE_OWNER',
            ],
            // ...
        ],
        'deregistrationPolicy' => [
            'deleteResources' => 'ALL|DEFAULT',
        ],
        'evidenceFinderEnablement' => [
            'backfillStatus' => 'NOT_STARTED|IN_PROGRESS|COMPLETED',
            'enablementStatus' => 'ENABLED|DISABLED|ENABLE_IN_PROGRESS|DISABLE_IN_PROGRESS',
            'error' => '<string>',
            'eventDataStoreArn' => '<string>',
        ],
        'isAwsOrgEnabled' => true || false,
        'kmsKey' => '<string>',
        'snsTopic' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

ValidateAssessmentReportIntegrity

$result = $client->validateAssessmentReportIntegrity([/* ... */]);
$promise = $client->validateAssessmentReportIntegrityAsync([/* ... */]);

Validates the integrity of an assessment report in Audit Manager.

Parameter Syntax

$result = $client->validateAssessmentReportIntegrity([
    's3RelativePath' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'signatureAlgorithm' => '<string>',
    'signatureDateTime' => '<string>',
    'signatureKeyId' => '<string>',
    'signatureValid' => true || false,
    'validationErrors' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

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

InternalServerException:

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

ResourceNotFoundException:

The resource that's specified in the request can't be found.