list_assessment_reports

AuditManager.Client.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 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

{
    '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 that the ListAssessmentReports API returned.

    • (dict) --

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

Exceptions

• AuditManager.Client.exceptions.ValidationException
• AuditManager.Client.exceptions.AccessDeniedException
• AuditManager.Client.exceptions.InternalServerException