AuditManager

Client

class AuditManager.Client

A low-level client representing AWS Audit Manager

Welcome to the Audit Manager API reference. This guide is for developers who need detailed information about the Audit Manager API operations, data types, and errors.

Audit Manager is a service that provides automated evidence collection so that you can continuously audit your Amazon Web Services usage, and assess the effectiveness of your controls to better manage risk and simplify compliance.

Audit Manager provides pre-built frameworks that structure and automate assessments for a given compliance standard. Frameworks include a pre-built collection of controls with descriptions and testing procedures, which are grouped according to the requirements of the specified compliance standard or regulation. You can also customize frameworks and controls to support internal audits with unique requirements.

Use the following links to get started with the Audit Manager API:

  • Actions : An alphabetical list of all Audit Manager API operations.
  • Data types : An alphabetical list of all Audit Manager data types.
  • Common parameters : Parameters that all Query operations can use.
  • Common errors : Client and server errors that all operations can return.

If you're new to Audit Manager, we recommend that you review the Audit Manager User Guide .

client = session.create_client('auditmanager')

These are the available methods:

associate_assessment_report_evidence_folder(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.associate_assessment_report_evidence_folder(
    assessmentId='string',
    evidenceFolderId='string'
)
Parameters
  • assessmentId (string) --

    [REQUIRED]

    The identifier for the specified assessment.

  • evidenceFolderId (string) --

    [REQUIRED]

    The identifier for the folder in which evidence is stored.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

batch_associate_assessment_report_evidence(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.batch_associate_assessment_report_evidence(
    assessmentId='string',
    evidenceFolderId='string',
    evidenceIds=[
        'string',
    ]
)
Parameters
  • assessmentId (string) --

    [REQUIRED]

    The unique identifier for the specified assessment.

  • evidenceFolderId (string) --

    [REQUIRED]

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

  • evidenceIds (list) --

    [REQUIRED]

    The list of evidence identifiers.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'evidenceIds': [
        'string',
    ],
    'errors': [
        {
            'evidenceId': 'string',
            'errorCode': 'string',
            'errorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • evidenceIds (list) --

      The identifier for the evidence.

      • (string) --
    • errors (list) --

      A list of errors returned by the BatchAssociateAssessmentReportEvidence API.

      • (dict) --

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

        • evidenceId (string) --

          The identifier for the evidence.

        • errorCode (string) --

          The error code returned by the AssessmentReportEvidence API.

        • errorMessage (string) --

          The error message returned by the AssessmentReportEvidence API.

Exceptions

batch_create_delegation_by_assessment(**kwargs)

Create a batch of delegations for a specified assessment in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.batch_create_delegation_by_assessment(
    createDelegationRequests=[
        {
            'comment': 'string',
            'controlSetId': 'string',
            'roleArn': 'string',
            'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER'
        },
    ],
    assessmentId='string'
)
Parameters
  • createDelegationRequests (list) --

    [REQUIRED]

    The API request to batch create delegations in Audit Manager.

    • (dict) --

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

      • comment (string) --

        A comment related to the delegation request.

      • controlSetId (string) --

        The unique identifier for the control set.

      • roleArn (string) --

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

      • roleType (string) --

        The type of customer persona.

        Note

        In CreateAssessment , roleType can only be PROCESS_OWNER .

        In UpdateSettings , roleType can only be PROCESS_OWNER .

        In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

  • assessmentId (string) --

    [REQUIRED]

    The identifier for the specified assessment.

Return type

dict

Returns

Response Syntax

{
    'delegations': [
        {
            'id': 'string',
            'assessmentName': 'string',
            'assessmentId': 'string',
            'status': 'IN_PROGRESS'|'UNDER_REVIEW'|'COMPLETE',
            'roleArn': 'string',
            'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
            'creationTime': datetime(2015, 1, 1),
            'lastUpdated': datetime(2015, 1, 1),
            'controlSetId': 'string',
            'comment': 'string',
            'createdBy': 'string'
        },
    ],
    'errors': [
        {
            'createDelegationRequest': {
                'comment': 'string',
                'controlSetId': 'string',
                'roleArn': 'string',
                'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER'
            },
            'errorCode': 'string',
            'errorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • delegations (list) --

      The delegations associated with the assessment.

      • (dict) --

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

        • id (string) --

          The unique identifier for the delegation.

        • assessmentName (string) --

          The name of the associated assessment.

        • assessmentId (string) --

          The identifier for the associated assessment.

        • status (string) --

          The status of the delegation.

        • roleArn (string) --

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

        • roleType (string) --

          The type of customer persona.

          Note

          In CreateAssessment , roleType can only be PROCESS_OWNER .

          In UpdateSettings , roleType can only be PROCESS_OWNER .

          In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

        • creationTime (datetime) --

          Specifies when the delegation was created.

        • lastUpdated (datetime) --

          Specifies when the delegation was last updated.

        • controlSetId (string) --

          The identifier for the associated control set.

        • comment (string) --

          The comment related to the delegation.

        • createdBy (string) --

          The IAM user or role that created the delegation.

    • errors (list) --

      A list of errors returned by the BatchCreateDelegationByAssessment API.

      • (dict) --

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

        • createDelegationRequest (dict) --

          The API request to batch create delegations in Audit Manager.

          • comment (string) --

            A comment related to the delegation request.

          • controlSetId (string) --

            The unique identifier for the control set.

          • roleArn (string) --

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

          • roleType (string) --

            The type of customer persona.

            Note

            In CreateAssessment , roleType can only be PROCESS_OWNER .

            In UpdateSettings , roleType can only be PROCESS_OWNER .

            In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

        • errorCode (string) --

          The error code returned by the BatchCreateDelegationByAssessment API.

        • errorMessage (string) --

          The error message returned by the BatchCreateDelegationByAssessment API.

Exceptions

batch_delete_delegation_by_assessment(**kwargs)

Deletes the delegations in the specified Audit Manager assessment.

See also: AWS API Documentation

Request Syntax

response = client.batch_delete_delegation_by_assessment(
    delegationIds=[
        'string',
    ],
    assessmentId='string'
)
Parameters
  • delegationIds (list) --

    [REQUIRED]

    The identifiers for the specified delegations.

    • (string) --
  • assessmentId (string) --

    [REQUIRED]

    The identifier for the specified assessment.

Return type

dict

Returns

Response Syntax

{
    'errors': [
        {
            'delegationId': 'string',
            'errorCode': 'string',
            'errorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • errors (list) --

      A list of errors returned by the BatchDeleteDelegationByAssessment API.

      • (dict) --

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

        • delegationId (string) --

          The identifier for the specified delegation.

        • errorCode (string) --

          The error code returned by the BatchDeleteDelegationByAssessment API.

        • errorMessage (string) --

          The error message returned by the BatchDeleteDelegationByAssessment API.

Exceptions

batch_disassociate_assessment_report_evidence(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.batch_disassociate_assessment_report_evidence(
    assessmentId='string',
    evidenceFolderId='string',
    evidenceIds=[
        'string',
    ]
)
Parameters
  • assessmentId (string) --

    [REQUIRED]

    The identifier for the specified assessment.

  • evidenceFolderId (string) --

    [REQUIRED]

    The identifier for the folder in which evidence is stored.

  • evidenceIds (list) --

    [REQUIRED]

    The list of evidence identifiers.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'evidenceIds': [
        'string',
    ],
    'errors': [
        {
            'evidenceId': 'string',
            'errorCode': 'string',
            'errorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • evidenceIds (list) --

      The identifier for the evidence.

      • (string) --
    • errors (list) --

      A list of errors returned by the BatchDisassociateAssessmentReportEvidence API.

      • (dict) --

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

        • evidenceId (string) --

          The identifier for the evidence.

        • errorCode (string) --

          The error code returned by the AssessmentReportEvidence API.

        • errorMessage (string) --

          The error message returned by the AssessmentReportEvidence API.

Exceptions

batch_import_evidence_to_assessment_control(**kwargs)

Uploads one or more pieces of evidence to the specified control in the assessment in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.batch_import_evidence_to_assessment_control(
    assessmentId='string',
    controlSetId='string',
    controlId='string',
    manualEvidence=[
        {
            's3ResourcePath': 'string'
        },
    ]
)
Parameters
  • assessmentId (string) --

    [REQUIRED]

    The identifier for the specified assessment.

  • controlSetId (string) --

    [REQUIRED]

    The identifier for the specified control set.

  • controlId (string) --

    [REQUIRED]

    The identifier for the specified control.

  • manualEvidence (list) --

    [REQUIRED]

    The list of manual evidence objects.

    • (dict) --

      Evidence that is uploaded to Audit Manager manually.

      • s3ResourcePath (string) --

        The Amazon S3 URL that points to a manual evidence object.

Return type

dict

Returns

Response Syntax

{
    'errors': [
        {
            'manualEvidence': {
                's3ResourcePath': 'string'
            },
            'errorCode': 'string',
            'errorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • errors (list) --

      A list of errors returned by the BatchImportEvidenceToAssessmentControl API.

      • (dict) --

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

        • manualEvidence (dict) --

          Manual evidence that cannot be collected automatically by Audit Manager.

          • s3ResourcePath (string) --

            The Amazon S3 URL that points to a manual evidence object.

        • errorCode (string) --

          The error code returned by the BatchImportEvidenceToAssessmentControl API.

        • errorMessage (string) --

          The error message returned by the BatchImportEvidenceToAssessmentControl API.

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_assessment(**kwargs)

Creates an assessment in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.create_assessment(
    name='string',
    description='string',
    assessmentReportsDestination={
        'destinationType': 'S3',
        'destination': 'string'
    },
    scope={
        'awsAccounts': [
            {
                'id': 'string',
                'emailAddress': 'string',
                'name': 'string'
            },
        ],
        'awsServices': [
            {
                'serviceName': 'string'
            },
        ]
    },
    roles=[
        {
            'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
            'roleArn': 'string'
        },
    ],
    frameworkId='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • name (string) --

    [REQUIRED]

    The name of the assessment to be created.

  • description (string) -- The optional description of the assessment to be created.
  • assessmentReportsDestination (dict) --

    [REQUIRED]

    The assessment report storage destination for the specified assessment that is being created.

    • destinationType (string) --

      The destination type, such as Amazon S3.

    • destination (string) --

      The destination of the assessment report.

  • scope (dict) --

    [REQUIRED]

    The wrapper that contains the accounts and services in scope for the assessment.

    • awsAccounts (list) --

      The accounts included in the scope of the assessment.

      • (dict) --

        The wrapper of account details, such as account ID, email address, and so on.

        • id (string) --

          The identifier for the specified account.

        • emailAddress (string) --

          The email address associated with the specified account.

        • name (string) --

          The name of the specified account.

    • awsServices (list) --

      The Amazon Web Services services included in the scope of the assessment.

      • (dict) --

        An Amazon Web Service such as Amazon S3, CloudTrail, and so on.

        • serviceName (string) --

          The name of the Amazon Web Service.

  • roles (list) --

    [REQUIRED]

    The list of roles for the specified assessment.

    • (dict) --

      The wrapper that contains the Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN).

      • roleType (string) --

        The type of customer persona.

        Note

        In CreateAssessment , roleType can only be PROCESS_OWNER .

        In UpdateSettings , roleType can only be PROCESS_OWNER .

        In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

      • roleArn (string) --

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

  • frameworkId (string) --

    [REQUIRED]

    The identifier for the specified framework.

  • tags (dict) --

    The tags associated with the assessment.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'assessment': {
        'arn': 'string',
        'awsAccount': {
            'id': 'string',
            'emailAddress': 'string',
            'name': 'string'
        },
        'metadata': {
            'name': 'string',
            'id': 'string',
            'description': 'string',
            'complianceType': 'string',
            'status': 'ACTIVE'|'INACTIVE',
            'assessmentReportsDestination': {
                'destinationType': 'S3',
                'destination': 'string'
            },
            'scope': {
                'awsAccounts': [
                    {
                        'id': 'string',
                        'emailAddress': 'string',
                        'name': 'string'
                    },
                ],
                'awsServices': [
                    {
                        'serviceName': 'string'
                    },
                ]
            },
            'roles': [
                {
                    'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                    'roleArn': 'string'
                },
            ],
            'delegations': [
                {
                    'id': 'string',
                    'assessmentName': 'string',
                    'assessmentId': 'string',
                    'status': 'IN_PROGRESS'|'UNDER_REVIEW'|'COMPLETE',
                    'roleArn': 'string',
                    'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                    'creationTime': datetime(2015, 1, 1),
                    'lastUpdated': datetime(2015, 1, 1),
                    'controlSetId': 'string',
                    'comment': 'string',
                    'createdBy': 'string'
                },
            ],
            'creationTime': datetime(2015, 1, 1),
            'lastUpdated': datetime(2015, 1, 1)
        },
        'framework': {
            'id': 'string',
            'arn': 'string',
            'metadata': {
                'name': 'string',
                'description': 'string',
                'logo': 'string',
                'complianceType': 'string'
            },
            'controlSets': [
                {
                    'id': 'string',
                    'description': 'string',
                    'status': 'ACTIVE'|'UNDER_REVIEW'|'REVIEWED',
                    'roles': [
                        {
                            'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                            'roleArn': 'string'
                        },
                    ],
                    'controls': [
                        {
                            'id': 'string',
                            'name': 'string',
                            'description': 'string',
                            'status': 'UNDER_REVIEW'|'REVIEWED'|'INACTIVE',
                            'response': 'MANUAL'|'AUTOMATE'|'DEFER'|'IGNORE',
                            'comments': [
                                {
                                    'authorName': 'string',
                                    'commentBody': 'string',
                                    'postedDate': datetime(2015, 1, 1)
                                },
                            ],
                            'evidenceSources': [
                                'string',
                            ],
                            'evidenceCount': 123,
                            'assessmentReportEvidenceCount': 123
                        },
                    ],
                    'delegations': [
                        {
                            'id': 'string',
                            'assessmentName': 'string',
                            'assessmentId': 'string',
                            'status': 'IN_PROGRESS'|'UNDER_REVIEW'|'COMPLETE',
                            'roleArn': 'string',
                            'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                            'creationTime': datetime(2015, 1, 1),
                            'lastUpdated': datetime(2015, 1, 1),
                            'controlSetId': 'string',
                            'comment': 'string',
                            'createdBy': 'string'
                        },
                    ],
                    'systemEvidenceCount': 123,
                    'manualEvidenceCount': 123
                },
            ]
        },
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • assessment (dict) --

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

      • arn (string) --

        The Amazon Resource Name (ARN) of the assessment.

      • awsAccount (dict) --

        The account associated with the assessment.

        • id (string) --

          The identifier for the specified account.

        • emailAddress (string) --

          The email address associated with the specified account.

        • name (string) --

          The name of the specified account.

      • metadata (dict) --

        The metadata for the specified assessment.

        • name (string) --

          The name of the assessment.

        • id (string) --

          The unique identifier for the assessment.

        • description (string) --

          The description of the assessment.

        • complianceType (string) --

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

        • status (string) --

          The overall status of the assessment.

        • assessmentReportsDestination (dict) --

          The destination in which evidence reports are stored for the specified assessment.

          • destinationType (string) --

            The destination type, such as Amazon S3.

          • destination (string) --

            The destination of the assessment report.

        • scope (dict) --

          The wrapper of accounts and services in scope for the assessment.

          • awsAccounts (list) --

            The accounts included in the scope of the assessment.

            • (dict) --

              The wrapper of account details, such as account ID, email address, and so on.

              • id (string) --

                The identifier for the specified account.

              • emailAddress (string) --

                The email address associated with the specified account.

              • name (string) --

                The name of the specified account.

          • awsServices (list) --

            The Amazon Web Services services included in the scope of the assessment.

            • (dict) --

              An Amazon Web Service such as Amazon S3, CloudTrail, and so on.

              • serviceName (string) --

                The name of the Amazon Web Service.

        • roles (list) --

          The roles associated with the assessment.

          • (dict) --

            The wrapper that contains the Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN).

            • roleType (string) --

              The type of customer persona.

              Note

              In CreateAssessment , roleType can only be PROCESS_OWNER .

              In UpdateSettings , roleType can only be PROCESS_OWNER .

              In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

            • roleArn (string) --

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

        • delegations (list) --

          The delegations associated with the assessment.

          • (dict) --

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

            • id (string) --

              The unique identifier for the delegation.

            • assessmentName (string) --

              The name of the associated assessment.

            • assessmentId (string) --

              The identifier for the associated assessment.

            • status (string) --

              The status of the delegation.

            • roleArn (string) --

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

            • roleType (string) --

              The type of customer persona.

              Note

              In CreateAssessment , roleType can only be PROCESS_OWNER .

              In UpdateSettings , roleType can only be PROCESS_OWNER .

              In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

            • creationTime (datetime) --

              Specifies when the delegation was created.

            • lastUpdated (datetime) --

              Specifies when the delegation was last updated.

            • controlSetId (string) --

              The identifier for the associated control set.

            • comment (string) --

              The comment related to the delegation.

            • createdBy (string) --

              The IAM user or role that created the delegation.

        • creationTime (datetime) --

          Specifies when the assessment was created.

        • lastUpdated (datetime) --

          The time of the most recent update.

      • framework (dict) --

        The framework from which the assessment was created.

        • id (string) --

          The unique identifier for the framework.

        • arn (string) --

          The Amazon Resource Name (ARN) of the specified framework.

        • metadata (dict) --

          The metadata of a framework, such as the name, ID, description, and so on.

          • name (string) --

            The name of the framework.

          • description (string) --

            The description of the framework.

          • logo (string) --

            The logo associated with the framework.

          • complianceType (string) --

            The compliance standard associated with the framework, such as PCI-DSS or HIPAA.

        • controlSets (list) --

          The control sets associated with the framework.

          • (dict) --

            Represents a set of controls in an Audit Manager assessment.

            • id (string) --

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

            • description (string) --

              The description for the control set.

            • status (string) --

              Specifies the current status of the control set.

            • roles (list) --

              The roles associated with the control set.

              • (dict) --

                The wrapper that contains the Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN).

                • roleType (string) --

                  The type of customer persona.

                  Note

                  In CreateAssessment , roleType can only be PROCESS_OWNER .

                  In UpdateSettings , roleType can only be PROCESS_OWNER .

                  In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

                • roleArn (string) --

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

            • controls (list) --

              The list of controls contained with the control set.

              • (dict) --

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

                • id (string) --

                  The identifier for the specified control.

                • name (string) --

                  The name of the specified control.

                • description (string) --

                  The description of the specified control.

                • status (string) --

                  The status of the specified control.

                • response (string) --

                  The response of the specified control.

                • comments (list) --

                  The list of comments attached to the specified control.

                  • (dict) --

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

                    • authorName (string) --

                      The name of the user who authored the comment.

                    • commentBody (string) --

                      The body text of a control comment.

                    • postedDate (datetime) --

                      The time when the comment was posted.

                • evidenceSources (list) --

                  The list of data sources for the specified evidence.

                  • (string) --
                • evidenceCount (integer) --

                  The amount of evidence generated for the control.

                • assessmentReportEvidenceCount (integer) --

                  The amount of evidence in the assessment report.

            • delegations (list) --

              The delegations associated with the control set.

              • (dict) --

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

                • id (string) --

                  The unique identifier for the delegation.

                • assessmentName (string) --

                  The name of the associated assessment.

                • assessmentId (string) --

                  The identifier for the associated assessment.

                • status (string) --

                  The status of the delegation.

                • roleArn (string) --

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

                • roleType (string) --

                  The type of customer persona.

                  Note

                  In CreateAssessment , roleType can only be PROCESS_OWNER .

                  In UpdateSettings , roleType can only be PROCESS_OWNER .

                  In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

                • creationTime (datetime) --

                  Specifies when the delegation was created.

                • lastUpdated (datetime) --

                  Specifies when the delegation was last updated.

                • controlSetId (string) --

                  The identifier for the associated control set.

                • comment (string) --

                  The comment related to the delegation.

                • createdBy (string) --

                  The IAM user or role that created the delegation.

            • systemEvidenceCount (integer) --

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

            • manualEvidenceCount (integer) --

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

      • tags (dict) --

        The tags associated with the assessment.

        • (string) --
          • (string) --

Exceptions

create_assessment_framework(**kwargs)

Creates a custom framework in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.create_assessment_framework(
    name='string',
    description='string',
    complianceType='string',
    controlSets=[
        {
            'name': 'string',
            'controls': [
                {
                    'id': 'string'
                },
            ]
        },
    ],
    tags={
        'string': 'string'
    }
)
Parameters
  • name (string) --

    [REQUIRED]

    The name of the new custom framework.

  • description (string) -- An optional description for the new custom framework.
  • complianceType (string) -- The compliance type that the new custom framework supports, such as CIS or HIPAA.
  • controlSets (list) --

    [REQUIRED]

    The control sets to be associated with the framework.

    • (dict) --

      A controlSet entity that represents a collection of controls in Audit Manager. This does not contain the control set ID.

      • name (string) -- [REQUIRED]

        The name of the specified control set.

      • controls (list) --

        The list of controls within the control set. This does not contain the control set ID.

        • (dict) --

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

          • id (string) --

            The unique identifier of the control.

  • tags (dict) --

    The tags associated with the framework.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'framework': {
        'arn': 'string',
        'id': 'string',
        'name': 'string',
        'type': 'Standard'|'Custom',
        'complianceType': 'string',
        'description': 'string',
        'logo': 'string',
        'controlSources': 'string',
        'controlSets': [
            {
                'id': 'string',
                'name': 'string',
                'controls': [
                    {
                        'arn': 'string',
                        'id': 'string',
                        'type': 'Standard'|'Custom',
                        'name': 'string',
                        'description': 'string',
                        'testingInformation': 'string',
                        'actionPlanTitle': 'string',
                        'actionPlanInstructions': 'string',
                        'controlSources': 'string',
                        'controlMappingSources': [
                            {
                                'sourceId': 'string',
                                'sourceName': 'string',
                                'sourceDescription': 'string',
                                'sourceSetUpOption': 'System_Controls_Mapping'|'Procedural_Controls_Mapping',
                                'sourceType': 'AWS_Cloudtrail'|'AWS_Config'|'AWS_Security_Hub'|'AWS_API_Call'|'MANUAL',
                                'sourceKeyword': {
                                    'keywordInputType': 'SELECT_FROM_LIST',
                                    'keywordValue': 'string'
                                },
                                'sourceFrequency': 'DAILY'|'WEEKLY'|'MONTHLY',
                                'troubleshootingText': 'string'
                            },
                        ],
                        'createdAt': datetime(2015, 1, 1),
                        'lastUpdatedAt': datetime(2015, 1, 1),
                        'createdBy': 'string',
                        'lastUpdatedBy': 'string',
                        'tags': {
                            'string': 'string'
                        }
                    },
                ]
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'lastUpdatedAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'lastUpdatedBy': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • framework (dict) --

      The name of the new framework returned by the CreateAssessmentFramework API.

      • arn (string) --

        The Amazon Resource Name (ARN) of the specified framework.

      • id (string) --

        The unique identifier for the specified framework.

      • name (string) --

        The name of the specified framework.

      • type (string) --

        The framework type, such as custom or standard.

      • complianceType (string) --

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

      • description (string) --

        The description of the specified framework.

      • logo (string) --

        The logo associated with the framework.

      • controlSources (string) --

        The sources from which Audit Manager collects evidence for the control.

      • controlSets (list) --

        The control sets associated with the framework.

        • (dict) --

          A set of controls in Audit Manager.

          • id (string) --

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

          • name (string) --

            The name of the control set.

          • controls (list) --

            The list of controls within the control set.

            • (dict) --

              A control in Audit Manager.

              • arn (string) --

                The Amazon Resource Name (ARN) of the specified control.

              • id (string) --

                The unique identifier for the control.

              • type (string) --

                The type of control, such as custom or standard.

              • name (string) --

                The name of the specified control.

              • description (string) --

                The description of the specified control.

              • testingInformation (string) --

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

              • actionPlanTitle (string) --

                The title of the action plan for remediating the control.

              • actionPlanInstructions (string) --

                The recommended actions to carry out if the control is not fulfilled.

              • controlSources (string) --

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

              • controlMappingSources (list) --

                The data mapping sources for the specified control.

                • (dict) --

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

                  • sourceId (string) --

                    The unique identifier for the specified source.

                  • sourceName (string) --

                    The name of the specified source.

                  • sourceDescription (string) --

                    The description of the specified source.

                  • sourceSetUpOption (string) --

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

                  • sourceType (string) --

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

                  • sourceKeyword (dict) --

                    The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names.

                    • keywordInputType (string) --

                      The method of input for the specified keyword.

                    • keywordValue (string) --

                      The value of the keyword used to search CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names when mapping a control data source.

                  • sourceFrequency (string) --

                    The frequency of evidence collection for the specified control mapping source.

                  • troubleshootingText (string) --

                    The instructions for troubleshooting the specified control.

              • createdAt (datetime) --

                Specifies when the control was created.

              • lastUpdatedAt (datetime) --

                Specifies when the control was most recently updated.

              • createdBy (string) --

                The IAM user or role that created the control.

              • lastUpdatedBy (string) --

                The IAM user or role that most recently updated the control.

              • tags (dict) --

                The tags associated with the control.

                • (string) --
                  • (string) --
      • createdAt (datetime) --

        Specifies when the framework was created.

      • lastUpdatedAt (datetime) --

        Specifies when the framework was most recently updated.

      • createdBy (string) --

        The IAM user or role that created the framework.

      • lastUpdatedBy (string) --

        The IAM user or role that most recently updated the framework.

      • tags (dict) --

        The tags associated with the framework.

        • (string) --
          • (string) --

Exceptions

create_assessment_report(**kwargs)

Creates an assessment report for the specified assessment.

See also: AWS API Documentation

Request Syntax

response = client.create_assessment_report(
    name='string',
    description='string',
    assessmentId='string'
)
Parameters
  • name (string) --

    [REQUIRED]

    The name of the new assessment report.

  • description (string) -- The description of the assessment report.
  • assessmentId (string) --

    [REQUIRED]

    The identifier for the specified assessment.

Return type

dict

Returns

Response Syntax

{
    'assessmentReport': {
        'id': 'string',
        'name': 'string',
        'description': 'string',
        'awsAccountId': 'string',
        'assessmentId': 'string',
        'assessmentName': 'string',
        'author': 'string',
        'status': 'COMPLETE'|'IN_PROGRESS'|'FAILED',
        'creationTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • assessmentReport (dict) --

      The new assessment report returned by the CreateAssessmentReport API.

      • id (string) --

        The unique identifier for the specified assessment report.

      • name (string) --

        The name given to the assessment report.

      • description (string) --

        The description of the specified assessment report.

      • awsAccountId (string) --

        The identifier for the specified account.

      • assessmentId (string) --

        The identifier for the specified assessment.

      • assessmentName (string) --

        The name of the associated assessment.

      • author (string) --

        The name of the user who created the assessment report.

      • status (string) --

        The current status of the specified assessment report.

      • creationTime (datetime) --

        Specifies when the assessment report was created.

Exceptions

create_control(**kwargs)

Creates a new custom control in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.create_control(
    name='string',
    description='string',
    testingInformation='string',
    actionPlanTitle='string',
    actionPlanInstructions='string',
    controlMappingSources=[
        {
            'sourceName': 'string',
            'sourceDescription': 'string',
            'sourceSetUpOption': 'System_Controls_Mapping'|'Procedural_Controls_Mapping',
            'sourceType': 'AWS_Cloudtrail'|'AWS_Config'|'AWS_Security_Hub'|'AWS_API_Call'|'MANUAL',
            'sourceKeyword': {
                'keywordInputType': 'SELECT_FROM_LIST',
                'keywordValue': 'string'
            },
            'sourceFrequency': 'DAILY'|'WEEKLY'|'MONTHLY',
            'troubleshootingText': 'string'
        },
    ],
    tags={
        'string': 'string'
    }
)
Parameters
  • name (string) --

    [REQUIRED]

    The name of the control.

  • description (string) -- The description of the control.
  • testingInformation (string) -- The steps to follow to determine if the control has been satisfied.
  • actionPlanTitle (string) -- The title of the action plan for remediating the control.
  • actionPlanInstructions (string) -- The recommended actions to carry out if the control is not fulfilled.
  • controlMappingSources (list) --

    [REQUIRED]

    The data mapping sources for the specified control.

    • (dict) --

      Control mapping fields that represent the source for evidence collection, along with related parameters and metadata. This does not contain mappingID .

      • sourceName (string) --

        The name of the control mapping data source.

      • sourceDescription (string) --

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

      • sourceSetUpOption (string) --

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

      • sourceType (string) --

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

      • sourceKeyword (dict) --

        The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names.

        • keywordInputType (string) --

          The method of input for the specified keyword.

        • keywordValue (string) --

          The value of the keyword used to search CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names when mapping a control data source.

      • sourceFrequency (string) --

        The frequency of evidence collection for the specified control mapping source.

      • troubleshootingText (string) --

        The instructions for troubleshooting the specified control.

  • tags (dict) --

    The tags associated with the control.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'control': {
        'arn': 'string',
        'id': 'string',
        'type': 'Standard'|'Custom',
        'name': 'string',
        'description': 'string',
        'testingInformation': 'string',
        'actionPlanTitle': 'string',
        'actionPlanInstructions': 'string',
        'controlSources': 'string',
        'controlMappingSources': [
            {
                'sourceId': 'string',
                'sourceName': 'string',
                'sourceDescription': 'string',
                'sourceSetUpOption': 'System_Controls_Mapping'|'Procedural_Controls_Mapping',
                'sourceType': 'AWS_Cloudtrail'|'AWS_Config'|'AWS_Security_Hub'|'AWS_API_Call'|'MANUAL',
                'sourceKeyword': {
                    'keywordInputType': 'SELECT_FROM_LIST',
                    'keywordValue': 'string'
                },
                'sourceFrequency': 'DAILY'|'WEEKLY'|'MONTHLY',
                'troubleshootingText': 'string'
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'lastUpdatedAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'lastUpdatedBy': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • control (dict) --

      The new control returned by the CreateControl API.

      • arn (string) --

        The Amazon Resource Name (ARN) of the specified control.

      • id (string) --

        The unique identifier for the control.

      • type (string) --

        The type of control, such as custom or standard.

      • name (string) --

        The name of the specified control.

      • description (string) --

        The description of the specified control.

      • testingInformation (string) --

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

      • actionPlanTitle (string) --

        The title of the action plan for remediating the control.

      • actionPlanInstructions (string) --

        The recommended actions to carry out if the control is not fulfilled.

      • controlSources (string) --

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

      • controlMappingSources (list) --

        The data mapping sources for the specified control.

        • (dict) --

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

          • sourceId (string) --

            The unique identifier for the specified source.

          • sourceName (string) --

            The name of the specified source.

          • sourceDescription (string) --

            The description of the specified source.

          • sourceSetUpOption (string) --

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

          • sourceType (string) --

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

          • sourceKeyword (dict) --

            The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names.

            • keywordInputType (string) --

              The method of input for the specified keyword.

            • keywordValue (string) --

              The value of the keyword used to search CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names when mapping a control data source.

          • sourceFrequency (string) --

            The frequency of evidence collection for the specified control mapping source.

          • troubleshootingText (string) --

            The instructions for troubleshooting the specified control.

      • createdAt (datetime) --

        Specifies when the control was created.

      • lastUpdatedAt (datetime) --

        Specifies when the control was most recently updated.

      • createdBy (string) --

        The IAM user or role that created the control.

      • lastUpdatedBy (string) --

        The IAM user or role that most recently updated the control.

      • tags (dict) --

        The tags associated with the control.

        • (string) --
          • (string) --

Exceptions

delete_assessment(**kwargs)

Deletes an assessment in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.delete_assessment(
    assessmentId='string'
)
Parameters
assessmentId (string) --

[REQUIRED]

The identifier for the specified assessment.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_assessment_framework(**kwargs)

Deletes a custom framework in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.delete_assessment_framework(
    frameworkId='string'
)
Parameters
frameworkId (string) --

[REQUIRED]

The identifier for the specified framework.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_assessment_report(**kwargs)

Deletes an assessment report from an assessment in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.delete_assessment_report(
    assessmentId='string',
    assessmentReportId='string'
)
Parameters
  • assessmentId (string) --

    [REQUIRED]

    The identifier for the specified assessment.

  • assessmentReportId (string) --

    [REQUIRED]

    The unique identifier for the assessment report.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_control(**kwargs)

Deletes a custom control in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.delete_control(
    controlId='string'
)
Parameters
controlId (string) --

[REQUIRED]

The identifier for the specified control.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

deregister_account()

Deregisters an account in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.deregister_account()
Return type
dict
Returns
Response Syntax
{
    'status': 'ACTIVE'|'INACTIVE'|'PENDING_ACTIVATION'
}

Response Structure

  • (dict) --
    • status (string) --

      The registration status of the account.

Exceptions

deregister_organization_admin_account(**kwargs)

Removes the specified member account as a delegated administrator for Audit Manager.

Warning

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

See also: AWS API Documentation

Request Syntax

response = client.deregister_organization_admin_account(
    adminAccountId='string'
)
Parameters
adminAccountId (string) -- The identifier for the specified administrator account.
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

disassociate_assessment_report_evidence_folder(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.disassociate_assessment_report_evidence_folder(
    assessmentId='string',
    evidenceFolderId='string'
)
Parameters
  • assessmentId (string) --

    [REQUIRED]

    The identifier for the specified assessment.

  • evidenceFolderId (string) --

    [REQUIRED]

    The identifier for the folder in which evidence is stored.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_account_status()

Returns the registration status of an account in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.get_account_status()
Return type
dict
Returns
Response Syntax
{
    'status': 'ACTIVE'|'INACTIVE'|'PENDING_ACTIVATION'
}

Response Structure

  • (dict) --
    • status (string) --

      The status of the specified account.

Exceptions

get_assessment(**kwargs)

Returns an assessment from Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.get_assessment(
    assessmentId='string'
)
Parameters
assessmentId (string) --

[REQUIRED]

The identifier for the specified assessment.

Return type
dict
Returns
Response Syntax
{
    'assessment': {
        'arn': 'string',
        'awsAccount': {
            'id': 'string',
            'emailAddress': 'string',
            'name': 'string'
        },
        'metadata': {
            'name': 'string',
            'id': 'string',
            'description': 'string',
            'complianceType': 'string',
            'status': 'ACTIVE'|'INACTIVE',
            'assessmentReportsDestination': {
                'destinationType': 'S3',
                'destination': 'string'
            },
            'scope': {
                'awsAccounts': [
                    {
                        'id': 'string',
                        'emailAddress': 'string',
                        'name': 'string'
                    },
                ],
                'awsServices': [
                    {
                        'serviceName': 'string'
                    },
                ]
            },
            'roles': [
                {
                    'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                    'roleArn': 'string'
                },
            ],
            'delegations': [
                {
                    'id': 'string',
                    'assessmentName': 'string',
                    'assessmentId': 'string',
                    'status': 'IN_PROGRESS'|'UNDER_REVIEW'|'COMPLETE',
                    'roleArn': 'string',
                    'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                    'creationTime': datetime(2015, 1, 1),
                    'lastUpdated': datetime(2015, 1, 1),
                    'controlSetId': 'string',
                    'comment': 'string',
                    'createdBy': 'string'
                },
            ],
            'creationTime': datetime(2015, 1, 1),
            'lastUpdated': datetime(2015, 1, 1)
        },
        'framework': {
            'id': 'string',
            'arn': 'string',
            'metadata': {
                'name': 'string',
                'description': 'string',
                'logo': 'string',
                'complianceType': 'string'
            },
            'controlSets': [
                {
                    'id': 'string',
                    'description': 'string',
                    'status': 'ACTIVE'|'UNDER_REVIEW'|'REVIEWED',
                    'roles': [
                        {
                            'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                            'roleArn': 'string'
                        },
                    ],
                    'controls': [
                        {
                            'id': 'string',
                            'name': 'string',
                            'description': 'string',
                            'status': 'UNDER_REVIEW'|'REVIEWED'|'INACTIVE',
                            'response': 'MANUAL'|'AUTOMATE'|'DEFER'|'IGNORE',
                            'comments': [
                                {
                                    'authorName': 'string',
                                    'commentBody': 'string',
                                    'postedDate': datetime(2015, 1, 1)
                                },
                            ],
                            'evidenceSources': [
                                'string',
                            ],
                            'evidenceCount': 123,
                            'assessmentReportEvidenceCount': 123
                        },
                    ],
                    'delegations': [
                        {
                            'id': 'string',
                            'assessmentName': 'string',
                            'assessmentId': 'string',
                            'status': 'IN_PROGRESS'|'UNDER_REVIEW'|'COMPLETE',
                            'roleArn': 'string',
                            'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                            'creationTime': datetime(2015, 1, 1),
                            'lastUpdated': datetime(2015, 1, 1),
                            'controlSetId': 'string',
                            'comment': 'string',
                            'createdBy': 'string'
                        },
                    ],
                    'systemEvidenceCount': 123,
                    'manualEvidenceCount': 123
                },
            ]
        },
        'tags': {
            'string': 'string'
        }
    },
    'userRole': {
        'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
        'roleArn': 'string'
    }
}

Response Structure

  • (dict) --
    • assessment (dict) --

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

      • arn (string) --

        The Amazon Resource Name (ARN) of the assessment.

      • awsAccount (dict) --

        The account associated with the assessment.

        • id (string) --

          The identifier for the specified account.

        • emailAddress (string) --

          The email address associated with the specified account.

        • name (string) --

          The name of the specified account.

      • metadata (dict) --

        The metadata for the specified assessment.

        • name (string) --

          The name of the assessment.

        • id (string) --

          The unique identifier for the assessment.

        • description (string) --

          The description of the assessment.

        • complianceType (string) --

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

        • status (string) --

          The overall status of the assessment.

        • assessmentReportsDestination (dict) --

          The destination in which evidence reports are stored for the specified assessment.

          • destinationType (string) --

            The destination type, such as Amazon S3.

          • destination (string) --

            The destination of the assessment report.

        • scope (dict) --

          The wrapper of accounts and services in scope for the assessment.

          • awsAccounts (list) --

            The accounts included in the scope of the assessment.

            • (dict) --

              The wrapper of account details, such as account ID, email address, and so on.

              • id (string) --

                The identifier for the specified account.

              • emailAddress (string) --

                The email address associated with the specified account.

              • name (string) --

                The name of the specified account.

          • awsServices (list) --

            The Amazon Web Services services included in the scope of the assessment.

            • (dict) --

              An Amazon Web Service such as Amazon S3, CloudTrail, and so on.

              • serviceName (string) --

                The name of the Amazon Web Service.

        • roles (list) --

          The roles associated with the assessment.

          • (dict) --

            The wrapper that contains the Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN).

            • roleType (string) --

              The type of customer persona.

              Note

              In CreateAssessment , roleType can only be PROCESS_OWNER .

              In UpdateSettings , roleType can only be PROCESS_OWNER .

              In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

            • roleArn (string) --

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

        • delegations (list) --

          The delegations associated with the assessment.

          • (dict) --

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

            • id (string) --

              The unique identifier for the delegation.

            • assessmentName (string) --

              The name of the associated assessment.

            • assessmentId (string) --

              The identifier for the associated assessment.

            • status (string) --

              The status of the delegation.

            • roleArn (string) --

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

            • roleType (string) --

              The type of customer persona.

              Note

              In CreateAssessment , roleType can only be PROCESS_OWNER .

              In UpdateSettings , roleType can only be PROCESS_OWNER .

              In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

            • creationTime (datetime) --

              Specifies when the delegation was created.

            • lastUpdated (datetime) --

              Specifies when the delegation was last updated.

            • controlSetId (string) --

              The identifier for the associated control set.

            • comment (string) --

              The comment related to the delegation.

            • createdBy (string) --

              The IAM user or role that created the delegation.

        • creationTime (datetime) --

          Specifies when the assessment was created.

        • lastUpdated (datetime) --

          The time of the most recent update.

      • framework (dict) --

        The framework from which the assessment was created.

        • id (string) --

          The unique identifier for the framework.

        • arn (string) --

          The Amazon Resource Name (ARN) of the specified framework.

        • metadata (dict) --

          The metadata of a framework, such as the name, ID, description, and so on.

          • name (string) --

            The name of the framework.

          • description (string) --

            The description of the framework.

          • logo (string) --

            The logo associated with the framework.

          • complianceType (string) --

            The compliance standard associated with the framework, such as PCI-DSS or HIPAA.

        • controlSets (list) --

          The control sets associated with the framework.

          • (dict) --

            Represents a set of controls in an Audit Manager assessment.

            • id (string) --

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

            • description (string) --

              The description for the control set.

            • status (string) --

              Specifies the current status of the control set.

            • roles (list) --

              The roles associated with the control set.

              • (dict) --

                The wrapper that contains the Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN).

                • roleType (string) --

                  The type of customer persona.

                  Note

                  In CreateAssessment , roleType can only be PROCESS_OWNER .

                  In UpdateSettings , roleType can only be PROCESS_OWNER .

                  In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

                • roleArn (string) --

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

            • controls (list) --

              The list of controls contained with the control set.

              • (dict) --

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

                • id (string) --

                  The identifier for the specified control.

                • name (string) --

                  The name of the specified control.

                • description (string) --

                  The description of the specified control.

                • status (string) --

                  The status of the specified control.

                • response (string) --

                  The response of the specified control.

                • comments (list) --

                  The list of comments attached to the specified control.

                  • (dict) --

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

                    • authorName (string) --

                      The name of the user who authored the comment.

                    • commentBody (string) --

                      The body text of a control comment.

                    • postedDate (datetime) --

                      The time when the comment was posted.

                • evidenceSources (list) --

                  The list of data sources for the specified evidence.

                  • (string) --
                • evidenceCount (integer) --

                  The amount of evidence generated for the control.

                • assessmentReportEvidenceCount (integer) --

                  The amount of evidence in the assessment report.

            • delegations (list) --

              The delegations associated with the control set.

              • (dict) --

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

                • id (string) --

                  The unique identifier for the delegation.

                • assessmentName (string) --

                  The name of the associated assessment.

                • assessmentId (string) --

                  The identifier for the associated assessment.

                • status (string) --

                  The status of the delegation.

                • roleArn (string) --

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

                • roleType (string) --

                  The type of customer persona.

                  Note

                  In CreateAssessment , roleType can only be PROCESS_OWNER .

                  In UpdateSettings , roleType can only be PROCESS_OWNER .

                  In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

                • creationTime (datetime) --

                  Specifies when the delegation was created.

                • lastUpdated (datetime) --

                  Specifies when the delegation was last updated.

                • controlSetId (string) --

                  The identifier for the associated control set.

                • comment (string) --

                  The comment related to the delegation.

                • createdBy (string) --

                  The IAM user or role that created the delegation.

            • systemEvidenceCount (integer) --

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

            • manualEvidenceCount (integer) --

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

      • tags (dict) --

        The tags associated with the assessment.

        • (string) --
          • (string) --
    • userRole (dict) --

      The wrapper that contains the Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN).

      • roleType (string) --

        The type of customer persona.

        Note

        In CreateAssessment , roleType can only be PROCESS_OWNER .

        In UpdateSettings , roleType can only be PROCESS_OWNER .

        In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

      • roleArn (string) --

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

Exceptions

get_assessment_framework(**kwargs)

Returns a framework from Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.get_assessment_framework(
    frameworkId='string'
)
Parameters
frameworkId (string) --

[REQUIRED]

The identifier for the specified framework.

Return type
dict
Returns
Response Syntax
{
    'framework': {
        'arn': 'string',
        'id': 'string',
        'name': 'string',
        'type': 'Standard'|'Custom',
        'complianceType': 'string',
        'description': 'string',
        'logo': 'string',
        'controlSources': 'string',
        'controlSets': [
            {
                'id': 'string',
                'name': 'string',
                'controls': [
                    {
                        'arn': 'string',
                        'id': 'string',
                        'type': 'Standard'|'Custom',
                        'name': 'string',
                        'description': 'string',
                        'testingInformation': 'string',
                        'actionPlanTitle': 'string',
                        'actionPlanInstructions': 'string',
                        'controlSources': 'string',
                        'controlMappingSources': [
                            {
                                'sourceId': 'string',
                                'sourceName': 'string',
                                'sourceDescription': 'string',
                                'sourceSetUpOption': 'System_Controls_Mapping'|'Procedural_Controls_Mapping',
                                'sourceType': 'AWS_Cloudtrail'|'AWS_Config'|'AWS_Security_Hub'|'AWS_API_Call'|'MANUAL',
                                'sourceKeyword': {
                                    'keywordInputType': 'SELECT_FROM_LIST',
                                    'keywordValue': 'string'
                                },
                                'sourceFrequency': 'DAILY'|'WEEKLY'|'MONTHLY',
                                'troubleshootingText': 'string'
                            },
                        ],
                        'createdAt': datetime(2015, 1, 1),
                        'lastUpdatedAt': datetime(2015, 1, 1),
                        'createdBy': 'string',
                        'lastUpdatedBy': 'string',
                        'tags': {
                            'string': 'string'
                        }
                    },
                ]
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'lastUpdatedAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'lastUpdatedBy': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --
    • framework (dict) --

      The framework returned by the GetAssessmentFramework API.

      • arn (string) --

        The Amazon Resource Name (ARN) of the specified framework.

      • id (string) --

        The unique identifier for the specified framework.

      • name (string) --

        The name of the specified framework.

      • type (string) --

        The framework type, such as custom or standard.

      • complianceType (string) --

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

      • description (string) --

        The description of the specified framework.

      • logo (string) --

        The logo associated with the framework.

      • controlSources (string) --

        The sources from which Audit Manager collects evidence for the control.

      • controlSets (list) --

        The control sets associated with the framework.

        • (dict) --

          A set of controls in Audit Manager.

          • id (string) --

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

          • name (string) --

            The name of the control set.

          • controls (list) --

            The list of controls within the control set.

            • (dict) --

              A control in Audit Manager.

              • arn (string) --

                The Amazon Resource Name (ARN) of the specified control.

              • id (string) --

                The unique identifier for the control.

              • type (string) --

                The type of control, such as custom or standard.

              • name (string) --

                The name of the specified control.

              • description (string) --

                The description of the specified control.

              • testingInformation (string) --

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

              • actionPlanTitle (string) --

                The title of the action plan for remediating the control.

              • actionPlanInstructions (string) --

                The recommended actions to carry out if the control is not fulfilled.

              • controlSources (string) --

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

              • controlMappingSources (list) --

                The data mapping sources for the specified control.

                • (dict) --

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

                  • sourceId (string) --

                    The unique identifier for the specified source.

                  • sourceName (string) --

                    The name of the specified source.

                  • sourceDescription (string) --

                    The description of the specified source.

                  • sourceSetUpOption (string) --

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

                  • sourceType (string) --

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

                  • sourceKeyword (dict) --

                    The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names.

                    • keywordInputType (string) --

                      The method of input for the specified keyword.

                    • keywordValue (string) --

                      The value of the keyword used to search CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names when mapping a control data source.

                  • sourceFrequency (string) --

                    The frequency of evidence collection for the specified control mapping source.

                  • troubleshootingText (string) --

                    The instructions for troubleshooting the specified control.

              • createdAt (datetime) --

                Specifies when the control was created.

              • lastUpdatedAt (datetime) --

                Specifies when the control was most recently updated.

              • createdBy (string) --

                The IAM user or role that created the control.

              • lastUpdatedBy (string) --

                The IAM user or role that most recently updated the control.

              • tags (dict) --

                The tags associated with the control.

                • (string) --
                  • (string) --
      • createdAt (datetime) --

        Specifies when the framework was created.

      • lastUpdatedAt (datetime) --

        Specifies when the framework was most recently updated.

      • createdBy (string) --

        The IAM user or role that created the framework.

      • lastUpdatedBy (string) --

        The IAM user or role that most recently updated the framework.

      • tags (dict) --

        The tags associated with the framework.

        • (string) --
          • (string) --

Exceptions

get_assessment_report_url(**kwargs)

Returns the URL of a specified assessment report in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.get_assessment_report_url(
    assessmentReportId='string',
    assessmentId='string'
)
Parameters
  • assessmentReportId (string) --

    [REQUIRED]

    The identifier for the assessment report.

  • assessmentId (string) --

    [REQUIRED]

    The identifier for the specified assessment.

Return type

dict

Returns

Response Syntax

{
    'preSignedUrl': {
        'hyperlinkName': 'string',
        'link': 'string'
    }
}

Response Structure

  • (dict) --

    • preSignedUrl (dict) --

      A uniform resource locator, used as a unique identifier to locate a resource on the internet.

      • hyperlinkName (string) --

        The name or word used as a hyperlink to the URL.

      • link (string) --

        The unique identifier for the internet resource.

Exceptions

get_change_logs(**kwargs)

Returns a list of changelogs from Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.get_change_logs(
    assessmentId='string',
    controlSetId='string',
    controlId='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • assessmentId (string) --

    [REQUIRED]

    The identifier for the specified assessment.

  • controlSetId (string) -- The identifier for the specified control set.
  • controlId (string) -- The identifier for the specified control.
  • nextToken (string) -- The pagination token used to fetch the next set of results.
  • maxResults (integer) -- Represents the maximum number of results per page, or per API request call.
Return type

dict

Returns

Response Syntax

{
    'changeLogs': [
        {
            'objectType': 'ASSESSMENT'|'CONTROL_SET'|'CONTROL'|'DELEGATION'|'ASSESSMENT_REPORT',
            'objectName': 'string',
            'action': 'CREATE'|'UPDATE_METADATA'|'ACTIVE'|'INACTIVE'|'DELETE'|'UNDER_REVIEW'|'REVIEWED'|'IMPORT_EVIDENCE',
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • changeLogs (list) --

      The list of user activity for the control.

      • (dict) --

        The record of a change within Audit Manager, such as a modified assessment, a delegated control set, and so on.

        • objectType (string) --

          The changelog object type, such as an assessment, control, or control set.

        • objectName (string) --

          The name of the changelog object.

        • action (string) --

          The action performed.

        • createdAt (datetime) --

          The time of creation for the changelog object.

        • createdBy (string) --

          The IAM user or role that performed the action.

    • nextToken (string) --

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

Exceptions

get_control(**kwargs)

Returns a control from Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.get_control(
    controlId='string'
)
Parameters
controlId (string) --

[REQUIRED]

The identifier for the specified control.

Return type
dict
Returns
Response Syntax
{
    'control': {
        'arn': 'string',
        'id': 'string',
        'type': 'Standard'|'Custom',
        'name': 'string',
        'description': 'string',
        'testingInformation': 'string',
        'actionPlanTitle': 'string',
        'actionPlanInstructions': 'string',
        'controlSources': 'string',
        'controlMappingSources': [
            {
                'sourceId': 'string',
                'sourceName': 'string',
                'sourceDescription': 'string',
                'sourceSetUpOption': 'System_Controls_Mapping'|'Procedural_Controls_Mapping',
                'sourceType': 'AWS_Cloudtrail'|'AWS_Config'|'AWS_Security_Hub'|'AWS_API_Call'|'MANUAL',
                'sourceKeyword': {
                    'keywordInputType': 'SELECT_FROM_LIST',
                    'keywordValue': 'string'
                },
                'sourceFrequency': 'DAILY'|'WEEKLY'|'MONTHLY',
                'troubleshootingText': 'string'
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'lastUpdatedAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'lastUpdatedBy': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --
    • control (dict) --

      The name of the control returned by the GetControl API.

      • arn (string) --

        The Amazon Resource Name (ARN) of the specified control.

      • id (string) --

        The unique identifier for the control.

      • type (string) --

        The type of control, such as custom or standard.

      • name (string) --

        The name of the specified control.

      • description (string) --

        The description of the specified control.

      • testingInformation (string) --

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

      • actionPlanTitle (string) --

        The title of the action plan for remediating the control.

      • actionPlanInstructions (string) --

        The recommended actions to carry out if the control is not fulfilled.

      • controlSources (string) --

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

      • controlMappingSources (list) --

        The data mapping sources for the specified control.

        • (dict) --

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

          • sourceId (string) --

            The unique identifier for the specified source.

          • sourceName (string) --

            The name of the specified source.

          • sourceDescription (string) --

            The description of the specified source.

          • sourceSetUpOption (string) --

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

          • sourceType (string) --

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

          • sourceKeyword (dict) --

            The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names.

            • keywordInputType (string) --

              The method of input for the specified keyword.

            • keywordValue (string) --

              The value of the keyword used to search CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names when mapping a control data source.

          • sourceFrequency (string) --

            The frequency of evidence collection for the specified control mapping source.

          • troubleshootingText (string) --

            The instructions for troubleshooting the specified control.

      • createdAt (datetime) --

        Specifies when the control was created.

      • lastUpdatedAt (datetime) --

        Specifies when the control was most recently updated.

      • createdBy (string) --

        The IAM user or role that created the control.

      • lastUpdatedBy (string) --

        The IAM user or role that most recently updated the control.

      • tags (dict) --

        The tags associated with the control.

        • (string) --
          • (string) --

Exceptions

get_delegations(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_delegations(
    nextToken='string',
    maxResults=123
)
Parameters
  • nextToken (string) -- The pagination token used to fetch the next set of results.
  • maxResults (integer) -- Represents the maximum number of results per page, or per API request call.
Return type

dict

Returns

Response Syntax

{
    'delegations': [
        {
            'id': 'string',
            'assessmentName': 'string',
            'assessmentId': 'string',
            'status': 'IN_PROGRESS'|'UNDER_REVIEW'|'COMPLETE',
            'roleArn': 'string',
            'creationTime': datetime(2015, 1, 1),
            'controlSetName': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • delegations (list) --

      The list of delegations returned by the GetDelegations API.

      • (dict) --

        The metadata associated with the specified delegation.

        • id (string) --

          The unique identifier for the delegation.

        • assessmentName (string) --

          The name of the associated assessment.

        • assessmentId (string) --

          The unique identifier for the specified assessment.

        • status (string) --

          The current status of the delgation.

        • roleArn (string) --

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

        • creationTime (datetime) --

          Specifies when the delegation was created.

        • controlSetName (string) --

          Specifies the name of the control set delegated for review.

    • nextToken (string) --

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

Exceptions

get_evidence(**kwargs)

Returns evidence from Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.get_evidence(
    assessmentId='string',
    controlSetId='string',
    evidenceFolderId='string',
    evidenceId='string'
)
Parameters
  • assessmentId (string) --

    [REQUIRED]

    The identifier for the specified assessment.

  • controlSetId (string) --

    [REQUIRED]

    The identifier for the specified control set.

  • evidenceFolderId (string) --

    [REQUIRED]

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

  • evidenceId (string) --

    [REQUIRED]

    The identifier for the evidence.

Return type

dict

Returns

Response Syntax

{
    'evidence': {
        'dataSource': 'string',
        'evidenceAwsAccountId': 'string',
        'time': datetime(2015, 1, 1),
        'eventSource': 'string',
        'eventName': 'string',
        'evidenceByType': 'string',
        'resourcesIncluded': [
            {
                'arn': 'string',
                'value': 'string'
            },
        ],
        'attributes': {
            'string': 'string'
        },
        'iamId': 'string',
        'complianceCheck': 'string',
        'awsOrganization': 'string',
        'awsAccountId': 'string',
        'evidenceFolderId': 'string',
        'id': 'string',
        'assessmentReportSelection': 'string'
    }
}

Response Structure

  • (dict) --

    • evidence (dict) --

      The evidence returned by the GetEvidenceResponse API.

      • dataSource (string) --

        The data source from which the specified evidence was collected.

      • evidenceAwsAccountId (string) --

        The identifier for the specified account.

      • time (datetime) --

        The timestamp that represents when the evidence was collected.

      • eventSource (string) --

        The Amazon Web Service from which the evidence is collected.

      • eventName (string) --

        The name of the specified evidence event.

      • evidenceByType (string) --

        The type of automated evidence.

      • resourcesIncluded (list) --

        The list of resources assessed to generate the evidence.

        • (dict) --

          A system asset that is evaluated in an Audit Manager assessment.

          • arn (string) --

            The Amazon Resource Name (ARN) for the specified resource.

          • value (string) --

            The value of the specified resource.

      • attributes (dict) --

        The names and values used by the evidence event, including an attribute name (such as allowUsersToChangePassword ) and value (such as true or false ).

        • (string) --
          • (string) --
      • iamId (string) --

        The unique identifier for the IAM user or role associated with the evidence.

      • complianceCheck (string) --

        The evaluation status for evidence that falls under the compliance check category. For evidence collected from Security Hub, a Pass or Fail result is shown. For evidence collected from Config, a Compliant or Noncompliant result is shown.

      • awsOrganization (string) --

        The account from which the evidence is collected, and its organization path.

      • awsAccountId (string) --

        The identifier for the specified account.

      • evidenceFolderId (string) --

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

      • id (string) --

        The identifier for the evidence.

      • assessmentReportSelection (string) --

        Specifies whether the evidence is included in the assessment report.

Exceptions

get_evidence_by_evidence_folder(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_evidence_by_evidence_folder(
    assessmentId='string',
    controlSetId='string',
    evidenceFolderId='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • assessmentId (string) --

    [REQUIRED]

    The identifier for the specified assessment.

  • controlSetId (string) --

    [REQUIRED]

    The identifier for the control set.

  • evidenceFolderId (string) --

    [REQUIRED]

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

  • nextToken (string) -- The pagination token used to fetch the next set of results.
  • maxResults (integer) -- Represents the maximum number of results per page, or per API request call.
Return type

dict

Returns

Response Syntax

{
    'evidence': [
        {
            'dataSource': 'string',
            'evidenceAwsAccountId': 'string',
            'time': datetime(2015, 1, 1),
            'eventSource': 'string',
            'eventName': 'string',
            'evidenceByType': 'string',
            'resourcesIncluded': [
                {
                    'arn': 'string',
                    'value': 'string'
                },
            ],
            'attributes': {
                'string': 'string'
            },
            'iamId': 'string',
            'complianceCheck': 'string',
            'awsOrganization': 'string',
            'awsAccountId': 'string',
            'evidenceFolderId': 'string',
            'id': 'string',
            'assessmentReportSelection': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • evidence (list) --

      The list of evidence returned by the GetEvidenceByEvidenceFolder API.

      • (dict) --

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

        • dataSource (string) --

          The data source from which the specified evidence was collected.

        • evidenceAwsAccountId (string) --

          The identifier for the specified account.

        • time (datetime) --

          The timestamp that represents when the evidence was collected.

        • eventSource (string) --

          The Amazon Web Service from which the evidence is collected.

        • eventName (string) --

          The name of the specified evidence event.

        • evidenceByType (string) --

          The type of automated evidence.

        • resourcesIncluded (list) --

          The list of resources assessed to generate the evidence.

          • (dict) --

            A system asset that is evaluated in an Audit Manager assessment.

            • arn (string) --

              The Amazon Resource Name (ARN) for the specified resource.

            • value (string) --

              The value of the specified resource.

        • attributes (dict) --

          The names and values used by the evidence event, including an attribute name (such as allowUsersToChangePassword ) and value (such as true or false ).

          • (string) --
            • (string) --
        • iamId (string) --

          The unique identifier for the IAM user or role associated with the evidence.

        • complianceCheck (string) --

          The evaluation status for evidence that falls under the compliance check category. For evidence collected from Security Hub, a Pass or Fail result is shown. For evidence collected from Config, a Compliant or Noncompliant result is shown.

        • awsOrganization (string) --

          The account from which the evidence is collected, and its organization path.

        • awsAccountId (string) --

          The identifier for the specified account.

        • evidenceFolderId (string) --

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

        • id (string) --

          The identifier for the evidence.

        • assessmentReportSelection (string) --

          Specifies whether the evidence is included in the assessment report.

    • nextToken (string) --

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

Exceptions

get_evidence_folder(**kwargs)

Returns an evidence folder from the specified assessment in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.get_evidence_folder(
    assessmentId='string',
    controlSetId='string',
    evidenceFolderId='string'
)
Parameters
  • assessmentId (string) --

    [REQUIRED]

    The identifier for the specified assessment.

  • controlSetId (string) --

    [REQUIRED]

    The identifier for the specified control set.

  • evidenceFolderId (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'evidenceFolder': {
        'name': 'string',
        'date': datetime(2015, 1, 1),
        'assessmentId': 'string',
        'controlSetId': 'string',
        'controlId': 'string',
        'id': 'string',
        'dataSource': 'string',
        'author': 'string',
        'totalEvidence': 123,
        'assessmentReportSelectionCount': 123,
        'controlName': 'string',
        'evidenceResourcesIncludedCount': 123,
        'evidenceByTypeConfigurationDataCount': 123,
        'evidenceByTypeManualCount': 123,
        'evidenceByTypeComplianceCheckCount': 123,
        'evidenceByTypeComplianceCheckIssuesCount': 123,
        'evidenceByTypeUserActivityCount': 123,
        'evidenceAwsServiceSourceCount': 123
    }
}

Response Structure

  • (dict) --

    • evidenceFolder (dict) --

      The folder in which evidence is stored.

      • name (string) --

        The name of the specified evidence folder.

      • date (datetime) --

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

      • assessmentId (string) --

        The identifier for the specified assessment.

      • controlSetId (string) --

        The identifier for the control set.

      • controlId (string) --

        The unique identifier for the specified control.

      • id (string) --

        The identifier for the folder in which evidence is stored.

      • dataSource (string) --

        The Amazon Web Service from which the evidence was collected.

      • author (string) --

        The name of the user who created the evidence folder.

      • totalEvidence (integer) --

        The total amount of evidence in the evidence folder.

      • assessmentReportSelectionCount (integer) --

        The total count of evidence included in the assessment report.

      • controlName (string) --

        The name of the control.

      • evidenceResourcesIncludedCount (integer) --

        The amount of evidence included in the evidence folder.

      • evidenceByTypeConfigurationDataCount (integer) --

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

      • evidenceByTypeManualCount (integer) --

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

      • evidenceByTypeComplianceCheckCount (integer) --

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

      • evidenceByTypeComplianceCheckIssuesCount (integer) --

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

      • evidenceByTypeUserActivityCount (integer) --

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

      • evidenceAwsServiceSourceCount (integer) --

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

Exceptions

get_evidence_folders_by_assessment(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_evidence_folders_by_assessment(
    assessmentId='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • assessmentId (string) --

    [REQUIRED]

    The identifier for the specified assessment.

  • nextToken (string) -- The pagination token used to fetch the next set of results.
  • maxResults (integer) -- Represents the maximum number of results per page, or per API request call.
Return type

dict

Returns

Response Syntax

{
    'evidenceFolders': [
        {
            'name': 'string',
            'date': datetime(2015, 1, 1),
            'assessmentId': 'string',
            'controlSetId': 'string',
            'controlId': 'string',
            'id': 'string',
            'dataSource': 'string',
            'author': 'string',
            'totalEvidence': 123,
            'assessmentReportSelectionCount': 123,
            'controlName': 'string',
            'evidenceResourcesIncludedCount': 123,
            'evidenceByTypeConfigurationDataCount': 123,
            'evidenceByTypeManualCount': 123,
            'evidenceByTypeComplianceCheckCount': 123,
            'evidenceByTypeComplianceCheckIssuesCount': 123,
            'evidenceByTypeUserActivityCount': 123,
            'evidenceAwsServiceSourceCount': 123
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • evidenceFolders (list) --

      The list of evidence folders returned by the GetEvidenceFoldersByAssessment API.

      • (dict) --

        The folder in which Audit Manager stores evidence for an assessment.

        • name (string) --

          The name of the specified evidence folder.

        • date (datetime) --

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

        • assessmentId (string) --

          The identifier for the specified assessment.

        • controlSetId (string) --

          The identifier for the control set.

        • controlId (string) --

          The unique identifier for the specified control.

        • id (string) --

          The identifier for the folder in which evidence is stored.

        • dataSource (string) --

          The Amazon Web Service from which the evidence was collected.

        • author (string) --

          The name of the user who created the evidence folder.

        • totalEvidence (integer) --

          The total amount of evidence in the evidence folder.

        • assessmentReportSelectionCount (integer) --

          The total count of evidence included in the assessment report.

        • controlName (string) --

          The name of the control.

        • evidenceResourcesIncludedCount (integer) --

          The amount of evidence included in the evidence folder.

        • evidenceByTypeConfigurationDataCount (integer) --

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

        • evidenceByTypeManualCount (integer) --

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

        • evidenceByTypeComplianceCheckCount (integer) --

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

        • evidenceByTypeComplianceCheckIssuesCount (integer) --

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

        • evidenceByTypeUserActivityCount (integer) --

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

        • evidenceAwsServiceSourceCount (integer) --

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

    • nextToken (string) --

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

Exceptions

get_evidence_folders_by_assessment_control(**kwargs)

Returns a list of evidence folders associated with a specified control of an assessment in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.get_evidence_folders_by_assessment_control(
    assessmentId='string',
    controlSetId='string',
    controlId='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • assessmentId (string) --

    [REQUIRED]

    The identifier for the specified assessment.

  • controlSetId (string) --

    [REQUIRED]

    The identifier for the specified control set.

  • controlId (string) --

    [REQUIRED]

    The identifier for the specified control.

  • nextToken (string) -- The pagination token used to fetch the next set of results.
  • maxResults (integer) -- Represents the maximum number of results per page, or per API request call.
Return type

dict

Returns

Response Syntax

{
    'evidenceFolders': [
        {
            'name': 'string',
            'date': datetime(2015, 1, 1),
            'assessmentId': 'string',
            'controlSetId': 'string',
            'controlId': 'string',
            'id': 'string',
            'dataSource': 'string',
            'author': 'string',
            'totalEvidence': 123,
            'assessmentReportSelectionCount': 123,
            'controlName': 'string',
            'evidenceResourcesIncludedCount': 123,
            'evidenceByTypeConfigurationDataCount': 123,
            'evidenceByTypeManualCount': 123,
            'evidenceByTypeComplianceCheckCount': 123,
            'evidenceByTypeComplianceCheckIssuesCount': 123,
            'evidenceByTypeUserActivityCount': 123,
            'evidenceAwsServiceSourceCount': 123
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • evidenceFolders (list) --

      The list of evidence folders returned by the GetEvidenceFoldersByAssessmentControl API.

      • (dict) --

        The folder in which Audit Manager stores evidence for an assessment.

        • name (string) --

          The name of the specified evidence folder.

        • date (datetime) --

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

        • assessmentId (string) --

          The identifier for the specified assessment.

        • controlSetId (string) --

          The identifier for the control set.

        • controlId (string) --

          The unique identifier for the specified control.

        • id (string) --

          The identifier for the folder in which evidence is stored.

        • dataSource (string) --

          The Amazon Web Service from which the evidence was collected.

        • author (string) --

          The name of the user who created the evidence folder.

        • totalEvidence (integer) --

          The total amount of evidence in the evidence folder.

        • assessmentReportSelectionCount (integer) --

          The total count of evidence included in the assessment report.

        • controlName (string) --

          The name of the control.

        • evidenceResourcesIncludedCount (integer) --

          The amount of evidence included in the evidence folder.

        • evidenceByTypeConfigurationDataCount (integer) --

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

        • evidenceByTypeManualCount (integer) --

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

        • evidenceByTypeComplianceCheckCount (integer) --

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

        • evidenceByTypeComplianceCheckIssuesCount (integer) --

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

        • evidenceByTypeUserActivityCount (integer) --

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

        • evidenceAwsServiceSourceCount (integer) --

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

    • nextToken (string) --

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

Exceptions

get_organization_admin_account()

Returns the name of the delegated Amazon Web Services administrator account for the organization.

See also: AWS API Documentation

Request Syntax

response = client.get_organization_admin_account()
Return type
dict
Returns
Response Syntax
{
    'adminAccountId': 'string',
    'organizationId': 'string'
}

Response Structure

  • (dict) --
    • adminAccountId (string) --

      The identifier for the specified administrator account.

    • organizationId (string) --

      The identifier for the specified organization.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_services_in_scope()

Returns a list of the in-scope Amazon Web Services services for the specified assessment.

See also: AWS API Documentation

Request Syntax

response = client.get_services_in_scope()
Return type
dict
Returns
Response Syntax
{
    'serviceMetadata': [
        {
            'name': 'string',
            'displayName': 'string',
            'description': 'string',
            'category': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • serviceMetadata (list) --

      The metadata associated with the Amazon Web Service.

      • (dict) --

        The metadata associated with the specified Amazon Web Service.

        • name (string) --

          The name of the Amazon Web Service.

        • displayName (string) --

          The display name of the Amazon Web Service.

        • description (string) --

          The description of the specified Amazon Web Service.

        • category (string) --

          The category in which the Amazon Web Service belongs, such as compute, storage, database, and so on.

Exceptions

get_settings(**kwargs)

Returns the settings for the specified account.

See also: AWS API Documentation

Request Syntax

response = client.get_settings(
    attribute='ALL'|'IS_AWS_ORG_ENABLED'|'SNS_TOPIC'|'DEFAULT_ASSESSMENT_REPORTS_DESTINATION'|'DEFAULT_PROCESS_OWNERS'
)
Parameters
attribute (string) --

[REQUIRED]

The list of SettingAttribute enum values.

Return type
dict
Returns
Response Syntax
{
    'settings': {
        'isAwsOrgEnabled': True|False,
        'snsTopic': 'string',
        'defaultAssessmentReportsDestination': {
            'destinationType': 'S3',
            'destination': 'string'
        },
        'defaultProcessOwners': [
            {
                'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                'roleArn': 'string'
            },
        ],
        'kmsKey': 'string'
    }
}

Response Structure

  • (dict) --
    • settings (dict) --

      The settings object that holds all supported Audit Manager settings.

      • isAwsOrgEnabled (boolean) --

        Specifies whether Organizations is enabled.

      • snsTopic (string) --

        The designated Amazon Simple Notification Service (Amazon SNS) topic.

      • defaultAssessmentReportsDestination (dict) --

        The default storage destination for assessment reports.

        • destinationType (string) --

          The destination type, such as Amazon S3.

        • destination (string) --

          The destination of the assessment report.

      • defaultProcessOwners (list) --

        The designated default audit owners.

        • (dict) --

          The wrapper that contains the Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN).

          • roleType (string) --

            The type of customer persona.

            Note

            In CreateAssessment , roleType can only be PROCESS_OWNER .

            In UpdateSettings , roleType can only be PROCESS_OWNER .

            In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

          • roleArn (string) --

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

      • kmsKey (string) --

        The KMS key details.

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_assessment_frameworks(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_assessment_frameworks(
    frameworkType='Standard'|'Custom',
    nextToken='string',
    maxResults=123
)
Parameters
  • frameworkType (string) --

    [REQUIRED]

    The type of framework, such as standard or custom.

  • nextToken (string) -- The pagination token used to fetch the next set of results.
  • maxResults (integer) -- Represents the maximum number of results per page, or per API request call.
Return type

dict

Returns

Response Syntax

{
    'frameworkMetadataList': [
        {
            'arn': 'string',
            'id': 'string',
            'type': 'Standard'|'Custom',
            'name': 'string',
            'description': 'string',
            'logo': 'string',
            'complianceType': 'string',
            'controlsCount': 123,
            'controlSetsCount': 123,
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • frameworkMetadataList (list) --

      The list of metadata objects for the specified framework.

      • (dict) --

        The metadata associated with a standard or custom framework.

        • arn (string) --

          The Amazon Resource Name (ARN) of the framework.

        • id (string) --

          The unique identified for the specified framework.

        • type (string) --

          The framework type, such as standard or custom.

        • name (string) --

          The name of the specified framework.

        • description (string) --

          The description of the specified framework.

        • logo (string) --

          The logo associated with the framework.

        • complianceType (string) --

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

        • controlsCount (integer) --

          The number of controls associated with the specified framework.

        • controlSetsCount (integer) --

          The number of control sets associated with the specified framework.

        • createdAt (datetime) --

          Specifies when the framework was created.

        • lastUpdatedAt (datetime) --

          Specifies when the framework was most recently updated.

    • nextToken (string) --

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

Exceptions

list_assessment_reports(**kwargs)

Returns a list of assessment reports created in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.list_assessment_reports(
    nextToken='string',
    maxResults=123
)
Parameters
  • nextToken (string) -- The pagination token used to fetch the next set of results.
  • maxResults (integer) -- Represents the maximum number of results per page, or per API request call.
Return type

dict

Returns

Response Syntax

{
    'assessmentReports': [
        {
            'id': 'string',
            'name': 'string',
            'description': 'string',
            'assessmentId': 'string',
            'assessmentName': 'string',
            'author': 'string',
            'status': 'COMPLETE'|'IN_PROGRESS'|'FAILED',
            'creationTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • assessmentReports (list) --

      The list of assessment reports returned by the ListAssessmentReports API.

      • (dict) --

        The metadata objects associated with the specified assessment report.

        • id (string) --

          The unique identifier for the assessment report.

        • name (string) --

          The name of the assessment report.

        • description (string) --

          The description of the specified assessment report.

        • assessmentId (string) --

          The unique identifier for the associated assessment.

        • assessmentName (string) --

          The name of the associated assessment.

        • author (string) --

          The name of the user who created the assessment report.

        • status (string) --

          The current status of the assessment report.

        • creationTime (datetime) --

          Specifies when the assessment report was created.

    • nextToken (string) --

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

Exceptions

list_assessments(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_assessments(
    nextToken='string',
    maxResults=123
)
Parameters
  • nextToken (string) -- The pagination token used to fetch the next set of results.
  • maxResults (integer) -- Represents the maximum number of results per page, or per API request call.
Return type

dict

Returns

Response Syntax

{
    'assessmentMetadata': [
        {
            'name': 'string',
            'id': 'string',
            'complianceType': 'string',
            'status': 'ACTIVE'|'INACTIVE',
            'roles': [
                {
                    'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                    'roleArn': 'string'
                },
            ],
            'delegations': [
                {
                    'id': 'string',
                    'assessmentName': 'string',
                    'assessmentId': 'string',
                    'status': 'IN_PROGRESS'|'UNDER_REVIEW'|'COMPLETE',
                    'roleArn': 'string',
                    'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                    'creationTime': datetime(2015, 1, 1),
                    'lastUpdated': datetime(2015, 1, 1),
                    'controlSetId': 'string',
                    'comment': 'string',
                    'createdBy': 'string'
                },
            ],
            'creationTime': datetime(2015, 1, 1),
            'lastUpdated': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • assessmentMetadata (list) --

      The metadata associated with the assessment.

      • (dict) --

        A metadata object associated with an assessment in Audit Manager.

        • name (string) --

          The name of the assessment.

        • id (string) --

          The unique identifier for the assessment.

        • complianceType (string) --

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

        • status (string) --

          The current status of the assessment.

        • roles (list) --

          The roles associated with the assessment.

          • (dict) --

            The wrapper that contains the Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN).

            • roleType (string) --

              The type of customer persona.

              Note

              In CreateAssessment , roleType can only be PROCESS_OWNER .

              In UpdateSettings , roleType can only be PROCESS_OWNER .

              In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

            • roleArn (string) --

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

        • delegations (list) --

          The delegations associated with the assessment.

          • (dict) --

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

            • id (string) --

              The unique identifier for the delegation.

            • assessmentName (string) --

              The name of the associated assessment.

            • assessmentId (string) --

              The identifier for the associated assessment.

            • status (string) --

              The status of the delegation.

            • roleArn (string) --

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

            • roleType (string) --

              The type of customer persona.

              Note

              In CreateAssessment , roleType can only be PROCESS_OWNER .

              In UpdateSettings , roleType can only be PROCESS_OWNER .

              In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

            • creationTime (datetime) --

              Specifies when the delegation was created.

            • lastUpdated (datetime) --

              Specifies when the delegation was last updated.

            • controlSetId (string) --

              The identifier for the associated control set.

            • comment (string) --

              The comment related to the delegation.

            • createdBy (string) --

              The IAM user or role that created the delegation.

        • creationTime (datetime) --

          Specifies when the assessment was created.

        • lastUpdated (datetime) --

          The time of the most recent update.

    • nextToken (string) --

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

Exceptions

list_controls(**kwargs)

Returns a list of controls from Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.list_controls(
    controlType='Standard'|'Custom',
    nextToken='string',
    maxResults=123
)
Parameters
  • controlType (string) --

    [REQUIRED]

    The type of control, such as standard or custom.

  • nextToken (string) -- The pagination token used to fetch the next set of results.
  • maxResults (integer) -- Represents the maximum number of results per page, or per API request call.
Return type

dict

Returns

Response Syntax

{
    'controlMetadataList': [
        {
            'arn': 'string',
            'id': 'string',
            'name': 'string',
            'controlSources': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • controlMetadataList (list) --

      The list of control metadata objects returned by the ListControls API.

      • (dict) --

        The metadata associated with the specified standard or custom control.

        • arn (string) --

          The Amazon Resource Name (ARN) of the specified control.

        • id (string) --

          The unique identifier for the specified control.

        • name (string) --

          The name of the specified control.

        • controlSources (string) --

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

        • createdAt (datetime) --

          Specifies when the control was created.

        • lastUpdatedAt (datetime) --

          Specifies when the control was most recently updated.

    • nextToken (string) --

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

Exceptions

list_keywords_for_data_source(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_keywords_for_data_source(
    source='AWS_Cloudtrail'|'AWS_Config'|'AWS_Security_Hub'|'AWS_API_Call'|'MANUAL',
    nextToken='string',
    maxResults=123
)
Parameters
  • source (string) --

    [REQUIRED]

    The control mapping data source to which the keywords apply.

  • nextToken (string) -- The pagination token used to fetch the next set of results.
  • maxResults (integer) -- Represents the maximum number of results per page, or per API request call.
Return type

dict

Returns

Response Syntax

{
    'keywords': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • keywords (list) --

      The list of keywords for the specified event mapping source.

      • (string) --
    • nextToken (string) --

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

Exceptions

list_notifications(**kwargs)

Returns a list of all Audit Manager notifications.

See also: AWS API Documentation

Request Syntax

response = client.list_notifications(
    nextToken='string',
    maxResults=123
)
Parameters
  • nextToken (string) -- The pagination token used to fetch the next set of results.
  • maxResults (integer) -- Represents the maximum number of results per page, or per API request call.
Return type

dict

Returns

Response Syntax

{
    'notifications': [
        {
            'id': 'string',
            'assessmentId': 'string',
            'assessmentName': 'string',
            'controlSetId': 'string',
            'controlSetName': 'string',
            'description': 'string',
            'eventTime': datetime(2015, 1, 1),
            'source': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • notifications (list) --

      The returned list of notifications.

      • (dict) --

        The notification used to inform a user of an update in Audit Manager. For example, this includes the notification that is sent when a control set is delegated for review.

        • id (string) --

          The unique identifier for the notification.

        • assessmentId (string) --

          The identifier for the specified assessment.

        • assessmentName (string) --

          The name of the related assessment.

        • controlSetId (string) --

          The identifier for the specified control set.

        • controlSetName (string) --

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

        • description (string) --

          The description of the notification.

        • eventTime (datetime) --

          The time when the notification was sent.

        • source (string) --

          The sender of the notification.

    • nextToken (string) --

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

Exceptions

list_tags_for_resource(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    resourceArn='string'
)
Parameters
resourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the specified resource.

Return type
dict
Returns
Response Syntax
{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • tags (dict) --

      The list of tags returned by the ListTagsForResource API.

      • (string) --
        • (string) --

Exceptions

register_account(**kwargs)

Enables Audit Manager for the specified account.

See also: AWS API Documentation

Request Syntax

response = client.register_account(
    kmsKey='string',
    delegatedAdminAccount='string'
)
Parameters
  • kmsKey (string) -- The KMS key details.
  • delegatedAdminAccount (string) -- The delegated administrator account for Audit Manager.
Return type

dict

Returns

Response Syntax

{
    'status': 'ACTIVE'|'INACTIVE'|'PENDING_ACTIVATION'
}

Response Structure

  • (dict) --

    • status (string) --

      The status of the account registration request.

Exceptions

register_organization_admin_account(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.register_organization_admin_account(
    adminAccountId='string'
)
Parameters
adminAccountId (string) --

[REQUIRED]

The identifier for the specified delegated administrator account.

Return type
dict
Returns
Response Syntax
{
    'adminAccountId': 'string',
    'organizationId': 'string'
}

Response Structure

  • (dict) --
    • adminAccountId (string) --

      The identifier for the specified delegated administrator account.

    • organizationId (string) --

      The identifier for the specified organization.

Exceptions

tag_resource(**kwargs)

Tags the specified resource in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the specified resource.

  • tags (dict) --

    [REQUIRED]

    The tags to be associated with the resource.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes a tag from a resource in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the specified resource.

  • tagKeys (list) --

    [REQUIRED]

    The name or key of the tag.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_assessment(**kwargs)

Edits an Audit Manager assessment.

See also: AWS API Documentation

Request Syntax

response = client.update_assessment(
    assessmentId='string',
    assessmentName='string',
    assessmentDescription='string',
    scope={
        'awsAccounts': [
            {
                'id': 'string',
                'emailAddress': 'string',
                'name': 'string'
            },
        ],
        'awsServices': [
            {
                'serviceName': 'string'
            },
        ]
    },
    assessmentReportsDestination={
        'destinationType': 'S3',
        'destination': 'string'
    },
    roles=[
        {
            'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
            'roleArn': 'string'
        },
    ]
)
Parameters
  • assessmentId (string) --

    [REQUIRED]

    The identifier for the specified assessment.

  • assessmentName (string) -- The name of the specified assessment to be updated.
  • assessmentDescription (string) -- The description of the specified assessment.
  • scope (dict) --

    [REQUIRED]

    The scope of the specified assessment.

    • awsAccounts (list) --

      The accounts included in the scope of the assessment.

      • (dict) --

        The wrapper of account details, such as account ID, email address, and so on.

        • id (string) --

          The identifier for the specified account.

        • emailAddress (string) --

          The email address associated with the specified account.

        • name (string) --

          The name of the specified account.

    • awsServices (list) --

      The Amazon Web Services services included in the scope of the assessment.

      • (dict) --

        An Amazon Web Service such as Amazon S3, CloudTrail, and so on.

        • serviceName (string) --

          The name of the Amazon Web Service.

  • assessmentReportsDestination (dict) --

    The assessment report storage destination for the specified assessment that is being updated.

    • destinationType (string) --

      The destination type, such as Amazon S3.

    • destination (string) --

      The destination of the assessment report.

  • roles (list) --

    The list of roles for the specified assessment.

    • (dict) --

      The wrapper that contains the Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN).

      • roleType (string) --

        The type of customer persona.

        Note

        In CreateAssessment , roleType can only be PROCESS_OWNER .

        In UpdateSettings , roleType can only be PROCESS_OWNER .

        In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

      • roleArn (string) --

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

Return type

dict

Returns

Response Syntax

{
    'assessment': {
        'arn': 'string',
        'awsAccount': {
            'id': 'string',
            'emailAddress': 'string',
            'name': 'string'
        },
        'metadata': {
            'name': 'string',
            'id': 'string',
            'description': 'string',
            'complianceType': 'string',
            'status': 'ACTIVE'|'INACTIVE',
            'assessmentReportsDestination': {
                'destinationType': 'S3',
                'destination': 'string'
            },
            'scope': {
                'awsAccounts': [
                    {
                        'id': 'string',
                        'emailAddress': 'string',
                        'name': 'string'
                    },
                ],
                'awsServices': [
                    {
                        'serviceName': 'string'
                    },
                ]
            },
            'roles': [
                {
                    'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                    'roleArn': 'string'
                },
            ],
            'delegations': [
                {
                    'id': 'string',
                    'assessmentName': 'string',
                    'assessmentId': 'string',
                    'status': 'IN_PROGRESS'|'UNDER_REVIEW'|'COMPLETE',
                    'roleArn': 'string',
                    'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                    'creationTime': datetime(2015, 1, 1),
                    'lastUpdated': datetime(2015, 1, 1),
                    'controlSetId': 'string',
                    'comment': 'string',
                    'createdBy': 'string'
                },
            ],
            'creationTime': datetime(2015, 1, 1),
            'lastUpdated': datetime(2015, 1, 1)
        },
        'framework': {
            'id': 'string',
            'arn': 'string',
            'metadata': {
                'name': 'string',
                'description': 'string',
                'logo': 'string',
                'complianceType': 'string'
            },
            'controlSets': [
                {
                    'id': 'string',
                    'description': 'string',
                    'status': 'ACTIVE'|'UNDER_REVIEW'|'REVIEWED',
                    'roles': [
                        {
                            'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                            'roleArn': 'string'
                        },
                    ],
                    'controls': [
                        {
                            'id': 'string',
                            'name': 'string',
                            'description': 'string',
                            'status': 'UNDER_REVIEW'|'REVIEWED'|'INACTIVE',
                            'response': 'MANUAL'|'AUTOMATE'|'DEFER'|'IGNORE',
                            'comments': [
                                {
                                    'authorName': 'string',
                                    'commentBody': 'string',
                                    'postedDate': datetime(2015, 1, 1)
                                },
                            ],
                            'evidenceSources': [
                                'string',
                            ],
                            'evidenceCount': 123,
                            'assessmentReportEvidenceCount': 123
                        },
                    ],
                    'delegations': [
                        {
                            'id': 'string',
                            'assessmentName': 'string',
                            'assessmentId': 'string',
                            'status': 'IN_PROGRESS'|'UNDER_REVIEW'|'COMPLETE',
                            'roleArn': 'string',
                            'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                            'creationTime': datetime(2015, 1, 1),
                            'lastUpdated': datetime(2015, 1, 1),
                            'controlSetId': 'string',
                            'comment': 'string',
                            'createdBy': 'string'
                        },
                    ],
                    'systemEvidenceCount': 123,
                    'manualEvidenceCount': 123
                },
            ]
        },
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • assessment (dict) --

      The response object (name of the updated assessment) for the UpdateAssessmentRequest API.

      • arn (string) --

        The Amazon Resource Name (ARN) of the assessment.

      • awsAccount (dict) --

        The account associated with the assessment.

        • id (string) --

          The identifier for the specified account.

        • emailAddress (string) --

          The email address associated with the specified account.

        • name (string) --

          The name of the specified account.

      • metadata (dict) --

        The metadata for the specified assessment.

        • name (string) --

          The name of the assessment.

        • id (string) --

          The unique identifier for the assessment.

        • description (string) --

          The description of the assessment.

        • complianceType (string) --

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

        • status (string) --

          The overall status of the assessment.

        • assessmentReportsDestination (dict) --

          The destination in which evidence reports are stored for the specified assessment.

          • destinationType (string) --

            The destination type, such as Amazon S3.

          • destination (string) --

            The destination of the assessment report.

        • scope (dict) --

          The wrapper of accounts and services in scope for the assessment.

          • awsAccounts (list) --

            The accounts included in the scope of the assessment.

            • (dict) --

              The wrapper of account details, such as account ID, email address, and so on.

              • id (string) --

                The identifier for the specified account.

              • emailAddress (string) --

                The email address associated with the specified account.

              • name (string) --

                The name of the specified account.

          • awsServices (list) --

            The Amazon Web Services services included in the scope of the assessment.

            • (dict) --

              An Amazon Web Service such as Amazon S3, CloudTrail, and so on.

              • serviceName (string) --

                The name of the Amazon Web Service.

        • roles (list) --

          The roles associated with the assessment.

          • (dict) --

            The wrapper that contains the Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN).

            • roleType (string) --

              The type of customer persona.

              Note

              In CreateAssessment , roleType can only be PROCESS_OWNER .

              In UpdateSettings , roleType can only be PROCESS_OWNER .

              In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

            • roleArn (string) --

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

        • delegations (list) --

          The delegations associated with the assessment.

          • (dict) --

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

            • id (string) --

              The unique identifier for the delegation.

            • assessmentName (string) --

              The name of the associated assessment.

            • assessmentId (string) --

              The identifier for the associated assessment.

            • status (string) --

              The status of the delegation.

            • roleArn (string) --

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

            • roleType (string) --

              The type of customer persona.

              Note

              In CreateAssessment , roleType can only be PROCESS_OWNER .

              In UpdateSettings , roleType can only be PROCESS_OWNER .

              In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

            • creationTime (datetime) --

              Specifies when the delegation was created.

            • lastUpdated (datetime) --

              Specifies when the delegation was last updated.

            • controlSetId (string) --

              The identifier for the associated control set.

            • comment (string) --

              The comment related to the delegation.

            • createdBy (string) --

              The IAM user or role that created the delegation.

        • creationTime (datetime) --

          Specifies when the assessment was created.

        • lastUpdated (datetime) --

          The time of the most recent update.

      • framework (dict) --

        The framework from which the assessment was created.

        • id (string) --

          The unique identifier for the framework.

        • arn (string) --

          The Amazon Resource Name (ARN) of the specified framework.

        • metadata (dict) --

          The metadata of a framework, such as the name, ID, description, and so on.

          • name (string) --

            The name of the framework.

          • description (string) --

            The description of the framework.

          • logo (string) --

            The logo associated with the framework.

          • complianceType (string) --

            The compliance standard associated with the framework, such as PCI-DSS or HIPAA.

        • controlSets (list) --

          The control sets associated with the framework.

          • (dict) --

            Represents a set of controls in an Audit Manager assessment.

            • id (string) --

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

            • description (string) --

              The description for the control set.

            • status (string) --

              Specifies the current status of the control set.

            • roles (list) --

              The roles associated with the control set.

              • (dict) --

                The wrapper that contains the Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN).

                • roleType (string) --

                  The type of customer persona.

                  Note

                  In CreateAssessment , roleType can only be PROCESS_OWNER .

                  In UpdateSettings , roleType can only be PROCESS_OWNER .

                  In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

                • roleArn (string) --

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

            • controls (list) --

              The list of controls contained with the control set.

              • (dict) --

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

                • id (string) --

                  The identifier for the specified control.

                • name (string) --

                  The name of the specified control.

                • description (string) --

                  The description of the specified control.

                • status (string) --

                  The status of the specified control.

                • response (string) --

                  The response of the specified control.

                • comments (list) --

                  The list of comments attached to the specified control.

                  • (dict) --

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

                    • authorName (string) --

                      The name of the user who authored the comment.

                    • commentBody (string) --

                      The body text of a control comment.

                    • postedDate (datetime) --

                      The time when the comment was posted.

                • evidenceSources (list) --

                  The list of data sources for the specified evidence.

                  • (string) --
                • evidenceCount (integer) --

                  The amount of evidence generated for the control.

                • assessmentReportEvidenceCount (integer) --

                  The amount of evidence in the assessment report.

            • delegations (list) --

              The delegations associated with the control set.

              • (dict) --

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

                • id (string) --

                  The unique identifier for the delegation.

                • assessmentName (string) --

                  The name of the associated assessment.

                • assessmentId (string) --

                  The identifier for the associated assessment.

                • status (string) --

                  The status of the delegation.

                • roleArn (string) --

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

                • roleType (string) --

                  The type of customer persona.

                  Note

                  In CreateAssessment , roleType can only be PROCESS_OWNER .

                  In UpdateSettings , roleType can only be PROCESS_OWNER .

                  In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

                • creationTime (datetime) --

                  Specifies when the delegation was created.

                • lastUpdated (datetime) --

                  Specifies when the delegation was last updated.

                • controlSetId (string) --

                  The identifier for the associated control set.

                • comment (string) --

                  The comment related to the delegation.

                • createdBy (string) --

                  The IAM user or role that created the delegation.

            • systemEvidenceCount (integer) --

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

            • manualEvidenceCount (integer) --

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

      • tags (dict) --

        The tags associated with the assessment.

        • (string) --
          • (string) --

Exceptions

update_assessment_control(**kwargs)

Updates a control within an assessment in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.update_assessment_control(
    assessmentId='string',
    controlSetId='string',
    controlId='string',
    controlStatus='UNDER_REVIEW'|'REVIEWED'|'INACTIVE',
    commentBody='string'
)
Parameters
  • assessmentId (string) --

    [REQUIRED]

    The identifier for the specified assessment.

  • controlSetId (string) --

    [REQUIRED]

    The identifier for the specified control set.

  • controlId (string) --

    [REQUIRED]

    The identifier for the specified control.

  • controlStatus (string) -- The status of the specified control.
  • commentBody (string) -- The comment body text for the specified control.
Return type

dict

Returns

Response Syntax

{
    'control': {
        'id': 'string',
        'name': 'string',
        'description': 'string',
        'status': 'UNDER_REVIEW'|'REVIEWED'|'INACTIVE',
        'response': 'MANUAL'|'AUTOMATE'|'DEFER'|'IGNORE',
        'comments': [
            {
                'authorName': 'string',
                'commentBody': 'string',
                'postedDate': datetime(2015, 1, 1)
            },
        ],
        'evidenceSources': [
            'string',
        ],
        'evidenceCount': 123,
        'assessmentReportEvidenceCount': 123
    }
}

Response Structure

  • (dict) --

    • control (dict) --

      The name of the updated control set returned by the UpdateAssessmentControl API.

      • id (string) --

        The identifier for the specified control.

      • name (string) --

        The name of the specified control.

      • description (string) --

        The description of the specified control.

      • status (string) --

        The status of the specified control.

      • response (string) --

        The response of the specified control.

      • comments (list) --

        The list of comments attached to the specified control.

        • (dict) --

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

          • authorName (string) --

            The name of the user who authored the comment.

          • commentBody (string) --

            The body text of a control comment.

          • postedDate (datetime) --

            The time when the comment was posted.

      • evidenceSources (list) --

        The list of data sources for the specified evidence.

        • (string) --
      • evidenceCount (integer) --

        The amount of evidence generated for the control.

      • assessmentReportEvidenceCount (integer) --

        The amount of evidence in the assessment report.

Exceptions

update_assessment_control_set_status(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.update_assessment_control_set_status(
    assessmentId='string',
    controlSetId='string',
    status='ACTIVE'|'UNDER_REVIEW'|'REVIEWED',
    comment='string'
)
Parameters
  • assessmentId (string) --

    [REQUIRED]

    The identifier for the specified assessment.

  • controlSetId (string) --

    [REQUIRED]

    The identifier for the specified control set.

  • status (string) --

    [REQUIRED]

    The status of the control set that is being updated.

  • comment (string) --

    [REQUIRED]

    The comment related to the status update.

Return type

dict

Returns

Response Syntax

{
    'controlSet': {
        'id': 'string',
        'description': 'string',
        'status': 'ACTIVE'|'UNDER_REVIEW'|'REVIEWED',
        'roles': [
            {
                'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                'roleArn': 'string'
            },
        ],
        'controls': [
            {
                'id': 'string',
                'name': 'string',
                'description': 'string',
                'status': 'UNDER_REVIEW'|'REVIEWED'|'INACTIVE',
                'response': 'MANUAL'|'AUTOMATE'|'DEFER'|'IGNORE',
                'comments': [
                    {
                        'authorName': 'string',
                        'commentBody': 'string',
                        'postedDate': datetime(2015, 1, 1)
                    },
                ],
                'evidenceSources': [
                    'string',
                ],
                'evidenceCount': 123,
                'assessmentReportEvidenceCount': 123
            },
        ],
        'delegations': [
            {
                'id': 'string',
                'assessmentName': 'string',
                'assessmentId': 'string',
                'status': 'IN_PROGRESS'|'UNDER_REVIEW'|'COMPLETE',
                'roleArn': 'string',
                'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                'creationTime': datetime(2015, 1, 1),
                'lastUpdated': datetime(2015, 1, 1),
                'controlSetId': 'string',
                'comment': 'string',
                'createdBy': 'string'
            },
        ],
        'systemEvidenceCount': 123,
        'manualEvidenceCount': 123
    }
}

Response Structure

  • (dict) --

    • controlSet (dict) --

      The name of the updated control set returned by the UpdateAssessmentControlSetStatus API.

      • id (string) --

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

      • description (string) --

        The description for the control set.

      • status (string) --

        Specifies the current status of the control set.

      • roles (list) --

        The roles associated with the control set.

        • (dict) --

          The wrapper that contains the Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN).

          • roleType (string) --

            The type of customer persona.

            Note

            In CreateAssessment , roleType can only be PROCESS_OWNER .

            In UpdateSettings , roleType can only be PROCESS_OWNER .

            In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

          • roleArn (string) --

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

      • controls (list) --

        The list of controls contained with the control set.

        • (dict) --

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

          • id (string) --

            The identifier for the specified control.

          • name (string) --

            The name of the specified control.

          • description (string) --

            The description of the specified control.

          • status (string) --

            The status of the specified control.

          • response (string) --

            The response of the specified control.

          • comments (list) --

            The list of comments attached to the specified control.

            • (dict) --

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

              • authorName (string) --

                The name of the user who authored the comment.

              • commentBody (string) --

                The body text of a control comment.

              • postedDate (datetime) --

                The time when the comment was posted.

          • evidenceSources (list) --

            The list of data sources for the specified evidence.

            • (string) --
          • evidenceCount (integer) --

            The amount of evidence generated for the control.

          • assessmentReportEvidenceCount (integer) --

            The amount of evidence in the assessment report.

      • delegations (list) --

        The delegations associated with the control set.

        • (dict) --

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

          • id (string) --

            The unique identifier for the delegation.

          • assessmentName (string) --

            The name of the associated assessment.

          • assessmentId (string) --

            The identifier for the associated assessment.

          • status (string) --

            The status of the delegation.

          • roleArn (string) --

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

          • roleType (string) --

            The type of customer persona.

            Note

            In CreateAssessment , roleType can only be PROCESS_OWNER .

            In UpdateSettings , roleType can only be PROCESS_OWNER .

            In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

          • creationTime (datetime) --

            Specifies when the delegation was created.

          • lastUpdated (datetime) --

            Specifies when the delegation was last updated.

          • controlSetId (string) --

            The identifier for the associated control set.

          • comment (string) --

            The comment related to the delegation.

          • createdBy (string) --

            The IAM user or role that created the delegation.

      • systemEvidenceCount (integer) --

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

      • manualEvidenceCount (integer) --

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

Exceptions

update_assessment_framework(**kwargs)

Updates a custom framework in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.update_assessment_framework(
    frameworkId='string',
    name='string',
    description='string',
    complianceType='string',
    controlSets=[
        {
            'id': 'string',
            'name': 'string',
            'controls': [
                {
                    'id': 'string'
                },
            ]
        },
    ]
)
Parameters
  • frameworkId (string) --

    [REQUIRED]

    The identifier for the specified framework.

  • name (string) --

    [REQUIRED]

    The name of the framework to be updated.

  • description (string) -- The description of the framework that is to be updated.
  • complianceType (string) -- The compliance type that the new custom framework supports, such as CIS or HIPAA.
  • controlSets (list) --

    [REQUIRED]

    The control sets associated with the framework.

    • (dict) --

      A controlSet entity that represents a collection of controls in Audit Manager. This does not contain the control set ID.

      • id (string) --

        The unique identifier for the control set.

      • name (string) -- [REQUIRED]

        The name of the control set.

      • controls (list) --

        The list of controls contained within the control set.

        • (dict) --

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

          • id (string) --

            The unique identifier of the control.

Return type

dict

Returns

Response Syntax

{
    'framework': {
        'arn': 'string',
        'id': 'string',
        'name': 'string',
        'type': 'Standard'|'Custom',
        'complianceType': 'string',
        'description': 'string',
        'logo': 'string',
        'controlSources': 'string',
        'controlSets': [
            {
                'id': 'string',
                'name': 'string',
                'controls': [
                    {
                        'arn': 'string',
                        'id': 'string',
                        'type': 'Standard'|'Custom',
                        'name': 'string',
                        'description': 'string',
                        'testingInformation': 'string',
                        'actionPlanTitle': 'string',
                        'actionPlanInstructions': 'string',
                        'controlSources': 'string',
                        'controlMappingSources': [
                            {
                                'sourceId': 'string',
                                'sourceName': 'string',
                                'sourceDescription': 'string',
                                'sourceSetUpOption': 'System_Controls_Mapping'|'Procedural_Controls_Mapping',
                                'sourceType': 'AWS_Cloudtrail'|'AWS_Config'|'AWS_Security_Hub'|'AWS_API_Call'|'MANUAL',
                                'sourceKeyword': {
                                    'keywordInputType': 'SELECT_FROM_LIST',
                                    'keywordValue': 'string'
                                },
                                'sourceFrequency': 'DAILY'|'WEEKLY'|'MONTHLY',
                                'troubleshootingText': 'string'
                            },
                        ],
                        'createdAt': datetime(2015, 1, 1),
                        'lastUpdatedAt': datetime(2015, 1, 1),
                        'createdBy': 'string',
                        'lastUpdatedBy': 'string',
                        'tags': {
                            'string': 'string'
                        }
                    },
                ]
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'lastUpdatedAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'lastUpdatedBy': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • framework (dict) --

      The name of the specified framework.

      • arn (string) --

        The Amazon Resource Name (ARN) of the specified framework.

      • id (string) --

        The unique identifier for the specified framework.

      • name (string) --

        The name of the specified framework.

      • type (string) --

        The framework type, such as custom or standard.

      • complianceType (string) --

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

      • description (string) --

        The description of the specified framework.

      • logo (string) --

        The logo associated with the framework.

      • controlSources (string) --

        The sources from which Audit Manager collects evidence for the control.

      • controlSets (list) --

        The control sets associated with the framework.

        • (dict) --

          A set of controls in Audit Manager.

          • id (string) --

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

          • name (string) --

            The name of the control set.

          • controls (list) --

            The list of controls within the control set.

            • (dict) --

              A control in Audit Manager.

              • arn (string) --

                The Amazon Resource Name (ARN) of the specified control.

              • id (string) --

                The unique identifier for the control.

              • type (string) --

                The type of control, such as custom or standard.

              • name (string) --

                The name of the specified control.

              • description (string) --

                The description of the specified control.

              • testingInformation (string) --

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

              • actionPlanTitle (string) --

                The title of the action plan for remediating the control.

              • actionPlanInstructions (string) --

                The recommended actions to carry out if the control is not fulfilled.

              • controlSources (string) --

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

              • controlMappingSources (list) --

                The data mapping sources for the specified control.

                • (dict) --

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

                  • sourceId (string) --

                    The unique identifier for the specified source.

                  • sourceName (string) --

                    The name of the specified source.

                  • sourceDescription (string) --

                    The description of the specified source.

                  • sourceSetUpOption (string) --

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

                  • sourceType (string) --

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

                  • sourceKeyword (dict) --

                    The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names.

                    • keywordInputType (string) --

                      The method of input for the specified keyword.

                    • keywordValue (string) --

                      The value of the keyword used to search CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names when mapping a control data source.

                  • sourceFrequency (string) --

                    The frequency of evidence collection for the specified control mapping source.

                  • troubleshootingText (string) --

                    The instructions for troubleshooting the specified control.

              • createdAt (datetime) --

                Specifies when the control was created.

              • lastUpdatedAt (datetime) --

                Specifies when the control was most recently updated.

              • createdBy (string) --

                The IAM user or role that created the control.

              • lastUpdatedBy (string) --

                The IAM user or role that most recently updated the control.

              • tags (dict) --

                The tags associated with the control.

                • (string) --
                  • (string) --
      • createdAt (datetime) --

        Specifies when the framework was created.

      • lastUpdatedAt (datetime) --

        Specifies when the framework was most recently updated.

      • createdBy (string) --

        The IAM user or role that created the framework.

      • lastUpdatedBy (string) --

        The IAM user or role that most recently updated the framework.

      • tags (dict) --

        The tags associated with the framework.

        • (string) --
          • (string) --

Exceptions

update_assessment_status(**kwargs)

Updates the status of an assessment in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.update_assessment_status(
    assessmentId='string',
    status='ACTIVE'|'INACTIVE'
)
Parameters
  • assessmentId (string) --

    [REQUIRED]

    The identifier for the specified assessment.

  • status (string) --

    [REQUIRED]

    The current status of the specified assessment.

Return type

dict

Returns

Response Syntax

{
    'assessment': {
        'arn': 'string',
        'awsAccount': {
            'id': 'string',
            'emailAddress': 'string',
            'name': 'string'
        },
        'metadata': {
            'name': 'string',
            'id': 'string',
            'description': 'string',
            'complianceType': 'string',
            'status': 'ACTIVE'|'INACTIVE',
            'assessmentReportsDestination': {
                'destinationType': 'S3',
                'destination': 'string'
            },
            'scope': {
                'awsAccounts': [
                    {
                        'id': 'string',
                        'emailAddress': 'string',
                        'name': 'string'
                    },
                ],
                'awsServices': [
                    {
                        'serviceName': 'string'
                    },
                ]
            },
            'roles': [
                {
                    'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                    'roleArn': 'string'
                },
            ],
            'delegations': [
                {
                    'id': 'string',
                    'assessmentName': 'string',
                    'assessmentId': 'string',
                    'status': 'IN_PROGRESS'|'UNDER_REVIEW'|'COMPLETE',
                    'roleArn': 'string',
                    'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                    'creationTime': datetime(2015, 1, 1),
                    'lastUpdated': datetime(2015, 1, 1),
                    'controlSetId': 'string',
                    'comment': 'string',
                    'createdBy': 'string'
                },
            ],
            'creationTime': datetime(2015, 1, 1),
            'lastUpdated': datetime(2015, 1, 1)
        },
        'framework': {
            'id': 'string',
            'arn': 'string',
            'metadata': {
                'name': 'string',
                'description': 'string',
                'logo': 'string',
                'complianceType': 'string'
            },
            'controlSets': [
                {
                    'id': 'string',
                    'description': 'string',
                    'status': 'ACTIVE'|'UNDER_REVIEW'|'REVIEWED',
                    'roles': [
                        {
                            'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                            'roleArn': 'string'
                        },
                    ],
                    'controls': [
                        {
                            'id': 'string',
                            'name': 'string',
                            'description': 'string',
                            'status': 'UNDER_REVIEW'|'REVIEWED'|'INACTIVE',
                            'response': 'MANUAL'|'AUTOMATE'|'DEFER'|'IGNORE',
                            'comments': [
                                {
                                    'authorName': 'string',
                                    'commentBody': 'string',
                                    'postedDate': datetime(2015, 1, 1)
                                },
                            ],
                            'evidenceSources': [
                                'string',
                            ],
                            'evidenceCount': 123,
                            'assessmentReportEvidenceCount': 123
                        },
                    ],
                    'delegations': [
                        {
                            'id': 'string',
                            'assessmentName': 'string',
                            'assessmentId': 'string',
                            'status': 'IN_PROGRESS'|'UNDER_REVIEW'|'COMPLETE',
                            'roleArn': 'string',
                            'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                            'creationTime': datetime(2015, 1, 1),
                            'lastUpdated': datetime(2015, 1, 1),
                            'controlSetId': 'string',
                            'comment': 'string',
                            'createdBy': 'string'
                        },
                    ],
                    'systemEvidenceCount': 123,
                    'manualEvidenceCount': 123
                },
            ]
        },
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • assessment (dict) --

      The name of the updated assessment returned by the UpdateAssessmentStatus API.

      • arn (string) --

        The Amazon Resource Name (ARN) of the assessment.

      • awsAccount (dict) --

        The account associated with the assessment.

        • id (string) --

          The identifier for the specified account.

        • emailAddress (string) --

          The email address associated with the specified account.

        • name (string) --

          The name of the specified account.

      • metadata (dict) --

        The metadata for the specified assessment.

        • name (string) --

          The name of the assessment.

        • id (string) --

          The unique identifier for the assessment.

        • description (string) --

          The description of the assessment.

        • complianceType (string) --

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

        • status (string) --

          The overall status of the assessment.

        • assessmentReportsDestination (dict) --

          The destination in which evidence reports are stored for the specified assessment.

          • destinationType (string) --

            The destination type, such as Amazon S3.

          • destination (string) --

            The destination of the assessment report.

        • scope (dict) --

          The wrapper of accounts and services in scope for the assessment.

          • awsAccounts (list) --

            The accounts included in the scope of the assessment.

            • (dict) --

              The wrapper of account details, such as account ID, email address, and so on.

              • id (string) --

                The identifier for the specified account.

              • emailAddress (string) --

                The email address associated with the specified account.

              • name (string) --

                The name of the specified account.

          • awsServices (list) --

            The Amazon Web Services services included in the scope of the assessment.

            • (dict) --

              An Amazon Web Service such as Amazon S3, CloudTrail, and so on.

              • serviceName (string) --

                The name of the Amazon Web Service.

        • roles (list) --

          The roles associated with the assessment.

          • (dict) --

            The wrapper that contains the Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN).

            • roleType (string) --

              The type of customer persona.

              Note

              In CreateAssessment , roleType can only be PROCESS_OWNER .

              In UpdateSettings , roleType can only be PROCESS_OWNER .

              In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

            • roleArn (string) --

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

        • delegations (list) --

          The delegations associated with the assessment.

          • (dict) --

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

            • id (string) --

              The unique identifier for the delegation.

            • assessmentName (string) --

              The name of the associated assessment.

            • assessmentId (string) --

              The identifier for the associated assessment.

            • status (string) --

              The status of the delegation.

            • roleArn (string) --

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

            • roleType (string) --

              The type of customer persona.

              Note

              In CreateAssessment , roleType can only be PROCESS_OWNER .

              In UpdateSettings , roleType can only be PROCESS_OWNER .

              In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

            • creationTime (datetime) --

              Specifies when the delegation was created.

            • lastUpdated (datetime) --

              Specifies when the delegation was last updated.

            • controlSetId (string) --

              The identifier for the associated control set.

            • comment (string) --

              The comment related to the delegation.

            • createdBy (string) --

              The IAM user or role that created the delegation.

        • creationTime (datetime) --

          Specifies when the assessment was created.

        • lastUpdated (datetime) --

          The time of the most recent update.

      • framework (dict) --

        The framework from which the assessment was created.

        • id (string) --

          The unique identifier for the framework.

        • arn (string) --

          The Amazon Resource Name (ARN) of the specified framework.

        • metadata (dict) --

          The metadata of a framework, such as the name, ID, description, and so on.

          • name (string) --

            The name of the framework.

          • description (string) --

            The description of the framework.

          • logo (string) --

            The logo associated with the framework.

          • complianceType (string) --

            The compliance standard associated with the framework, such as PCI-DSS or HIPAA.

        • controlSets (list) --

          The control sets associated with the framework.

          • (dict) --

            Represents a set of controls in an Audit Manager assessment.

            • id (string) --

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

            • description (string) --

              The description for the control set.

            • status (string) --

              Specifies the current status of the control set.

            • roles (list) --

              The roles associated with the control set.

              • (dict) --

                The wrapper that contains the Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN).

                • roleType (string) --

                  The type of customer persona.

                  Note

                  In CreateAssessment , roleType can only be PROCESS_OWNER .

                  In UpdateSettings , roleType can only be PROCESS_OWNER .

                  In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

                • roleArn (string) --

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

            • controls (list) --

              The list of controls contained with the control set.

              • (dict) --

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

                • id (string) --

                  The identifier for the specified control.

                • name (string) --

                  The name of the specified control.

                • description (string) --

                  The description of the specified control.

                • status (string) --

                  The status of the specified control.

                • response (string) --

                  The response of the specified control.

                • comments (list) --

                  The list of comments attached to the specified control.

                  • (dict) --

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

                    • authorName (string) --

                      The name of the user who authored the comment.

                    • commentBody (string) --

                      The body text of a control comment.

                    • postedDate (datetime) --

                      The time when the comment was posted.

                • evidenceSources (list) --

                  The list of data sources for the specified evidence.

                  • (string) --
                • evidenceCount (integer) --

                  The amount of evidence generated for the control.

                • assessmentReportEvidenceCount (integer) --

                  The amount of evidence in the assessment report.

            • delegations (list) --

              The delegations associated with the control set.

              • (dict) --

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

                • id (string) --

                  The unique identifier for the delegation.

                • assessmentName (string) --

                  The name of the associated assessment.

                • assessmentId (string) --

                  The identifier for the associated assessment.

                • status (string) --

                  The status of the delegation.

                • roleArn (string) --

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

                • roleType (string) --

                  The type of customer persona.

                  Note

                  In CreateAssessment , roleType can only be PROCESS_OWNER .

                  In UpdateSettings , roleType can only be PROCESS_OWNER .

                  In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

                • creationTime (datetime) --

                  Specifies when the delegation was created.

                • lastUpdated (datetime) --

                  Specifies when the delegation was last updated.

                • controlSetId (string) --

                  The identifier for the associated control set.

                • comment (string) --

                  The comment related to the delegation.

                • createdBy (string) --

                  The IAM user or role that created the delegation.

            • systemEvidenceCount (integer) --

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

            • manualEvidenceCount (integer) --

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

      • tags (dict) --

        The tags associated with the assessment.

        • (string) --
          • (string) --

Exceptions

update_control(**kwargs)

Updates a custom control in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.update_control(
    controlId='string',
    name='string',
    description='string',
    testingInformation='string',
    actionPlanTitle='string',
    actionPlanInstructions='string',
    controlMappingSources=[
        {
            'sourceId': 'string',
            'sourceName': 'string',
            'sourceDescription': 'string',
            'sourceSetUpOption': 'System_Controls_Mapping'|'Procedural_Controls_Mapping',
            'sourceType': 'AWS_Cloudtrail'|'AWS_Config'|'AWS_Security_Hub'|'AWS_API_Call'|'MANUAL',
            'sourceKeyword': {
                'keywordInputType': 'SELECT_FROM_LIST',
                'keywordValue': 'string'
            },
            'sourceFrequency': 'DAILY'|'WEEKLY'|'MONTHLY',
            'troubleshootingText': 'string'
        },
    ]
)
Parameters
  • controlId (string) --

    [REQUIRED]

    The identifier for the specified control.

  • name (string) --

    [REQUIRED]

    The name of the control to be updated.

  • description (string) -- The optional description of the control.
  • testingInformation (string) -- The steps that to follow to determine if the control has been satisfied.
  • actionPlanTitle (string) -- The title of the action plan for remediating the control.
  • actionPlanInstructions (string) -- The recommended actions to carry out if the control is not fulfilled.
  • controlMappingSources (list) --

    [REQUIRED]

    The data mapping sources for the specified control.

    • (dict) --

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

      • sourceId (string) --

        The unique identifier for the specified source.

      • sourceName (string) --

        The name of the specified source.

      • sourceDescription (string) --

        The description of the specified source.

      • sourceSetUpOption (string) --

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

      • sourceType (string) --

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

      • sourceKeyword (dict) --

        The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names.

        • keywordInputType (string) --

          The method of input for the specified keyword.

        • keywordValue (string) --

          The value of the keyword used to search CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names when mapping a control data source.

      • sourceFrequency (string) --

        The frequency of evidence collection for the specified control mapping source.

      • troubleshootingText (string) --

        The instructions for troubleshooting the specified control.

Return type

dict

Returns

Response Syntax

{
    'control': {
        'arn': 'string',
        'id': 'string',
        'type': 'Standard'|'Custom',
        'name': 'string',
        'description': 'string',
        'testingInformation': 'string',
        'actionPlanTitle': 'string',
        'actionPlanInstructions': 'string',
        'controlSources': 'string',
        'controlMappingSources': [
            {
                'sourceId': 'string',
                'sourceName': 'string',
                'sourceDescription': 'string',
                'sourceSetUpOption': 'System_Controls_Mapping'|'Procedural_Controls_Mapping',
                'sourceType': 'AWS_Cloudtrail'|'AWS_Config'|'AWS_Security_Hub'|'AWS_API_Call'|'MANUAL',
                'sourceKeyword': {
                    'keywordInputType': 'SELECT_FROM_LIST',
                    'keywordValue': 'string'
                },
                'sourceFrequency': 'DAILY'|'WEEKLY'|'MONTHLY',
                'troubleshootingText': 'string'
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'lastUpdatedAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'lastUpdatedBy': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • control (dict) --

      The name of the updated control set returned by the UpdateControl API.

      • arn (string) --

        The Amazon Resource Name (ARN) of the specified control.

      • id (string) --

        The unique identifier for the control.

      • type (string) --

        The type of control, such as custom or standard.

      • name (string) --

        The name of the specified control.

      • description (string) --

        The description of the specified control.

      • testingInformation (string) --

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

      • actionPlanTitle (string) --

        The title of the action plan for remediating the control.

      • actionPlanInstructions (string) --

        The recommended actions to carry out if the control is not fulfilled.

      • controlSources (string) --

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

      • controlMappingSources (list) --

        The data mapping sources for the specified control.

        • (dict) --

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

          • sourceId (string) --

            The unique identifier for the specified source.

          • sourceName (string) --

            The name of the specified source.

          • sourceDescription (string) --

            The description of the specified source.

          • sourceSetUpOption (string) --

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

          • sourceType (string) --

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

          • sourceKeyword (dict) --

            The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names.

            • keywordInputType (string) --

              The method of input for the specified keyword.

            • keywordValue (string) --

              The value of the keyword used to search CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names when mapping a control data source.

          • sourceFrequency (string) --

            The frequency of evidence collection for the specified control mapping source.

          • troubleshootingText (string) --

            The instructions for troubleshooting the specified control.

      • createdAt (datetime) --

        Specifies when the control was created.

      • lastUpdatedAt (datetime) --

        Specifies when the control was most recently updated.

      • createdBy (string) --

        The IAM user or role that created the control.

      • lastUpdatedBy (string) --

        The IAM user or role that most recently updated the control.

      • tags (dict) --

        The tags associated with the control.

        • (string) --
          • (string) --

Exceptions

update_settings(**kwargs)

Updates Audit Manager settings for the current user account.

See also: AWS API Documentation

Request Syntax

response = client.update_settings(
    snsTopic='string',
    defaultAssessmentReportsDestination={
        'destinationType': 'S3',
        'destination': 'string'
    },
    defaultProcessOwners=[
        {
            'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
            'roleArn': 'string'
        },
    ],
    kmsKey='string'
)
Parameters
  • snsTopic (string) -- The Amazon Simple Notification Service (Amazon SNS) topic to which Audit Manager sends notifications.
  • defaultAssessmentReportsDestination (dict) --

    The default storage destination for assessment reports.

    • destinationType (string) --

      The destination type, such as Amazon S3.

    • destination (string) --

      The destination of the assessment report.

  • defaultProcessOwners (list) --

    A list of the default audit owners.

    • (dict) --

      The wrapper that contains the Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN).

      • roleType (string) --

        The type of customer persona.

        Note

        In CreateAssessment , roleType can only be PROCESS_OWNER .

        In UpdateSettings , roleType can only be PROCESS_OWNER .

        In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

      • roleArn (string) --

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

  • kmsKey (string) -- The KMS key details.
Return type

dict

Returns

Response Syntax

{
    'settings': {
        'isAwsOrgEnabled': True|False,
        'snsTopic': 'string',
        'defaultAssessmentReportsDestination': {
            'destinationType': 'S3',
            'destination': 'string'
        },
        'defaultProcessOwners': [
            {
                'roleType': 'PROCESS_OWNER'|'RESOURCE_OWNER',
                'roleArn': 'string'
            },
        ],
        'kmsKey': 'string'
    }
}

Response Structure

  • (dict) --

    • settings (dict) --

      The current list of settings.

      • isAwsOrgEnabled (boolean) --

        Specifies whether Organizations is enabled.

      • snsTopic (string) --

        The designated Amazon Simple Notification Service (Amazon SNS) topic.

      • defaultAssessmentReportsDestination (dict) --

        The default storage destination for assessment reports.

        • destinationType (string) --

          The destination type, such as Amazon S3.

        • destination (string) --

          The destination of the assessment report.

      • defaultProcessOwners (list) --

        The designated default audit owners.

        • (dict) --

          The wrapper that contains the Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN).

          • roleType (string) --

            The type of customer persona.

            Note

            In CreateAssessment , roleType can only be PROCESS_OWNER .

            In UpdateSettings , roleType can only be PROCESS_OWNER .

            In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

          • roleArn (string) --

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

      • kmsKey (string) --

        The KMS key details.

Exceptions

validate_assessment_report_integrity(**kwargs)

Validates the integrity of an assessment report in Audit Manager.

See also: AWS API Documentation

Request Syntax

response = client.validate_assessment_report_integrity(
    s3RelativePath='string'
)
Parameters
s3RelativePath (string) --

[REQUIRED]

The relative path of the specified Amazon S3 bucket in which the assessment report is stored.

Return type
dict
Returns
Response Syntax
{
    'signatureValid': True|False,
    'signatureAlgorithm': 'string',
    'signatureDateTime': 'string',
    'signatureKeyId': 'string',
    'validationErrors': [
        'string',
    ]
}

Response Structure

  • (dict) --
    • signatureValid (boolean) --

      Specifies whether the signature key is valid.

    • signatureAlgorithm (string) --

      The signature algorithm used to code sign the assessment report file.

    • signatureDateTime (string) --

      The date and time signature that specifies when the assessment report was created.

    • signatureKeyId (string) --

      The unique identifier for the validation signature key.

    • validationErrors (list) --

      Represents any errors that occurred when validating the assessment report.

      • (string) --

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class AuditManager.Client.exceptions.AccessDeniedException

Your account is not registered with Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Your account is not registered with Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class AuditManager.Client.exceptions.InternalServerException

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

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

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

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class AuditManager.Client.exceptions.ResourceNotFoundException

The resource specified in the request cannot be found.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'resourceId': 'string',
    'resourceType': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The resource specified in the request cannot be found.

    • message (string) --

    • resourceId (string) --

      The unique identifier for the specified resource.

    • resourceType (string) --

      The type of resource affected by the error.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class AuditManager.Client.exceptions.ValidationException

The request has invalid or missing parameters.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'reason': 'unknownOperation'|'cannotParse'|'fieldValidationFailed'|'other',
    'fields': [
        {
            'name': 'string',
            'message': 'string'
        },
    ],
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request has invalid or missing parameters.

    • message (string) --

    • reason (string) --

      The reason the request failed validation.

    • fields (list) --

      The fields that caused the error, if applicable.

      • (dict) --

        Indicates that the request has invalid or missing parameters for the specified field.

        • name (string) --

          The name of the validation error.

        • message (string) --

          The body of the error message.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: