Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1466257.0 KB

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

post/#X-Amz-Target=PerformanceInsightsv20180227.ListAvailableResourceMetrics

Query parameters

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Headers

X-Amz-Target'PerformanceInsightsv20180227.ListAvailableResourceMetrics' required

Request body

ServiceType'RDS' | 'DOCDB' required

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

Identifierstring required

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 <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VWZ</code>.

MetricTypesRequestString[] required
<p>The types of metrics to return in the response. Valid values in the array include the following:</p> <ul> <li> <p> <code>os</code> (OS counter metrics) - All engines</p> </li> <li> <p> <code>db</code> (DB load metrics) - All engines except for Amazon DocumentDB</p> </li> <li> <p> <code>db.sql.stats</code> (per-SQL metrics) - All engines except for Amazon DocumentDB</p> </li> <li> <p> <code>db.sql_tokenized.stats</code> (per-SQL digest metrics) - All engines except for Amazon DocumentDB</p> </li> </ul>
NextTokenstring

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 <code>MaxRecords</code>.

MaxResultsinteger

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

Response

Success

NextTokenstring

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