:doc:`PinpointEmail <../../pinpoint-email>` / Paginator / ListDeliverabilityTestReports

*****************************
ListDeliverabilityTestReports
*****************************



.. py:class:: PinpointEmail.Paginator.ListDeliverabilityTestReports

  ::

    
    paginator = client.get_paginator('list_deliverability_test_reports')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`PinpointEmail.Client.list_deliverability_test_reports`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ListDeliverabilityTestReports>`_    


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

      
      ::

        {
            'DeliverabilityTestReports': [
                {
                    'ReportId': 'string',
                    'ReportName': 'string',
                    'Subject': 'string',
                    'FromEmailAddress': 'string',
                    'CreateDate': datetime(2015, 1, 1),
                    'DeliverabilityTestStatus': 'IN_PROGRESS'|'COMPLETED'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 

        A list of the predictive inbox placement test reports that are available for your account, regardless of whether or not those tests are complete.

        
        

        - **DeliverabilityTestReports** *(list) --* 

          An object that contains a lists of predictive inbox placement tests that you've performed.

          
          

          - *(dict) --* 

            An object that contains metadata related to a predictive inbox placement test.

            
            

            - **ReportId** *(string) --* 

              A unique string that identifies the predictive inbox placement test.

              
            

            - **ReportName** *(string) --* 

              A name that helps you identify a predictive inbox placement test report.

              
            

            - **Subject** *(string) --* 

              The subject line for an email that you submitted in a predictive inbox placement test.

              
            

            - **FromEmailAddress** *(string) --* 

              The sender address that you specified for the predictive inbox placement test.

              
            

            - **CreateDate** *(datetime) --* 

              The date and time when the predictive inbox placement test was created, in Unix time format.

              
            

            - **DeliverabilityTestStatus** *(string) --* 

              The status of the predictive inbox placement test. If the status is ``IN_PROGRESS``, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is ``COMPLETE``, then the test is finished, and you can use the ``GetDeliverabilityTestReport`` to view the results of the test.

              
        
      
    