:doc:`PI <../../pi>` / Client / list_performance_analysis_reports

*********************************
list_performance_analysis_reports
*********************************



.. py:method:: PI.Client.list_performance_analysis_reports(**kwargs)

  

  Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/ListPerformanceAnalysisReports>`_  


  **Request Syntax**
  ::

    response = client.list_performance_analysis_reports(
        ServiceType='RDS'|'DOCDB',
        Identifier='string',
        NextToken='string',
        MaxResults=123,
        ListTags=True|False
    )
    
  :type ServiceType: string
  :param ServiceType: **[REQUIRED]** 

    The Amazon Web Services service for which Performance Insights returns metrics. Valid value is ``RDS``.

    

  
  :type Identifier: string
  :param Identifier: **[REQUIRED]** 

    An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as *ResourceID*. When you call ``DescribeDBInstances``, the identifier is returned as ``DbiResourceId``.

     

    To use a DB instance as a data source, specify its ``DbiResourceId`` value. For example, specify ``db-ABCDEFGHIJKLMNOPQRSTU1VW2X``.

    

  
  :type NextToken: string
  :param NextToken: 

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by ``MaxResults``.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of items to return in the response. If more items exist than the specified ``MaxResults`` value, a pagination token is included in the response so that the remaining results can be retrieved.

    

  
  :type ListTags: boolean
  :param ListTags: 

    Specifies whether or not to include the list of tags in the response.

    

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

    
    ::

      {
          'AnalysisReports': [
              {
                  'AnalysisReportId': 'string',
                  'CreateTime': datetime(2015, 1, 1),
                  'StartTime': datetime(2015, 1, 1),
                  'EndTime': datetime(2015, 1, 1),
                  'Status': 'RUNNING'|'SUCCEEDED'|'FAILED',
                  'Tags': [
                      {
                          'Key': 'string',
                          'Value': 'string'
                      },
                  ]
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **AnalysisReports** *(list) --* 

        List of reports including the report identifier, start and end time, creation time, and status.

        
        

        - *(dict) --* 

          Retrieves the details of the performance analysis report.

          
          

          - **AnalysisReportId** *(string) --* 

            The name of the analysis report.

            
          

          - **CreateTime** *(datetime) --* 

            The time you created the analysis report.

            
          

          - **StartTime** *(datetime) --* 

            The start time of the analysis in the report.

            
          

          - **EndTime** *(datetime) --* 

            The end time of the analysis in the report.

            
          

          - **Status** *(string) --* 

            The status of the analysis report.

            
          

          - **Tags** *(list) --* 

            List of all the tags added to the analysis report.

            
            

            - *(dict) --* 

              Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

              
              

              - **Key** *(string) --* 

                A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: ``"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"``).

                
              

              - **Value** *(string) --* 

                A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").

                
          
        
      
    
      

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

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by ``MaxResults``.

        
  
  **Exceptions**
  
  *   :py:class:`PI.Client.exceptions.InvalidArgumentException`

  
  *   :py:class:`PI.Client.exceptions.InternalServiceError`

  
  *   :py:class:`PI.Client.exceptions.NotAuthorizedException`

  