Skip to content

DescribeDimensionKeysResponse

Source code in docs_src/capo_pi/types/describe_dimension_keys_response.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
class DescribeDimensionKeysResponse(TypedDict, closed=True):
    aligned_start_time: NotRequired["capo_pi.types.iso_timestamp.ISOTimestamp"]
    """<p>The start time for the returned dimension keys, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>). <code>AlignedStartTime</code> will be less than or equal to the value of the user-specified <code>StartTime</code>. </p>"""
    aligned_end_time: NotRequired["capo_pi.types.iso_timestamp.ISOTimestamp"]
    """<p>The end time for the returned dimension keys, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>). <code>AlignedEndTime</code> will be greater than or equal to the value of the user-specified <code>Endtime</code>. </p>"""
    partition_keys: NotRequired[
        "capo_pi.types.response_partition_key_list.ResponsePartitionKeyList"
    ]
    """<p>If <code>PartitionBy</code> was present in the request, <code>PartitionKeys</code> contains the breakdown of dimension keys by the specified partitions. </p>"""
    keys: NotRequired[
        "capo_pi.types.dimension_key_description_list.DimensionKeyDescriptionList"
    ]
    """<p>The dimension keys that were requested.</p>"""
    next_token: NotRequired["capo_pi.types.next_token.NextToken"]
    """<p>A pagination token that indicates the response didn’t return all available records because <code>MaxRecords</code> was specified in the previous request. To get the remaining records, specify <code>NextToken</code> in a separate request with this value. </p>"""

aligned_end_time instance-attribute 

aligned_end_time: NotRequired[ISOTimestamp]

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 instance-attribute 

aligned_start_time: NotRequired[ISOTimestamp]

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 instance-attribute 

keys: NotRequired[DimensionKeyDescriptionList]

The dimension keys that were requested.

next_token instance-attribute 

next_token: NotRequired[NextToken]

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.

partition_keys instance-attribute 

partition_keys: NotRequired[ResponsePartitionKeyList]

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