Skip to content
AWS for Query.Farm

aws.pi.list_available_resource_dimensions

Example SQL Queries

SELECT * FROM
aws.pi.list_available_resource_dimensions
WHERE
"service_type" = 'VALUE'
AND "identifier" = 'VALUE'
AND "metrics" = 'VALUE';

Description

Retrieve the dimensions that can be queried for each specified metric type on 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
metrics Required Input Column

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

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

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

VARCHAR
authorized_actions Input Column

The actions to discover the dimensions you are authorized to access. If you specify multiple actions, then the response will contain the dimensions common for all the actions.

When you don't specify this request parameter or provide an empty list, the response contains all the available dimensions for the target database engine whether or not you are authorized to access them.

VARCHAR[]
Show child fields
authorized_actions[]
max_results Input Column

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.

BIGINT
next_token Input Column

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.

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
metric_dimensions

The dimension information returned for requested metric types.

STRUCT(
    "metric" VARCHAR,
    "groups" STRUCT(
        "group" VARCHAR,
        "dimensions" STRUCT(
            "identifier" VARCHAR
        )[]
    )[]
)[]
Show child fields
metric_dimensions[]
Show child fields
metric_dimensions[].groups[]
Show child fields
metric_dimensions[].groups[].dimensions[]
Show child fields
metric_dimensions[].groups[].dimensions[].identifier

The identifier of a dimension.

metric_dimensions[].groups[].group

The name of the dimension group.

metric_dimensions[].metric

The metric type to which the dimension information belongs.