:doc:`Artifact <../../artifact>` / Paginator / ListReports

***********
ListReports
***********



.. py:class:: Artifact.Paginator.ListReports

  ::

    
    paginator = client.get_paginator('list_reports')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Artifact.Client.list_reports`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/artifact-2018-05-10/ListReports>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :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) --* 

          A token to resume pagination.

          
    