Artifact / Client / list_reports

list_reports#

Artifact.Client.list_reports(**kwargs)#

List available reports.

See also: AWS API Documentation

Request Syntax

response = client.list_reports(
    maxResults=123,
    nextToken='string'
)
Parameters:

  • maxResults (integer) – Maximum number of resources to return in the paginated response.

  • nextToken (string) – Pagination token to request the next page of resources.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'reports': [
        {
            'arn': 'string',
            'category': 'string',
            'companyName': 'string',
            'description': 'string',
            'id': 'string',
            'name': 'string',
            'periodEnd': datetime(2015, 1, 1),
            'periodStart': datetime(2015, 1, 1),
            'productName': 'string',
            'series': 'string',
            'state': 'PUBLISHED'|'UNPUBLISHED',
            'statusMessage': 'string',
            'uploadState': 'PROCESSING'|'COMPLETE'|'FAILED'|'FAULT',
            'version': 123
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      Pagination token to request the next page of resources.

    • reports (list) –

      List of report resources.

      • (dict) –

        Summary for report resource.

        • arn (string) –

          ARN for the report resource.

        • category (string) –

          Category for the report resource.

        • companyName (string) –

          Associated company name for the report resource.

        • description (string) –

          Description for the report resource.

        • id (string) –

          Unique resource ID for the report resource.

        • name (string) –

          Name for the report resource.

        • periodEnd (datetime) –

          Timestamp indicating the report resource effective end.

        • periodStart (datetime) –

          Timestamp indicating the report resource effective start.

        • productName (string) –

          Associated product name for the report resource.

        • series (string) –

          Series for the report resource.

        • state (string) –

          Current state of the report resource.

        • statusMessage (string) –

          The message associated with the current upload state.

        • uploadState (string) –

          The current state of the document upload.

        • version (integer) –

          Version for the report resource.

Exceptions