:doc:`PinpointEmail <../../pinpoint-email>` / Client / list_deliverability_test_reports

********************************
list_deliverability_test_reports
********************************



.. py:method:: PinpointEmail.Client.list_deliverability_test_reports(**kwargs)

  

  Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the ``GetDeliverabilityTestReport`` operation to view the results.

  

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


  **Request Syntax**
  ::

    response = client.list_deliverability_test_reports(
        NextToken='string',
        PageSize=123
    )
    
  :type NextToken: string
  :param NextToken: 

    A token returned from a previous call to ``ListDeliverabilityTestReports`` to indicate the position in the list of predictive inbox placement tests.

    

  
  :type PageSize: integer
  :param PageSize: 

    The number of results to show in a single call to ``ListDeliverabilityTestReports``. If the number of results is larger than the number you specified in this parameter, then the response includes a ``NextToken`` element, which you can use to obtain additional results.

     

    The value you specify has to be at least 0, and can be no more than 1000.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'DeliverabilityTestReports': [
              {
                  'ReportId': 'string',
                  'ReportName': 'string',
                  'Subject': 'string',
                  'FromEmailAddress': 'string',
                  'CreateDate': datetime(2015, 1, 1),
                  'DeliverabilityTestStatus': 'IN_PROGRESS'|'COMPLETED'
              },
          ],
          'NextToken': 'string'
      }
      
    **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.

            
      
    
      

      - **NextToken** *(string) --* 

        A token that indicates that there are additional predictive inbox placement tests to list. To view additional predictive inbox placement tests, issue another request to ``ListDeliverabilityTestReports``, and pass this token in the ``NextToken`` parameter.

        
  
  **Exceptions**
  
  *   :py:class:`PinpointEmail.Client.exceptions.TooManyRequestsException`

  
  *   :py:class:`PinpointEmail.Client.exceptions.NotFoundException`

  
  *   :py:class:`PinpointEmail.Client.exceptions.BadRequestException`

  