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 |
Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.
Synopsis
- data GetTags = GetTags' {}
- newGetTags :: DateInterval -> GetTags
- getTags_filter :: Lens' GetTags (Maybe Expression)
- getTags_maxResults :: Lens' GetTags (Maybe Natural)
- getTags_nextPageToken :: Lens' GetTags (Maybe Text)
- getTags_searchString :: Lens' GetTags (Maybe Text)
- getTags_sortBy :: Lens' GetTags (Maybe [SortDefinition])
- getTags_tagKey :: Lens' GetTags (Maybe Text)
- getTags_timePeriod :: Lens' GetTags DateInterval
- data GetTagsResponse = GetTagsResponse' {
- nextPageToken :: Maybe Text
- httpStatus :: Int
- tags :: [Text]
- returnSize :: Int
- totalSize :: Int
- newGetTagsResponse :: Int -> Int -> Int -> GetTagsResponse
- getTagsResponse_nextPageToken :: Lens' GetTagsResponse (Maybe Text)
- getTagsResponse_httpStatus :: Lens' GetTagsResponse Int
- getTagsResponse_tags :: Lens' GetTagsResponse [Text]
- getTagsResponse_returnSize :: Lens' GetTagsResponse Int
- getTagsResponse_totalSize :: Lens' GetTagsResponse Int
Creating a Request
See: newGetTags
smart constructor.
GetTags' | |
|
Instances
Create a value of GetTags
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:filter':GetTags'
, getTags_filter
- Undocumented member.
$sel:maxResults:GetTags'
, getTags_maxResults
- This field is only used when SortBy is provided in the request. The
maximum number of objects that are returned for this request. If
MaxResults isn't specified with SortBy, the request returns 1000
results as the default value for this parameter.
For GetTags
, MaxResults has an upper quota of 1000.
GetTags
, getTags_nextPageToken
- The token to retrieve the next set of results. Amazon Web Services
provides the token when the response from a previous call has more
results than the maximum page size.
$sel:searchString:GetTags'
, getTags_searchString
- The value that you want to search for.
$sel:sortBy:GetTags'
, getTags_sortBy
- The value that you want to sort the data by.
The key represents cost and usage metrics. The following values are supported:
BlendedCost
UnblendedCost
AmortizedCost
NetAmortizedCost
NetUnblendedCost
UsageQuantity
NormalizedUsageAmount
The supported values for SortOrder
are ASCENDING
and DESCENDING
.
When you use SortBy
, NextPageToken
and SearchString
aren't
supported.
GetTags
, getTags_tagKey
- The key of the tag that you want to return values for.
GetTags
, getTags_timePeriod
- The start and end dates for retrieving the dimension values. The start
date is inclusive, but the end date is exclusive. For example, if
start
is 2017-01-01
and end
is 2017-05-01
, then the cost and
usage data is retrieved from 2017-01-01
up to and including
2017-04-30
but not including 2017-05-01
.
Request Lenses
getTags_filter :: Lens' GetTags (Maybe Expression) Source #
Undocumented member.
getTags_maxResults :: Lens' GetTags (Maybe Natural) Source #
This field is only used when SortBy is provided in the request. The maximum number of objects that are returned for this request. If MaxResults isn't specified with SortBy, the request returns 1000 results as the default value for this parameter.
For GetTags
, MaxResults has an upper quota of 1000.
getTags_nextPageToken :: Lens' GetTags (Maybe Text) Source #
The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
getTags_sortBy :: Lens' GetTags (Maybe [SortDefinition]) Source #
The value that you want to sort the data by.
The key represents cost and usage metrics. The following values are supported:
BlendedCost
UnblendedCost
AmortizedCost
NetAmortizedCost
NetUnblendedCost
UsageQuantity
NormalizedUsageAmount
The supported values for SortOrder
are ASCENDING
and DESCENDING
.
When you use SortBy
, NextPageToken
and SearchString
aren't
supported.
getTags_tagKey :: Lens' GetTags (Maybe Text) Source #
The key of the tag that you want to return values for.
getTags_timePeriod :: Lens' GetTags DateInterval Source #
The start and end dates for retrieving the dimension values. The start
date is inclusive, but the end date is exclusive. For example, if
start
is 2017-01-01
and end
is 2017-05-01
, then the cost and
usage data is retrieved from 2017-01-01
up to and including
2017-04-30
but not including 2017-05-01
.
Destructuring the Response
data GetTagsResponse Source #
See: newGetTagsResponse
smart constructor.
GetTagsResponse' | |
|
Instances
:: Int | |
-> Int | |
-> Int | |
-> GetTagsResponse |
Create a value of GetTagsResponse
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:
GetTags
, getTagsResponse_nextPageToken
- The token for the next set of retrievable results. Amazon Web Services
provides the token when the response from a previous call has more
results than the maximum page size.
$sel:httpStatus:GetTagsResponse'
, getTagsResponse_httpStatus
- The response's http status code.
GetTagsResponse
, getTagsResponse_tags
- The tags that match your request.
$sel:returnSize:GetTagsResponse'
, getTagsResponse_returnSize
- The number of query results that Amazon Web Services returns at a time.
$sel:totalSize:GetTagsResponse'
, getTagsResponse_totalSize
- The total number of query results.
Response Lenses
getTagsResponse_nextPageToken :: Lens' GetTagsResponse (Maybe Text) Source #
The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
getTagsResponse_httpStatus :: Lens' GetTagsResponse Int Source #
The response's http status code.
getTagsResponse_tags :: Lens' GetTagsResponse [Text] Source #
The tags that match your request.
getTagsResponse_returnSize :: Lens' GetTagsResponse Int Source #
The number of query results that Amazon Web Services returns at a time.
getTagsResponse_totalSize :: Lens' GetTagsResponse Int Source #
The total number of query results.