dimension_keys
Creates, updates, deletes, gets or lists a dimension_keys resource.
Overview
| Name | dimension_keys |
| Type | Resource |
| Id | aws.pi.dimension_keys |
Fields
The following fields are returned by SELECT queries:
- describe_dimension_keys
| Name | Datatype | Description |
|---|---|---|
aligned_end_time | string (date-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. |
aligned_start_time | string (date-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. |
keys | array | The dimension keys that were requested. |
next_token | string | 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. (pattern: <code>^[a-zA-Z0-9_=-]+$</code>) |
partition_keys | array | If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_dimension_keys | select | region | 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_dimension_keys
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.
SELECT
aligned_end_time,
aligned_start_time,
keys,
next_token,
partition_keys
FROM aws.pi.dimension_keys
WHERE region = '{{ region }}' -- required
;