Skip to content
AWS for Query.Farm

aws.pi.describe_dimension_keys

Example SQL Queries

SELECT * FROM
aws.pi.describe_dimension_keys
WHERE
"service_type" = 'VALUE'
AND "identifier" = 'VALUE'
AND "start_time" = 'VALUE'
AND "end_time" = 'VALUE'
AND "metric" = 'VALUE'
AND "group_by" = 'VALUE';

Description

For a specific time period, retrieve the top N dimension keys for a metric.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

Table Definition

Column NameColumn Data Type
end_time Required Input Column

The date and time specifying the end of the requested time series data. The value specified is exclusive, which means that data points less than (but not equal to) EndTime are returned.

The value for EndTime must be later than the value for StartTime.

TIMESTAMP_S
group_by Required Input Column

A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return a limited number of values for a dimension. 

STRUCT(
    "group" VARCHAR,
    "dimensions" VARCHAR[],
    "limit" BIGINT
)
Show child fields
group_by.dimensions[]
group_by.group

The name of the dimension group. Valid values are as follows:

  • db - The name of the database to which the client is connected. The following values are permitted:

    • Aurora PostgreSQL

    • Amazon RDS PostgreSQL

    • Aurora MySQL

    • Amazon RDS MySQL

    • Amazon RDS MariaDB

    • Amazon DocumentDB

  • db.application - The name of the application that is connected to the database. The following values are permitted:

    • Aurora PostgreSQL

    • Amazon RDS PostgreSQL

    • Amazon DocumentDB

  • db.host - The host name of the connected client (all engines).

  • db.query - The query that is currently running (only Amazon DocumentDB).

  • db.query_tokenized - The digest query (only Amazon DocumentDB).

  • db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL).

  • db.sql - The text of the SQL statement that is currently running (all engines except Amazon DocumentDB).

  • db.sql_tokenized - The SQL digest (all engines except Amazon DocumentDB).

  • db.user - The user logged in to the database (all engines except Amazon DocumentDB).

  • db.wait_event - The event for which the database backend is waiting (all engines except Amazon DocumentDB).

  • db.wait_event_type - The type of event for which the database backend is waiting (all engines except Amazon DocumentDB).

  • db.wait_state - The event for which the database backend is waiting (only Amazon DocumentDB).

group_by.limit

The maximum number of items to fetch for this dimension group.

identifier Required Input Column

An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.

To use an Amazon RDS instance as a data source, you specify its DbiResourceId value. For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A. 

VARCHAR
metric Required Input Column

The name of a Performance Insights metric to be measured.

Valid values for Metric are:

  • db.load.avg - A scaled representation of the number of active sessions for the database engine.

  • db.sampledload.avg - The raw number of active sessions for the database engine.

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only. 

VARCHAR
service_type Required Input Column

The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:

  • RDS

  • DOCDB 

VARCHAR
start_time Required Input Column

The date and time specifying the beginning of the requested time series data. You must specify a StartTime within the past 7 days. The value specified is inclusive, which means that data points equal to or greater than StartTime are returned.

The value for StartTime must be earlier than the value for EndTime. 

TIMESTAMP_S
additional_metrics Input Column

Additional metrics for the top N dimension keys. If the specified dimension group in the GroupBy parameter is db.sql_tokenized, you can specify per-SQL metrics to get the values for the top N SQL digests. The response syntax is as follows: "AdditionalMetrics" : { "string" : "string" }. 

VARCHAR[]
Show child fields
additional_metrics[]
filter Input Column

One or more filters to apply in the request. Restrictions:

  • Any number of filters by the same dimension, as specified in the GroupBy or Partition parameters.

  • A single filter for any other dimension in this dimension group.

The db.sql.db_id filter isn't available for RDS for SQL Server DB instances.

MAP(VARCHAR, VARCHAR)
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

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
partition_by Input Column

For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the partition keys in the response. 

STRUCT(
    "group" VARCHAR,
    "dimensions" VARCHAR[],
    "limit" BIGINT
)
Show child fields
partition_by.dimensions[]
partition_by.group

The name of the dimension group. Valid values are as follows:

  • db - The name of the database to which the client is connected. The following values are permitted:

    • Aurora PostgreSQL

    • Amazon RDS PostgreSQL

    • Aurora MySQL

    • Amazon RDS MySQL

    • Amazon RDS MariaDB

    • Amazon DocumentDB

  • db.application - The name of the application that is connected to the database. The following values are permitted:

    • Aurora PostgreSQL

    • Amazon RDS PostgreSQL

    • Amazon DocumentDB

  • db.host - The host name of the connected client (all engines).

  • db.query - The query that is currently running (only Amazon DocumentDB).

  • db.query_tokenized - The digest query (only Amazon DocumentDB).

  • db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL).

  • db.sql - The text of the SQL statement that is currently running (all engines except Amazon DocumentDB).

  • db.sql_tokenized - The SQL digest (all engines except Amazon DocumentDB).

  • db.user - The user logged in to the database (all engines except Amazon DocumentDB).

  • db.wait_event - The event for which the database backend is waiting (all engines except Amazon DocumentDB).

  • db.wait_event_type - The type of event for which the database backend is waiting (all engines except Amazon DocumentDB).

  • db.wait_state - The event for which the database backend is waiting (only Amazon DocumentDB).

partition_by.limit

The maximum number of items to fetch for this dimension group.

period_in_seconds Input Column

The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:

  • 1 (one second)

  • 60 (one minute)

  • 300 (five minutes)

  • 3600 (one hour)

  • 86400 (twenty-four hours)

If you don't specify PeriodInSeconds, then Performance Insights chooses a value for you, with a goal of returning roughly 100-200 data points in the response. 

BIGINT
_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
aligned_end_time

The end time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the user-specified Endtime. 

TIMESTAMP_S
aligned_start_time

The start time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the user-specified StartTime. 

TIMESTAMP_S
keys

The dimension keys that were requested.

STRUCT(
    "dimensions" MAP(VARCHAR, VARCHAR),
    "total" DOUBLE,
    "additional_metrics" MAP(VARCHAR, DOUBLE),
    "partitions" DOUBLE[]
)[]
Show child fields
keys[]
Show child fields
keys[].additional_metrics

A map that contains the value for each additional metric.

keys[].dimensions

A map of name-value pairs for the dimensions in the group.

keys[].partitions[]
keys[].total

The aggregated metric value for the dimensions, over the requested time range.

partition_keys

If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions. 

STRUCT(
    "dimensions" MAP(VARCHAR, VARCHAR)
)[]
Show child fields
partition_keys[]
Show child fields
partition_keys[].dimensions

A dimension map that contains the dimensions for this partition.