Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, get_dimension_key_details
retrieves the full text of the dimension db.sql.statement
associated with this ID. This operation is useful because get_resource_metrics
and describe_dimension_keys
don't support retrieval of large SQL statement text.
See https://www.paws-r-sdk.com/docs/pi_get_dimension_key_details/ for full documentation.
pi_get_dimension_key_details(
ServiceType,
Identifier,
Group,
GroupIdentifier,
RequestedDimensions = NULL
)
[required] The Amazon Web Services service for which Performance Insights returns
data. The only valid value is RDS
.
[required] The ID for a data source from which to gather dimension data. This ID
must be immutable and unique within an Amazon Web Services Region. When
a DB instance is the data source, specify its DbiResourceId
value. For
example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X
.
[required] The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are valid:
db.query
(Amazon DocumentDB only)
db.sql
(Amazon RDS and Aurora only)
[required] The ID of the dimension group from which to retrieve dimension details.
For dimension group db.sql
, the group ID is db.sql.id
. The following
group ID values are valid:
db.sql.id
for dimension group db.sql
(Aurora and RDS only)
db.query.id
for dimension group db.query
(DocumentDB only)
A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:
db.sql
- Specify either the full dimension name db.sql.statement
or the short dimension name statement
(Aurora and RDS only).
db.query
- Specify either the full dimension name
db.query.statement
or the short dimension name statement
(DocumentDB only).