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.
pi_describe_dimension_keys(ServiceType, Identifier, StartTime, EndTime,
Metric, PeriodInSeconds, GroupBy, PartitionBy, Filter, MaxResults,
NextToken)[required] The AWS service for which Performance Insights will return metrics. The
only valid value for ServiceType is RDS.
[required] An immutable, AWS 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
[required] 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.
[required] 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.
[required] 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.
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.
[required] 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.
For each dimension specified in GroupBy, specify a secondary dimension
to further subdivide the partition keys in the response.
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 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.
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.
svc$describe_dimension_keys(
ServiceType = "RDS",
Identifier = "string",
StartTime = as.POSIXct(
"2015-01-01"
),
EndTime = as.POSIXct(
"2015-01-01"
),
Metric = "string",
PeriodInSeconds = 123,
GroupBy = list(
Group = "string",
Dimensions = list(
"string"
),
Limit = 123
),
PartitionBy = list(
Group = "string",
Dimensions = list(
"string"
),
Limit = 123
),
Filter = list(
"string"
),
MaxResults = 123,
NextToken = "string"
)