Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Pi.DescribeDimensionKeys

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Synopsis

data DescribeDimensionKeys = DescribeDimensionKeys' {
- additionalMetrics :: Maybe (NonEmpty Text)
- filter' :: Maybe (HashMap Text Text)
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- partitionBy :: Maybe DimensionGroup
- periodInSeconds :: Maybe Int
- serviceType :: ServiceType
- identifier :: Text
- startTime :: POSIX
- endTime :: POSIX
- metric :: Text
- groupBy :: DimensionGroup
}
newDescribeDimensionKeys :: ServiceType -> Text -> UTCTime -> UTCTime -> Text -> DimensionGroup -> DescribeDimensionKeys
describeDimensionKeys_additionalMetrics :: Lens' DescribeDimensionKeys (Maybe (NonEmpty Text))
describeDimensionKeys_filter :: Lens' DescribeDimensionKeys (Maybe (HashMap Text Text))
describeDimensionKeys_maxResults :: Lens' DescribeDimensionKeys (Maybe Natural)
describeDimensionKeys_nextToken :: Lens' DescribeDimensionKeys (Maybe Text)
describeDimensionKeys_partitionBy :: Lens' DescribeDimensionKeys (Maybe DimensionGroup)
describeDimensionKeys_periodInSeconds :: Lens' DescribeDimensionKeys (Maybe Int)
describeDimensionKeys_serviceType :: Lens' DescribeDimensionKeys ServiceType
describeDimensionKeys_identifier :: Lens' DescribeDimensionKeys Text
describeDimensionKeys_startTime :: Lens' DescribeDimensionKeys UTCTime
describeDimensionKeys_endTime :: Lens' DescribeDimensionKeys UTCTime
describeDimensionKeys_metric :: Lens' DescribeDimensionKeys Text
describeDimensionKeys_groupBy :: Lens' DescribeDimensionKeys DimensionGroup
data DescribeDimensionKeysResponse = DescribeDimensionKeysResponse' {
- alignedEndTime :: Maybe POSIX
- alignedStartTime :: Maybe POSIX
- keys :: Maybe [DimensionKeyDescription]
- nextToken :: Maybe Text
- partitionKeys :: Maybe [ResponsePartitionKey]
- httpStatus :: Int
}
newDescribeDimensionKeysResponse :: Int -> DescribeDimensionKeysResponse
describeDimensionKeysResponse_alignedEndTime :: Lens' DescribeDimensionKeysResponse (Maybe UTCTime)
describeDimensionKeysResponse_alignedStartTime :: Lens' DescribeDimensionKeysResponse (Maybe UTCTime)
describeDimensionKeysResponse_keys :: Lens' DescribeDimensionKeysResponse (Maybe [DimensionKeyDescription])
describeDimensionKeysResponse_nextToken :: Lens' DescribeDimensionKeysResponse (Maybe Text)
describeDimensionKeysResponse_partitionKeys :: Lens' DescribeDimensionKeysResponse (Maybe [ResponsePartitionKey])
describeDimensionKeysResponse_httpStatus :: Lens' DescribeDimensionKeysResponse Int

Creating a Request

data DescribeDimensionKeys Source #

See: newDescribeDimensionKeys smart constructor.

Constructors

DescribeDimensionKeys'

Fields

additionalMetrics :: Maybe (NonEmpty Text)
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" }.
filter' :: Maybe (HashMap Text Text)
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.
maxResults :: Maybe Natural
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.
nextToken :: Maybe Text
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.
partitionBy :: Maybe DimensionGroup
For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.
periodInSeconds :: Maybe Int
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.
serviceType :: ServiceType
The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:
- ```
RDS
```
- ```
DOCDB
```
identifier :: Text
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.
startTime :: POSIX
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.
endTime :: POSIX
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.
metric :: Text
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.
groupBy :: DimensionGroup
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.

Instances

Instances details

