AWS Artifact

{'reports': {'acceptanceType': 'PASSTHROUGH | EXPLICIT'}}

List available reports.

See also: AWS API Documentation

Request Syntax

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

type maxResults

integer

param maxResults

Maximum number of resources to return in the paginated response.

type nextToken

string

param nextToken

Pagination token to request the next page of resources.

rtype

dict

returns

Response Syntax

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

Response Structure

• (dict) --

  • reports (list) --

    List of report resources.

    • (dict) --

      Summary for report resource.

      • id (string) --

        Unique resource ID for the report resource.

      • name (string) --

        Name for the report resource.

      • state (string) --

        Current state of the report resource.

      • arn (string) --

        ARN for the report resource.

      • version (integer) --

        Version for the report resource.

      • uploadState (string) --

        The current state of the document upload.

      • description (string) --

        Description for the report resource.

      • periodStart (datetime) --

        Timestamp indicating the report resource effective start.

      • periodEnd (datetime) --

        Timestamp indicating the report resource effective end.

      • series (string) --

        Series for the report resource.

      • category (string) --

        Category for the report resource.

      • companyName (string) --

        Associated company name for the report resource.

      • productName (string) --

        Associated product name for the report resource.

      • statusMessage (string) --

        The message associated with the current upload state.

      • acceptanceType (string) --

        Acceptance type for report.

  • nextToken (string) --

    Pagination token to request the next page of resources.