ResilienceHubV2 / Client / list_reports

list_reports¶

ResilienceHubV2.Client.list_reports(**kwargs)¶

List reports for a service, or all reports owned by the account if serviceArn is not provided.

Request Syntax

response = client.list_reports(
    serviceArn='string',
    reportType='FAILURE_MODE',
    maxResults=123,
    nextToken='string'
)

Parameters:

serviceArn (string) – Optional. If not provided, lists all reports owned by the account.
reportType (string) – Filter reports by type.
maxResults (integer) – Pagination page size.
nextToken (string) – Pagination token.

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) –
  
  Pagination token.

Exceptions

ResilienceHubV2.Client.exceptions.InternalServerException
ResilienceHubV2.Client.exceptions.ResourceNotFoundException
ResilienceHubV2.Client.exceptions.ValidationException
ResilienceHubV2.Client.exceptions.ThrottlingException
ResilienceHubV2.Client.exceptions.AccessDeniedException