Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ListAvailableResourceMetricsRequest

Hierarchy

Index

Properties

Identifier

Identifier: string | undefined

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.

Optional MaxResults

MaxResults: undefined | number

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.

MetricTypes

MetricTypes: string[] | undefined

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

Optional NextToken

NextToken: undefined | 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 MaxRecords.

ServiceType

ServiceType: ServiceType | string | undefined

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