{ "version": "2.0", "service": "Amazon RDS Performance Insights

Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. The guide provides detailed information about Performance Insights data types, parameters and errors.

When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the authoritative source for Amazon Web Services service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.

DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.

", "operations": { "CreatePerformanceAnalysisReport": "

Creates a new performance analysis report for a specific time period for the DB instance.

", "DeletePerformanceAnalysisReport": "

Deletes a performance analysis report.

", "DescribeDimensionKeys": "

For a specific time period, retrieve the top N dimension keys for a metric.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

", "GetDimensionKeyDetails": "

Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, GetDimensionKeyDetails retrieves the full text of the dimension db.sql.statement associated with this ID. This operation is useful because GetResourceMetrics and DescribeDimensionKeys don't support retrieval of large SQL statement text.

", "GetPerformanceAnalysisReport": "

Retrieves the report including the report ID, status, time details, and the insights with recommendations. The report status can be RUNNING, SUCCEEDED, or FAILED. The insights include the description and recommendation fields.

", "GetResourceMetadata": "

Retrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.

", "GetResourceMetrics": "

Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

", "ListAvailableResourceDimensions": "

Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.

", "ListAvailableResourceMetrics": "

Retrieve metrics of the specified types that can be queried for a specified DB instance.

", "ListPerformanceAnalysisReports": "

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

", "ListTagsForResource": "

Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.

", "TagResource": "

Adds metadata tags to the Amazon RDS Performance Insights resource.

", "UntagResource": "

Deletes the metadata tags from the Amazon RDS Performance Insights resource.

" }, "shapes": { "AcceptLanguage": { "base": null, "refs": { "GetPerformanceAnalysisReportRequest$AcceptLanguage": "

The text language in the report. The default language is EN_US (English).

" } }, "AdditionalMetricsList": { "base": null, "refs": { "DescribeDimensionKeysRequest$AdditionalMetrics": "

Additional metrics for the top N dimension keys. If the specified dimension group in the GroupBy parameter is db.sql_tokenized, you can specify per-SQL metrics to get the values for the top N SQL digests. The response syntax is as follows: \"AdditionalMetrics\" : { \"string\" : \"string\" }.

" } }, "AdditionalMetricsMap": { "base": null, "refs": { "DimensionKeyDescription$AdditionalMetrics": "

A map that contains the value for each additional metric.

" } }, "AmazonResourceName": { "base": null, "refs": { "ListTagsForResourceRequest$ResourceARN": "

Lists all the tags for the Amazon RDS Performance Insights resource. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

", "TagResourceRequest$ResourceARN": "

The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

", "UntagResourceRequest$ResourceARN": "

The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

" } }, "AnalysisReport": { "base": "

Retrieves the summary of the performance analysis report created for a time period.

", "refs": { "GetPerformanceAnalysisReportResponse$AnalysisReport": "

The summary of the performance analysis report created for a time period.

" } }, "AnalysisReportId": { "base": null, "refs": { "AnalysisReport$AnalysisReportId": "

The name of the analysis report.

", "CreatePerformanceAnalysisReportResponse$AnalysisReportId": "

A unique identifier for the created analysis report.

", "DeletePerformanceAnalysisReportRequest$AnalysisReportId": "

The unique identifier of the analysis report for deletion.

", "GetPerformanceAnalysisReportRequest$AnalysisReportId": "

A unique identifier of the created analysis report. For example, report-12345678901234567

" } }, "AnalysisReportSummary": { "base": "

Retrieves the details of the performance analysis report.

", "refs": { "AnalysisReportSummaryList$member": null } }, "AnalysisReportSummaryList": { "base": null, "refs": { "ListPerformanceAnalysisReportsResponse$AnalysisReports": "

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

" } }, "AnalysisStatus": { "base": null, "refs": { "AnalysisReport$Status": "

The status of the created analysis report.

", "AnalysisReportSummary$Status": "

The status of the analysis report.

" } }, "Boolean": { "base": null, "refs": { "ListPerformanceAnalysisReportsRequest$ListTags": "

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

" } }, "ContextType": { "base": null, "refs": { "Insight$Context": "

Indicates if the insight is causal or correlated insight.

" } }, "CreatePerformanceAnalysisReportRequest": { "base": null, "refs": { } }, "CreatePerformanceAnalysisReportResponse": { "base": null, "refs": { } }, "Data": { "base": "

List of data objects which provide details about source metrics. This field can be used to determine the PI metric to render for the insight. This data type also includes static values for the metrics for the Insight that were calculated and included in text and annotations on the DB load chart.

", "refs": { "DataList$member": null } }, "DataList": { "base": null, "refs": { "Insight$InsightData": "

List of data objects containing metrics and references from the time range while generating the insight.

", "Insight$BaselineData": "

Metric names and values from the timeframe used as baseline to generate the insight.

" } }, "DataPoint": { "base": "

A timestamp, and a single numerical value, which together represent a measurement at a particular point in time.

", "refs": { "DataPointsList$member": null } }, "DataPointsList": { "base": null, "refs": { "MetricKeyDataPoints$DataPoints": "

An array of timestamp-value pairs, representing measurements over a period of time.

" } }, "DeletePerformanceAnalysisReportRequest": { "base": null, "refs": { } }, "DeletePerformanceAnalysisReportResponse": { "base": null, "refs": { } }, "DescribeDimensionKeysRequest": { "base": null, "refs": { } }, "DescribeDimensionKeysResponse": { "base": null, "refs": { } }, "Description": { "base": null, "refs": { "ResponseResourceMetric$Description": "

The description of the metric.

" } }, "DescriptiveMap": { "base": null, "refs": { "PerformanceInsightsMetric$Dimensions": "

A dimension map that contains the dimensions for this partition.

" } }, "DescriptiveString": { "base": null, "refs": { "DescriptiveMap$key": null, "DescriptiveMap$value": null, "PerformanceInsightsMetric$Metric": "

The Performance Insights metric.

", "PerformanceInsightsMetric$DisplayName": "

The Performance Insights metric name.

" } }, "DetailStatus": { "base": null, "refs": { "DimensionKeyDetail$Status": "

The status of the dimension detail data. Possible values include the following:

" } }, "DimensionDetail": { "base": "

The information about a dimension.

", "refs": { "DimensionDetailList$member": null } }, "DimensionDetailList": { "base": null, "refs": { "DimensionGroupDetail$Dimensions": "

The dimensions within a dimension group.

" } }, "DimensionGroup": { "base": "

A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql dimension group consists of the following dimensions:

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

", "refs": { "DescribeDimensionKeysRequest$GroupBy": "

A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return a limited number of values for a dimension.

", "DescribeDimensionKeysRequest$PartitionBy": "

For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.

", "MetricQuery$GroupBy": "

A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

" } }, "DimensionGroupDetail": { "base": "

Information about dimensions within a dimension group.

", "refs": { "DimensionGroupDetailList$member": null } }, "DimensionGroupDetailList": { "base": null, "refs": { "MetricDimensionGroups$Groups": "

The available dimension groups for a metric type.

" } }, "DimensionKeyDescription": { "base": "

An object that includes the requested dimension key values and aggregated metric values within a dimension group.

", "refs": { "DimensionKeyDescriptionList$member": null } }, "DimensionKeyDescriptionList": { "base": null, "refs": { "DescribeDimensionKeysResponse$Keys": "

The dimension keys that were requested.

" } }, "DimensionKeyDetail": { "base": "

An object that describes the details for a specified dimension.

", "refs": { "DimensionKeyDetailList$member": null } }, "DimensionKeyDetailList": { "base": null, "refs": { "GetDimensionKeyDetailsResponse$Dimensions": "

The details for the requested dimensions.

" } }, "DimensionMap": { "base": null, "refs": { "DimensionKeyDescription$Dimensions": "

A map of name-value pairs for the dimensions in the group.

", "ResponsePartitionKey$Dimensions": "

A dimension map that contains the dimensions for this partition.

", "ResponseResourceMetricKey$Dimensions": "

The valid dimensions for the metric.

" } }, "DimensionsMetricList": { "base": null, "refs": { "ListAvailableResourceDimensionsRequest$Metrics": "

The types of metrics for which to retrieve dimensions. Valid values include db.load.

" } }, "Double": { "base": null, "refs": { "AdditionalMetricsMap$value": null, "DataPoint$Value": "

The actual value associated with a particular Timestamp.

", "DimensionKeyDescription$Total": "

The aggregated metric value for the dimensions, over the requested time range.

", "MetricValuesList$member": null, "PerformanceInsightsMetric$Value": "

The value of the metric. For example, 9 for db.load.avg.

" } }, "ErrorString": { "base": null, "refs": { "InternalServiceError$Message": null, "InvalidArgumentException$Message": null, "NotAuthorizedException$Message": null } }, "FeatureMetadata": { "base": "

The metadata for a feature. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.

", "refs": { "FeatureMetadataMap$value": null } }, "FeatureMetadataMap": { "base": null, "refs": { "GetResourceMetadataResponse$Features": "

The metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.

" } }, "FeatureStatus": { "base": null, "refs": { "FeatureMetadata$Status": "

The status of the feature on the DB instance. Possible values include the following:

" } }, "GetDimensionKeyDetailsRequest": { "base": null, "refs": { } }, "GetDimensionKeyDetailsResponse": { "base": null, "refs": { } }, "GetPerformanceAnalysisReportRequest": { "base": null, "refs": { } }, "GetPerformanceAnalysisReportResponse": { "base": null, "refs": { } }, "GetResourceMetadataRequest": { "base": null, "refs": { } }, "GetResourceMetadataResponse": { "base": null, "refs": { } }, "GetResourceMetricsRequest": { "base": null, "refs": { } }, "GetResourceMetricsResponse": { "base": null, "refs": { } }, "ISOTimestamp": { "base": null, "refs": { "AnalysisReport$CreateTime": "

The time you created the analysis report.

", "AnalysisReport$StartTime": "

The analysis start time in the report.

", "AnalysisReport$EndTime": "

The analysis end time in the report.

", "AnalysisReportSummary$CreateTime": "

The time you created the analysis report.

", "AnalysisReportSummary$StartTime": "

The start time of the analysis in the report.

", "AnalysisReportSummary$EndTime": "

The end time of the analysis in the report.

", "CreatePerformanceAnalysisReportRequest$StartTime": "

The start time defined for the analysis report.

", "CreatePerformanceAnalysisReportRequest$EndTime": "

The end time defined for the analysis report.

", "DataPoint$Timestamp": "

The time, in epoch format, associated with a particular Value.

", "DescribeDimensionKeysRequest$StartTime": "

The date and time specifying the beginning of the requested time series data. You must specify a StartTime within the past 7 days. The value specified is inclusive, which means that data points equal to or greater than StartTime are returned.

The value for StartTime must be earlier than the value for EndTime.

", "DescribeDimensionKeysRequest$EndTime": "

The date and time specifying the end of the requested time series data. The value specified is exclusive, which means that data points less than (but not equal to) EndTime are returned.

The value for EndTime must be later than the value for StartTime.

", "DescribeDimensionKeysResponse$AlignedStartTime": "

The start time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the user-specified StartTime.

", "DescribeDimensionKeysResponse$AlignedEndTime": "

The end time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the user-specified Endtime.

", "GetResourceMetricsRequest$StartTime": "

The date and time specifying the beginning of the requested time series query range. You can't specify a StartTime that is earlier than 7 days ago. By default, Performance Insights has 7 days of retention, but you can extend this range up to 2 years. The value specified is inclusive. Thus, the command returns data points equal to or greater than StartTime.

The value for StartTime must be earlier than the value for EndTime.

", "GetResourceMetricsRequest$EndTime": "

The date and time specifying the end of the requested time series query range. The value specified is exclusive. Thus, the command returns data points less than (but not equal to) EndTime.

The value for EndTime must be later than the value for StartTime.

", "GetResourceMetricsResponse$AlignedStartTime": "

The start time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the user-specified StartTime.

", "GetResourceMetricsResponse$AlignedEndTime": "

The end time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the user-specified Endtime.

", "Insight$StartTime": "

The start time of the insight. For example, 2018-10-30T00:00:00Z.

", "Insight$EndTime": "

The end time of the insight. For example, 2018-10-30T00:00:00Z.

" } }, "IdentifierString": { "base": null, "refs": { "AnalysisReport$Identifier": "

The unique identifier of the analysis report.

", "CreatePerformanceAnalysisReportRequest$Identifier": "

An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.

To use an Amazon RDS instance as a data source, you specify its DbiResourceId value. For example, specify db-ADECBTYHKTSAUMUZQYPDS2GW4A.

", "DeletePerformanceAnalysisReportRequest$Identifier": "

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.

", "DescribeDimensionKeysRequest$Identifier": "

An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.

To use an Amazon RDS instance as a data source, you specify its DbiResourceId value. For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A.

", "GetDimensionKeyDetailsRequest$Identifier": "

The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an Amazon Web Services Region. When a DB instance is the data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

", "GetPerformanceAnalysisReportRequest$Identifier": "

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.

", "GetResourceMetadataRequest$Identifier": "

An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

", "GetResourceMetricsRequest$Identifier": "

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.

", "ListAvailableResourceDimensionsRequest$Identifier": "

An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.

", "ListAvailableResourceMetricsRequest$Identifier": "

An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.

", "ListPerformanceAnalysisReportsRequest$Identifier": "

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.

" } }, "Insight": { "base": "

Retrieves the list of performance issues which are identified.

", "refs": { "InsightList$member": null } }, "InsightList": { "base": null, "refs": { "AnalysisReport$Insights": "

The list of identified insights in the analysis report.

", "Insight$SupportingInsights": "

List of supporting insights that provide additional factors for the insight.

" } }, "Integer": { "base": null, "refs": { "DescribeDimensionKeysRequest$PeriodInSeconds": "

The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:

If you don't specify PeriodInSeconds, then Performance Insights chooses a value for you, with a goal of returning roughly 100-200 data points in the response.

", "GetResourceMetricsRequest$PeriodInSeconds": "

The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:

If you don't specify PeriodInSeconds, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response.

" } }, "InternalServiceError": { "base": "

The request failed due to an unknown error.

", "refs": { } }, "InvalidArgumentException": { "base": "

One of the arguments provided is invalid for this request.

", "refs": { } }, "Limit": { "base": null, "refs": { "DimensionGroup$Limit": "

The maximum number of items to fetch for this dimension group.

" } }, "ListAvailableResourceDimensionsRequest": { "base": null, "refs": { } }, "ListAvailableResourceDimensionsResponse": { "base": null, "refs": { } }, "ListAvailableResourceMetricsRequest": { "base": null, "refs": { } }, "ListAvailableResourceMetricsResponse": { "base": null, "refs": { } }, "ListPerformanceAnalysisReportsRequest": { "base": null, "refs": { } }, "ListPerformanceAnalysisReportsResponse": { "base": null, "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResponse": { "base": null, "refs": { } }, "MarkdownString": { "base": null, "refs": { "Insight$Description": "

Description of the insight. For example: A high severity Insight found between 02:00 to 02:30, where there was an unusually high DB load 600x above baseline. Likely performance impact.

", "Recommendation$RecommendationDescription": "

The recommendation details to help resolve the performance issue. For example, Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id

" } }, "MaxResults": { "base": null, "refs": { "DescribeDimensionKeysRequest$MaxResults": "

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

", "GetResourceMetricsRequest$MaxResults": "

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

", "ListAvailableResourceDimensionsRequest$MaxResults": "

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

", "ListAvailableResourceMetricsRequest$MaxResults": "

The maximum number of items to return. If the MaxRecords value is less than the number of existing items, the response includes a pagination token.

", "ListPerformanceAnalysisReportsRequest$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.

" } }, "MetricDimensionGroups": { "base": "

The available dimension information for a metric type.

", "refs": { "MetricDimensionsList$member": null } }, "MetricDimensionsList": { "base": null, "refs": { "ListAvailableResourceDimensionsResponse$MetricDimensions": "

The dimension information returned for requested metric types.

" } }, "MetricKeyDataPoints": { "base": "

A time-ordered series of data points, corresponding to a dimension of a Performance Insights metric.

", "refs": { "MetricKeyDataPointsList$member": null } }, "MetricKeyDataPointsList": { "base": null, "refs": { "GetResourceMetricsResponse$MetricList": "

An array of metric results, where each array element contains all of the data points for a particular dimension.

" } }, "MetricQuery": { "base": "

A single query to be processed. You must provide the metric to query. If no other parameters are specified, Performance Insights returns all data points for the specified metric. Optionally, you can request that the data points be aggregated by dimension group (GroupBy), and return only those data points that match your criteria (Filter).

", "refs": { "MetricQueryList$member": null } }, "MetricQueryFilterMap": { "base": null, "refs": { "DescribeDimensionKeysRequest$Filter": "

One or more filters to apply in the request. Restrictions:

", "MetricQuery$Filter": "

One or more filters to apply in the request. Restrictions:

" } }, "MetricQueryList": { "base": null, "refs": { "GetResourceMetricsRequest$MetricQueries": "

An array of one or more queries to perform. Each query must specify a Performance Insights metric, and can optionally specify aggregation and filtering criteria.

" } }, "MetricTypeList": { "base": null, "refs": { "ListAvailableResourceMetricsRequest$MetricTypes": "

The types of metrics to return in the response. Valid values in the array include the following:

" } }, "MetricValuesList": { "base": null, "refs": { "DimensionKeyDescription$Partitions": "

If PartitionBy was specified, PartitionKeys contains the dimensions that were.

" } }, "NextToken": { "base": null, "refs": { "DescribeDimensionKeysRequest$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 MaxRecords.

", "DescribeDimensionKeysResponse$NextToken": "

A pagination token that indicates the response didn’t return all available records because MaxRecords was specified in the previous request. To get the remaining records, specify NextToken in a separate request with this value.

", "GetResourceMetricsRequest$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 MaxRecords.

", "GetResourceMetricsResponse$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 MaxRecords.

", "ListAvailableResourceDimensionsRequest$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 MaxRecords.

", "ListAvailableResourceDimensionsResponse$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 MaxRecords.

", "ListAvailableResourceMetricsRequest$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 MaxRecords.

", "ListAvailableResourceMetricsResponse$NextToken": "

A pagination token that indicates the response didn’t return all available records because MaxRecords was specified in the previous request. To get the remaining records, specify NextToken in a separate request with this value.

", "ListPerformanceAnalysisReportsRequest$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.

", "ListPerformanceAnalysisReportsResponse$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.

" } }, "NotAuthorizedException": { "base": "

The user is not authorized to perform this request.

", "refs": { } }, "PerformanceInsightsMetric": { "base": "

This data type helps to determine Performance Insights metric to render for the insight.

", "refs": { "Data$PerformanceInsightsMetric": "

This field determines the Performance Insights metric to render for the insight. The name field refers to a Performance Insights metric.

" } }, "PeriodAlignment": { "base": null, "refs": { "GetResourceMetricsRequest$PeriodAlignment": "

The returned timestamp which is the start or end time of the time periods. The default value is END_TIME.

" } }, "Recommendation": { "base": "

The list of recommendations for the insight.

", "refs": { "RecommendationList$member": null } }, "RecommendationList": { "base": null, "refs": { "Insight$Recommendations": "

List of recommendations for the insight. For example, Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id.

" } }, "RequestString": { "base": null, "refs": { "AdditionalMetricsList$member": null, "AdditionalMetricsMap$key": null, "DescribeDimensionKeysRequest$Metric": "

The name of a Performance Insights metric to be measured.

Valid values for Metric are:

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

", "DimensionGroup$Group": "

The name of the dimension group. Valid values are as follows:

", "DimensionMap$key": null, "DimensionMap$value": null, "DimensionsMetricList$member": null, "GetDimensionKeyDetailsRequest$Group": "

The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are valid:

", "GetDimensionKeyDetailsRequest$GroupIdentifier": "

The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql, the group ID is db.sql.id. The following group ID values are valid:

", "MetricQuery$Metric": "

The name of a Performance Insights metric to be measured.

Valid values for Metric are:

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

", "MetricQueryFilterMap$key": null, "MetricQueryFilterMap$value": null, "MetricTypeList$member": null, "RequestStringList$member": null, "RequestedDimensionList$member": null } }, "RequestStringList": { "base": null, "refs": { "DimensionGroup$Dimensions": "

A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested, or are present in the response.

Valid values for elements in the Dimensions array are:

" } }, "RequestedDimensionList": { "base": null, "refs": { "GetDimensionKeyDetailsRequest$RequestedDimensions": "

A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:

" } }, "ResponsePartitionKey": { "base": "

If PartitionBy was specified in a DescribeDimensionKeys request, the dimensions are returned in an array. Each element in the array specifies one dimension.

", "refs": { "ResponsePartitionKeyList$member": null } }, "ResponsePartitionKeyList": { "base": null, "refs": { "DescribeDimensionKeysResponse$PartitionKeys": "

If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions.

" } }, "ResponseResourceMetric": { "base": "

An object that contains the full name, description, and unit of a metric.

", "refs": { "ResponseResourceMetricList$member": null } }, "ResponseResourceMetricKey": { "base": "

An object describing a Performance Insights metric and one or more dimensions for that metric.

", "refs": { "MetricKeyDataPoints$Key": "

The dimensions to which the data points apply.

" } }, "ResponseResourceMetricList": { "base": null, "refs": { "ListAvailableResourceMetricsResponse$Metrics": "

An array of metrics available to query. Each array element contains the full name, description, and unit of the metric.

" } }, "ServiceType": { "base": null, "refs": { "AnalysisReport$ServiceType": "

List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:

", "CreatePerformanceAnalysisReportRequest$ServiceType": "

The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.

", "DeletePerformanceAnalysisReportRequest$ServiceType": "

The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.

", "DescribeDimensionKeysRequest$ServiceType": "

The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:

", "GetDimensionKeyDetailsRequest$ServiceType": "

The Amazon Web Services service for which Performance Insights returns data. The only valid value is RDS.

", "GetPerformanceAnalysisReportRequest$ServiceType": "

The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.

", "GetResourceMetadataRequest$ServiceType": "

The Amazon Web Services service for which Performance Insights returns metrics.

", "GetResourceMetricsRequest$ServiceType": "

The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:

", "ListAvailableResourceDimensionsRequest$ServiceType": "

The Amazon Web Services service for which Performance Insights returns metrics.

", "ListAvailableResourceMetricsRequest$ServiceType": "

The Amazon Web Services service for which Performance Insights returns metrics.

", "ListPerformanceAnalysisReportsRequest$ServiceType": "

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

", "ListTagsForResourceRequest$ServiceType": "

List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.

", "TagResourceRequest$ServiceType": "

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

", "UntagResourceRequest$ServiceType": "

List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.

" } }, "Severity": { "base": null, "refs": { "Insight$Severity": "

The severity of the insight. The values are: Low, Medium, or High.

" } }, "String": { "base": null, "refs": { "AnalysisReportSummary$AnalysisReportId": "

The name of the analysis report.

", "DimensionDetail$Identifier": "

The identifier of a dimension.

", "DimensionGroupDetail$Group": "

The name of the dimension group.

", "DimensionKeyDetail$Value": "

The value of the dimension detail data. Depending on the return status, this value is either the full or truncated SQL query for the following dimensions:

", "DimensionKeyDetail$Dimension": "

The full name of the dimension. The full name includes the group name and key name. The following values are valid:

", "FeatureMetadataMap$key": null, "GetResourceMetadataResponse$Identifier": "

An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

", "GetResourceMetricsResponse$Identifier": "

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.

", "Insight$InsightId": "

The unique identifier for the insight. For example, insight-12345678901234567.

", "Insight$InsightType": "

The type of insight. For example, HighDBLoad, HighCPU, or DominatingSQLs.

", "MetricDimensionGroups$Metric": "

The metric type to which the dimension information belongs.

", "Recommendation$RecommendationId": "

The unique identifier for the recommendation.

", "ResponseResourceMetric$Metric": "

The full name of the metric.

", "ResponseResourceMetric$Unit": "

The unit of the metric.

", "ResponseResourceMetricKey$Metric": "

The name of a Performance Insights metric to be measured.

Valid values for Metric are:

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

" } }, "Tag": { "base": "

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

", "refs": { "TagList$member": null } }, "TagKey": { "base": null, "refs": { "Tag$Key": "

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}_.:/=+\\\\-@]*)$\").

", "TagKeyList$member": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$TagKeys": "

The metadata assigned to an Amazon RDS Performance Insights resource consisting of a key-value pair.

" } }, "TagList": { "base": null, "refs": { "AnalysisReportSummary$Tags": "

List of all the tags added to the analysis report.

", "CreatePerformanceAnalysisReportRequest$Tags": "

The metadata assigned to the analysis report consisting of a key-value pair.

", "ListTagsForResourceResponse$Tags": "

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

", "TagResourceRequest$Tags": "

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

" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "Tag$Value": "

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}_.:/=+\\\\-@]*)$\").

" } }, "TextFormat": { "base": null, "refs": { "GetPerformanceAnalysisReportRequest$TextFormat": "

Indicates the text format in the report. The options are PLAIN_TEXT or MARKDOWN. The default value is plain text.

" } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } } } }