Skip to content

List Available Resource Metrics

pi_list_available_resource_metrics R Documentation

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

Description

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

Usage

pi_list_available_resource_metrics(ServiceType, Identifier, MetricTypes,
  NextToken, MaxResults)

Arguments

ServiceType

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

Identifier

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

MetricTypes

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

  • os (OS counter metrics) - All engines

  • db (DB load metrics) - All engines except for Amazon DocumentDB

  • db.sql.stats (per-SQL metrics) - All engines except for Amazon DocumentDB

  • db.sql_tokenized.stats (per-SQL digest metrics) - All engines except for Amazon DocumentDB

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.

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.

Value

A list with the following syntax: 

list(
  Metrics = list(
    list(
      Metric = "string",
      Description = "string",
      Unit = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_available_resource_metrics(
  ServiceType = "RDS"|"DOCDB",
  Identifier = "string",
  MetricTypes = list(
    "string"
  ),
  NextToken = "string",
  MaxResults = 123
)