Skip to content

aws.pi.list_available_resource_metrics

Example SQL Queries

SELECT * FROM
aws.pi.list_available_resource_metrics
WHERE
"service_type" = 'VALUE'
AND "identifier" = 'VALUE'
AND "metric_types" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
identifier Required Input Column

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.

VARCHAR
metric_types Required Input Column

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

VARCHAR[]
Show child fields
metric_types[]
service_type Required Input Column

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

VARCHAR
max_results Input Column

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.

BIGINT
next_token Input Column

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.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
metrics

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

STRUCT(
"metric" VARCHAR,
"description" VARCHAR,
"unit" VARCHAR
)[]
Show child fields
metrics[]
Show child fields
metrics[].description

The description of the metric.

metrics[].metric

The full name of the metric.

metrics[].unit

The unit of the metric.