ResilienceHubV2 / Paginator / ListReports

ListReports

class ResilienceHubV2.Paginator.ListReports

paginator = client.get_paginator('list_reports')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ResilienceHubV2.Client.list_reports().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    serviceArn='string',
    reportType='FAILURE_MODE',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• serviceArn (string) – Optional. If not provided, lists all reports owned by the account.

• reportType (string) – Filter reports by type.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'reportGenerationResults': [
        {
            'reportType': 'FAILURE_MODE',
            'status': 'PENDING'|'SUCCEEDED'|'FAILED',
            'serviceArn': 'string',
            'assessmentId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'reportOutput': {
                's3ReportOutput': {
                    's3ObjectKey': 'string'
                },
                'failedReportOutput': {
                    'errorCode': 'INSUFFICIENT_PERMISSIONS'|'CONFIGURATION_ERROR'|'INTERNAL_ERROR',
                    'errorMessage': 'string'
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • reportGenerationResults (list) –

    The list of report generation results.

    • (dict) –

      Result of a report generation attempt.

      • reportType (string) –

        The type of the generated report.

      • status (string) –

        The status of the report generation.

      • serviceArn (string) –

        The service this report was generated for.

      • assessmentId (string) –

        Present for FAILURE_MODE reports.

      • createdAt (datetime) –

        The timestamp when the report was created.

      • reportOutput (dict) –

        Present when status is SUCCEEDED or FAILED.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: s3ReportOutput, failedReportOutput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • s3ReportOutput (dict) –

          The S3 location where the report was written.

          • s3ObjectKey (string) –

            The S3 object key for the generated report.

        • failedReportOutput (dict) –

          Details when report generation failed.

          • errorCode (string) –

            The error code describing why the report generation failed.

          • errorMessage (string) –

            The error message describing why the report generation failed.

  • NextToken (string) –

    A token to resume pagination.