ToJSON DescribeDimensionKeys Source #
Instance details Defined in Amazonka.Pi.DescribeDimensionKeys Methods toJSON :: DescribeDimensionKeys -> Value # toEncoding :: DescribeDimensionKeys -> Encoding # toJSONList :: [DescribeDimensionKeys] -> Value # toEncodingList :: [DescribeDimensionKeys] -> Encoding #
ToHeaders DescribeDimensionKeys Source #
Instance details Defined in Amazonka.Pi.DescribeDimensionKeys Methods toHeaders :: DescribeDimensionKeys -> [Header] #
ToPath DescribeDimensionKeys Source #
Instance details Defined in Amazonka.Pi.DescribeDimensionKeys Methods toPath :: DescribeDimensionKeys -> ByteString #
ToQuery DescribeDimensionKeys Source #
Instance details Defined in Amazonka.Pi.DescribeDimensionKeys Methods toQuery :: DescribeDimensionKeys -> QueryString #
AWSRequest DescribeDimensionKeys Source #
Instance details Defined in Amazonka.Pi.DescribeDimensionKeys Associated Types type AWSResponse DescribeDimensionKeys # Methods request :: (Service -> Service) -> DescribeDimensionKeys -> Request DescribeDimensionKeys # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDimensionKeys -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDimensionKeys))) #
Generic DescribeDimensionKeys Source #
Instance details Defined in Amazonka.Pi.DescribeDimensionKeys Associated Types type Rep DescribeDimensionKeys :: Type -> Type # Methods from :: DescribeDimensionKeys -> Rep DescribeDimensionKeys x # to :: Rep DescribeDimensionKeys x -> DescribeDimensionKeys #
Read DescribeDimensionKeys Source #
Instance details Defined in Amazonka.Pi.DescribeDimensionKeys Methods readsPrec :: Int -> ReadS DescribeDimensionKeys # readList :: ReadS [DescribeDimensionKeys] # readPrec :: ReadPrec DescribeDimensionKeys # readListPrec :: ReadPrec [DescribeDimensionKeys] #
Show DescribeDimensionKeys Source #
Instance details Defined in Amazonka.Pi.DescribeDimensionKeys Methods showsPrec :: Int -> DescribeDimensionKeys -> ShowS # show :: DescribeDimensionKeys -> String # showList :: [DescribeDimensionKeys] -> ShowS #
NFData DescribeDimensionKeys Source #
Instance details Defined in Amazonka.Pi.DescribeDimensionKeys Methods rnf :: DescribeDimensionKeys -> () #
Eq DescribeDimensionKeys Source #
Instance details Defined in Amazonka.Pi.DescribeDimensionKeys Methods (==) :: DescribeDimensionKeys -> DescribeDimensionKeys -> Bool # (/=) :: DescribeDimensionKeys -> DescribeDimensionKeys -> Bool #
Hashable DescribeDimensionKeys Source #
Instance details Defined in Amazonka.Pi.DescribeDimensionKeys Methods hashWithSalt :: Int -> DescribeDimensionKeys -> Int # hash :: DescribeDimensionKeys -> Int #
type AWSResponse DescribeDimensionKeys Source #
Instance details Defined in Amazonka.Pi.DescribeDimensionKeys type AWSResponse DescribeDimensionKeys = DescribeDimensionKeysResponse
type Rep DescribeDimensionKeys Source #
Instance details Defined in Amazonka.Pi.DescribeDimensionKeys type Rep DescribeDimensionKeys = D1 ('MetaData "DescribeDimensionKeys" "Amazonka.Pi.DescribeDimensionKeys" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'False) (C1 ('MetaCons "DescribeDimensionKeys'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "additionalMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "partitionBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DimensionGroup)) :: S1 ('MetaSel ('Just "periodInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :: ((S1 ('MetaSel ('Just "serviceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ServiceType) :: (S1 ('MetaSel ('Just "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))) :: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: (S1 ('MetaSel ('Just "metric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "groupBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DimensionGroup))))))

newDescribeDimensionKeys Source #

Arguments

:: ServiceType	`$sel:serviceType:DescribeDimensionKeys'`
-> Text	`DescribeDimensionKeys`
-> UTCTime	`$sel:startTime:DescribeDimensionKeys'`
-> UTCTime	`$sel:endTime:DescribeDimensionKeys'`
-> Text	`DescribeDimensionKeys`
-> DimensionGroup	`DescribeDimensionKeys`
-> DescribeDimensionKeys

Create a value of DescribeDimensionKeys with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeDimensionKeys, describeDimensionKeys_additionalMetrics - 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" }.

DescribeDimensionKeys, describeDimensionKeys_filter - 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.

$sel:maxResults:DescribeDimensionKeys', describeDimensionKeys_maxResults - 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.

DescribeDimensionKeys, describeDimensionKeys_nextToken - 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.

$sel:partitionBy:DescribeDimensionKeys', describeDimensionKeys_partitionBy - For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.

$sel:periodInSeconds:DescribeDimensionKeys', describeDimensionKeys_periodInSeconds - 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.

$sel:serviceType:DescribeDimensionKeys', describeDimensionKeys_serviceType - The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:

```
RDS
```
```
DOCDB
```

DescribeDimensionKeys, describeDimensionKeys_identifier - 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.

$sel:startTime:DescribeDimensionKeys', describeDimensionKeys_startTime - 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.

$sel:endTime:DescribeDimensionKeys', describeDimensionKeys_endTime - 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.

DescribeDimensionKeys, describeDimensionKeys_metric - 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.

DescribeDimensionKeys, describeDimensionKeys_groupBy - 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.

Request Lenses

describeDimensionKeys_additionalMetrics :: Lens' DescribeDimensionKeys (Maybe (NonEmpty Text)) Source #

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" }.

describeDimensionKeys_filter :: Lens' DescribeDimensionKeys (Maybe (HashMap Text Text)) Source #

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.

describeDimensionKeys_maxResults :: Lens' DescribeDimensionKeys (Maybe Natural) Source #

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.

describeDimensionKeys_nextToken :: Lens' DescribeDimensionKeys (Maybe Text) Source #

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.

describeDimensionKeys_partitionBy :: Lens' DescribeDimensionKeys (Maybe DimensionGroup) Source #

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

describeDimensionKeys_periodInSeconds :: Lens' DescribeDimensionKeys (Maybe Int) Source #

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.

describeDimensionKeys_serviceType :: Lens' DescribeDimensionKeys ServiceType Source #

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

```
RDS
```
```
DOCDB
```

describeDimensionKeys_identifier :: Lens' DescribeDimensionKeys Text Source #

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.

describeDimensionKeys_startTime :: Lens' DescribeDimensionKeys UTCTime Source #

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.

describeDimensionKeys_endTime :: Lens' DescribeDimensionKeys UTCTime Source #

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.

describeDimensionKeys_metric :: Lens' DescribeDimensionKeys Text Source #

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.

describeDimensionKeys_groupBy :: Lens' DescribeDimensionKeys DimensionGroup Source #

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.

Destructuring the Response

data DescribeDimensionKeysResponse Source #

See: newDescribeDimensionKeysResponse smart constructor.

Constructors

DescribeDimensionKeysResponse'

Fields

alignedEndTime :: Maybe POSIX
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.
alignedStartTime :: Maybe POSIX
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 :: Maybe [DimensionKeyDescription]
The dimension keys that were requested.
nextToken :: Maybe Text
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.
partitionKeys :: Maybe [ResponsePartitionKey]
If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeDimensionKeysResponse Source #
Instance details Defined in Amazonka.Pi.DescribeDimensionKeys Associated Types type Rep DescribeDimensionKeysResponse :: Type -> Type # Methods from :: DescribeDimensionKeysResponse -> Rep DescribeDimensionKeysResponse x # to :: Rep DescribeDimensionKeysResponse x -> DescribeDimensionKeysResponse #
Read DescribeDimensionKeysResponse Source #
Instance details Defined in Amazonka.Pi.DescribeDimensionKeys Methods readsPrec :: Int -> ReadS DescribeDimensionKeysResponse # readList :: ReadS [DescribeDimensionKeysResponse] # readPrec :: ReadPrec DescribeDimensionKeysResponse # readListPrec :: ReadPrec [DescribeDimensionKeysResponse] #
Show DescribeDimensionKeysResponse Source #
Instance details Defined in Amazonka.Pi.DescribeDimensionKeys Methods showsPrec :: Int -> DescribeDimensionKeysResponse -> ShowS # show :: DescribeDimensionKeysResponse -> String # showList :: [DescribeDimensionKeysResponse] -> ShowS #
NFData DescribeDimensionKeysResponse Source #
Instance details Defined in Amazonka.Pi.DescribeDimensionKeys Methods rnf :: DescribeDimensionKeysResponse -> () #
Eq DescribeDimensionKeysResponse Source #
Instance details Defined in Amazonka.Pi.DescribeDimensionKeys Methods (==) :: DescribeDimensionKeysResponse -> DescribeDimensionKeysResponse -> Bool # (/=) :: DescribeDimensionKeysResponse -> DescribeDimensionKeysResponse -> Bool #
type Rep DescribeDimensionKeysResponse Source #
Instance details Defined in Amazonka.Pi.DescribeDimensionKeys type Rep DescribeDimensionKeysResponse = D1 ('MetaData "DescribeDimensionKeysResponse" "Amazonka.Pi.DescribeDimensionKeys" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'False) (C1 ('MetaCons "DescribeDimensionKeysResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "alignedEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "alignedStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "keys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DimensionKeyDescription])))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "partitionKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResponsePartitionKey])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeDimensionKeysResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeDimensionKeysResponse'`
-> DescribeDimensionKeysResponse

Create a value of DescribeDimensionKeysResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:alignedEndTime:DescribeDimensionKeysResponse', describeDimensionKeysResponse_alignedEndTime - 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.

$sel:alignedStartTime:DescribeDimensionKeysResponse', describeDimensionKeysResponse_alignedStartTime - 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.

$sel:keys:DescribeDimensionKeysResponse', describeDimensionKeysResponse_keys - The dimension keys that were requested.

DescribeDimensionKeys, describeDimensionKeysResponse_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.

$sel:partitionKeys:DescribeDimensionKeysResponse', describeDimensionKeysResponse_partitionKeys - If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions.

$sel:httpStatus:DescribeDimensionKeysResponse', describeDimensionKeysResponse_httpStatus - The response's http status code.

Response Lenses

describeDimensionKeysResponse_alignedEndTime :: Lens' DescribeDimensionKeysResponse (Maybe UTCTime) Source #

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.

describeDimensionKeysResponse_alignedStartTime :: Lens' DescribeDimensionKeysResponse (Maybe UTCTime) Source #

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.

describeDimensionKeysResponse_keys :: Lens' DescribeDimensionKeysResponse (Maybe [DimensionKeyDescription]) Source #

The dimension keys that were requested.

describeDimensionKeysResponse_nextToken :: Lens' DescribeDimensionKeysResponse (Maybe Text) Source #

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.

describeDimensionKeysResponse_partitionKeys :: Lens' DescribeDimensionKeysResponse (Maybe [ResponsePartitionKey]) Source #

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

describeDimensionKeysResponse_httpStatus :: Lens' DescribeDimensionKeysResponse Int Source #

The response's http status code.