Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ListPerformanceAnalysisReports

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

Request Syntax


{
   "Identifier": "string",
   "ListTags": boolean,
   "MaxResults": number,
   "NextToken": "string",
   "ServiceType": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

Identifier

An immutable identifier for a data source that is unique for an Amazon 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: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: ^[a-zA-Z0-9-]+$

Required: Yes

ServiceType

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

Type: String

Valid Values: RDS | DOCDB

Required: Yes

ListTags

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

Type: Boolean

Required: No

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: Integer

Valid Range: Minimum value of 0. Maximum value of 25.

Required: No

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: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

Pattern: ^[a-zA-Z0-9_=-]+$

Required: No

Response Syntax


{
   "AnalysisReports": [ 
      { 
         "AnalysisReportId": "string",
         "CreateTime": number,
         "EndTime": number,
         "StartTime": number,
         "Status": "string",
         "Tags": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ]
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AnalysisReports

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

Type: Array of AnalysisReportSummary objects

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: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

Pattern: ^[a-zA-Z0-9_=-]+$

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceError

The request failed due to an unknown error.

HTTP Status Code: 500

InvalidArgumentException

One of the arguments provided is invalid for this request.

HTTP Status Code: 400

NotAuthorizedException

The user is not authorized to perform this request.

HTTP Status Code: 400

Examples

List of analysis reports for a DB instance

The following example lists all the analysis reports for the DB instance db-ABC1DEFGHIJKL2MNOPQRSTUV3W along with tags for each report.

Sample Request



                    POST / HTTP/1.1
Host: <Hostname>
Accept-Encoding: identity
X-Amz-Target: PerformanceInsightsv20180227.ListPerformanceAnalysisReports
Content-Type: application/x-amz-json-1.1
User-Agent: <UserAgentString>
X-Amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
Content-Length: <PayloadSizeBytes>

{
    "Identifier": "db-ABC1DEFGHIJKL2MNOPQRSTUV3W",
    "ServiceType": "RDS",
    "ListTags": true,
    "MaxResults": 5
}

Sample Response



                    HTTP/1.1 200 OK
Content-Type: application/x-amz-json-1.1
Date: <Date>
x-amzn-RequestId: <RequestId>
Content-Length: <PayloadSizeBytes>
Connection: keep-alive

{
    "AnalysisReports": [
        {
            "AnalysisReportId": "report-01234567890abcdef",
            "CreateTime": 1690561641.014,
            "EndTime": 1689356407,
            "StartTime": 1689161030,
            "Status": "SUCCEEDED",
            "Tags": [
                {
                    "Key": "Name",
                    "Value": "MyName1"
                }
            ]
        },
        {
            "AnalysisReportId": "report-01234567891abcdef",
            "CreateTime": 1690487582.167,
            "EndTime": 1689339840,
            "StartTime": 1689176864,
            "Status": "SUCCEEDED",
            "Tags": [
                {
                    "Key": "MyKey",
                    "Value": "MyValue"
                },
                {
                    "Key": "Name",
                    "Value": "MyName2"
                }
            ]
        },
        {
            "AnalysisReportId": "report-01234567892abcdef",
            "CreateTime": 1690551889.941,
            "EndTime": 1689324849,
            "StartTime": 1689177272,
            "Status": "SUCCEEDED",
            "Tags": [
                {
                    "Key": "Name",
                    "Value": ""
                }
            ]
        }
    ]
}