Artifact / Paginator / ListReports


class Artifact.Paginator.ListReports#
paginator = client.get_paginator('list_reports')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'

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:



Response Syntax

    '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
    'NextToken': 'string'

Response Structure

  • (dict) –

    • 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.

    • NextToken (string) –

      A token to resume pagination.