AuditManager / Client / list_assessments

list_assessments

AuditManager.Client.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(
    status='ACTIVE'|'INACTIVE',
    nextToken='string',
    maxResults=123
)

Parameters:

• status (string) – The current status of the assessment.

• nextToken (string) – The pagination token that’s used to fetch the next set of results.

• maxResults (integer) – Represents the maximum number of results on a page or for an 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 that’s associated with the assessment.

    • (dict) –

      A metadata object that’s 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 that’s related to the assessment, such as PCI-DSS.

      • status (string) –

        The current status of the assessment.

      • roles (list) –

        The roles that are associated with the assessment.

        • (dict) –

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

          • roleType (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 that are 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 assessment that’s associated with the delegation.

          • assessmentId (string) –

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

          • 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 control set that’s associated with the delegation.

          • comment (string) –

            The comment that’s related to the delegation.

          • createdBy (string) –

            The 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 that’s used to fetch the next set of results.

Exceptions

• AuditManager.Client.exceptions.AccessDeniedException

• AuditManager.Client.exceptions.ValidationException

• AuditManager.Client.exceptions.InternalServerException