AWS Audit Manager 2017-07-25

AssociateAssessmentReportEvidenceFolder

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

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'errorCode' => '<string>',
            'errorMessage' => '<string>',
            'manualEvidence' => [
                's3ResourcePath' => '<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.

CreateAssessment

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

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.

CreateAssessmentFramework

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

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',
                                    'keywordValue' => '<string>',
                                ],
                                'sourceName' => '<string>',
                                'sourceSetUpOption' => 'System_Controls_Mapping|Procedural_Controls_Mapping',
                                'sourceType' => 'AWS_Cloudtrail|AWS_Config|AWS_Security_Hub|AWS_API_Call|MANUAL',
                                'troubleshootingText' => '<string>',
                            ],
                            // ...
                        ],
                        'controlSources' => '<string>',
                        'createdAt' => <DateTime>,
                        'createdBy' => '<string>',
                        'description' => '<string>',
                        'id' => '<string>',
                        'lastUpdatedAt' => <DateTime>,
                        'lastUpdatedBy' => '<string>',
                        'name' => '<string>',
                        'tags' => ['<string>', ...],
                        'testingInformation' => '<string>',
                        'type' => 'Standard|Custom',
                    ],
                    // ...
                ],
                '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([/* ... */]);

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([/* ... */]);

Parameter Syntax

$result = $client->createControl([
    'actionPlanInstructions' => '<string>',
    'actionPlanTitle' => '<string>',
    'controlMappingSources' => [ // REQUIRED
        [
            'sourceDescription' => '<string>',
            'sourceFrequency' => 'DAILY|WEEKLY|MONTHLY',
            'sourceKeyword' => [
                'keywordInputType' => 'SELECT_FROM_LIST',
                'keywordValue' => '<string>',
            ],
            'sourceName' => '<string>',
            'sourceSetUpOption' => 'System_Controls_Mapping|Procedural_Controls_Mapping',
            'sourceType' => 'AWS_Cloudtrail|AWS_Config|AWS_Security_Hub|AWS_API_Call|MANUAL',
            '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',
                    'keywordValue' => '<string>',
                ],
                'sourceName' => '<string>',
                'sourceSetUpOption' => 'System_Controls_Mapping|Procedural_Controls_Mapping',
                'sourceType' => 'AWS_Cloudtrail|AWS_Config|AWS_Security_Hub|AWS_API_Call|MANUAL',
                'troubleshootingText' => '<string>',
            ],
            // ...
        ],
        'controlSources' => '<string>',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'description' => '<string>',
        'id' => '<string>',
        'lastUpdatedAt' => <DateTime>,
        'lastUpdatedBy' => '<string>',
        'name' => '<string>',
        'tags' => ['<string>', ...],
        'testingInformation' => '<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.

DeleteAssessment

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

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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',
                                    'keywordValue' => '<string>',
                                ],
                                'sourceName' => '<string>',
                                'sourceSetUpOption' => 'System_Controls_Mapping|Procedural_Controls_Mapping',
                                'sourceType' => 'AWS_Cloudtrail|AWS_Config|AWS_Security_Hub|AWS_API_Call|MANUAL',
                                'troubleshootingText' => '<string>',
                            ],
                            // ...
                        ],
                        'controlSources' => '<string>',
                        'createdAt' => <DateTime>,
                        'createdBy' => '<string>',
                        'description' => '<string>',
                        'id' => '<string>',
                        'lastUpdatedAt' => <DateTime>,
                        'lastUpdatedBy' => '<string>',
                        'name' => '<string>',
                        'tags' => ['<string>', ...],
                        'testingInformation' => '<string>',
                        'type' => 'Standard|Custom',
                    ],
                    // ...
                ],
                '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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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',
                    'keywordValue' => '<string>',
                ],
                'sourceName' => '<string>',
                'sourceSetUpOption' => 'System_Controls_Mapping|Procedural_Controls_Mapping',
                'sourceType' => 'AWS_Cloudtrail|AWS_Config|AWS_Security_Hub|AWS_API_Call|MANUAL',
                'troubleshootingText' => '<string>',
            ],
            // ...
        ],
        'controlSources' => '<string>',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'description' => '<string>',
        'id' => '<string>',
        'lastUpdatedAt' => <DateTime>,
        'lastUpdatedBy' => '<string>',
        'name' => '<string>',
        'tags' => ['<string>', ...],
        'testingInformation' => '<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.

GetDelegations

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

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([/* ... */]);

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([/* ... */]);

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.

GetEvidenceFolder

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

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'settings' => [
        'defaultAssessmentReportsDestination' => [
            '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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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