Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CostExplorer.GetTags

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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' {
- nextPageToken :: Maybe Text
- searchString :: Maybe Text
- tagKey :: Maybe Text
- filter' :: Maybe Expression
- maxResults :: Maybe Natural
- sortBy :: Maybe [SortDefinition]
- timePeriod :: DateInterval
}
newGetTags :: DateInterval -> GetTags
getTags_nextPageToken :: Lens' GetTags (Maybe Text)
getTags_searchString :: Lens' GetTags (Maybe Text)
getTags_tagKey :: Lens' GetTags (Maybe Text)
getTags_filter :: Lens' GetTags (Maybe Expression)
getTags_maxResults :: Lens' GetTags (Maybe Natural)
getTags_sortBy :: Lens' GetTags (Maybe [SortDefinition])
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

data GetTags Source #

See: newGetTags smart constructor.

Constructors

GetTags'

Fields

nextPageToken :: Maybe Text
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.
searchString :: Maybe Text
The value that you want to search for.
tagKey :: Maybe Text
The key of the tag that you want to return values for.
filter' :: Maybe Expression
maxResults :: Maybe Natural
This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.
For GetTags, MaxResults has an upper limit of 1000.
sortBy :: Maybe [SortDefinition]
The value by which you want to sort the data.
The key represents cost and usage metrics. The following values are supported:
- ```
BlendedCost
```
- ```
UnblendedCost
```
- ```
AmortizedCost
```
- ```
NetAmortizedCost
```
- ```
NetUnblendedCost
```
- ```
UsageQuantity
```
- ```
NormalizedUsageAmount
```
Supported values for SortOrder are ASCENDING or DESCENDING.
When using SortBy, NextPageToken and SearchString are not supported.
timePeriod :: DateInterval
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.

Instances

Instances details

Eq GetTags Source #
Instance details Defined in Amazonka.CostExplorer.GetTags Methods (==) :: GetTags -> GetTags -> Bool # (/=) :: GetTags -> GetTags -> Bool #
Read GetTags Source #
Instance details Defined in Amazonka.CostExplorer.GetTags Methods readsPrec :: Int -> ReadS GetTags # readList :: ReadS [GetTags] # readPrec :: ReadPrec GetTags # readListPrec :: ReadPrec [GetTags] #
Show GetTags Source #
Instance details Defined in Amazonka.CostExplorer.GetTags Methods showsPrec :: Int -> GetTags -> ShowS # show :: GetTags -> String # showList :: [GetTags] -> ShowS #
Generic GetTags Source #
Instance details Defined in Amazonka.CostExplorer.GetTags Associated Types type Rep GetTags :: Type -> Type # Methods from :: GetTags -> Rep GetTags x # to :: Rep GetTags x -> GetTags #
NFData GetTags Source #
Instance details Defined in Amazonka.CostExplorer.GetTags Methods rnf :: GetTags -> () #
Hashable GetTags Source #
Instance details Defined in Amazonka.CostExplorer.GetTags Methods hashWithSalt :: Int -> GetTags -> Int # hash :: GetTags -> Int #
ToJSON GetTags Source #
Instance details Defined in Amazonka.CostExplorer.GetTags Methods toJSON :: GetTags -> Value # toEncoding :: GetTags -> Encoding # toJSONList :: [GetTags] -> Value # toEncodingList :: [GetTags] -> Encoding #
AWSRequest GetTags Source #
Instance details Defined in Amazonka.CostExplorer.GetTags Associated Types type AWSResponse GetTags # Methods request :: GetTags -> Request GetTags # response :: MonadResource m => Logger -> Service -> Proxy GetTags -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetTags))) #
ToHeaders GetTags Source #
Instance details Defined in Amazonka.CostExplorer.GetTags Methods toHeaders :: GetTags -> [Header] #
ToPath GetTags Source #
Instance details Defined in Amazonka.CostExplorer.GetTags Methods toPath :: GetTags -> ByteString #
ToQuery GetTags Source #
Instance details Defined in Amazonka.CostExplorer.GetTags Methods toQuery :: GetTags -> QueryString #
type Rep GetTags Source #
Instance details Defined in Amazonka.CostExplorer.GetTags type Rep GetTags = D1 ('MetaData "GetTags" "Amazonka.CostExplorer.GetTags" "libZSservicesZSamazonka-cost-explorerZSamazonka-cost-explorer" 'False) (C1 ('MetaCons "GetTags'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "searchString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tagKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Expression)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SortDefinition])) :: S1 ('MetaSel ('Just "timePeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DateInterval)))))
type AWSResponse GetTags Source #
Instance details Defined in Amazonka.CostExplorer.GetTags type AWSResponse GetTags = GetTagsResponse

newGetTags Source #

Arguments

:: DateInterval	`$sel:timePeriod:GetTags'`
-> GetTags

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:nextPageToken: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:tagKey:GetTags', getTags_tagKey - The key of the tag that you want to return values for.

$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 to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

For GetTags, MaxResults has an upper limit of 1000.

$sel:sortBy:GetTags', getTags_sortBy - The value by which you want to sort the data.

The key represents cost and usage metrics. The following values are supported:

```
BlendedCost
```
```
UnblendedCost
```
```
AmortizedCost
```
```
NetAmortizedCost
```
```
NetUnblendedCost
```
```
UsageQuantity
```
```
NormalizedUsageAmount
```

Supported values for SortOrder are ASCENDING or DESCENDING.

When using SortBy, NextPageToken and SearchString are not supported.

$sel:timePeriod: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_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_searchString :: Lens' GetTags (Maybe Text) Source #

The value that you want to search for.

getTags_tagKey :: Lens' GetTags (Maybe Text) Source #

The key of the tag that you want to return values for.

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 to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

For GetTags, MaxResults has an upper limit of 1000.

getTags_sortBy :: Lens' GetTags (Maybe [SortDefinition]) Source #

The value by which you want to sort the data.

The key represents cost and usage metrics. The following values are supported:

```
BlendedCost
```
```
UnblendedCost
```
```
AmortizedCost
```
```
NetAmortizedCost
```
```
NetUnblendedCost
```
```
UsageQuantity
```
```
NormalizedUsageAmount
```

Supported values for SortOrder are ASCENDING or DESCENDING.

When using SortBy, NextPageToken and SearchString are not supported.

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.

Constructors

GetTagsResponse'

Fields

nextPageToken :: Maybe Text
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.
httpStatus :: Int
The response's http status code.
tags :: [Text]
The tags that match your request.
returnSize :: Int
The number of query results that Amazon Web Services returns at a time.
totalSize :: Int
The total number of query results.

Instances

Instances details

Eq GetTagsResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetTags Methods (==) :: GetTagsResponse -> GetTagsResponse -> Bool # (/=) :: GetTagsResponse -> GetTagsResponse -> Bool #
Read GetTagsResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetTags Methods readsPrec :: Int -> ReadS GetTagsResponse # readList :: ReadS [GetTagsResponse] # readPrec :: ReadPrec GetTagsResponse # readListPrec :: ReadPrec [GetTagsResponse] #
Show GetTagsResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetTags Methods showsPrec :: Int -> GetTagsResponse -> ShowS # show :: GetTagsResponse -> String # showList :: [GetTagsResponse] -> ShowS #
Generic GetTagsResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetTags Associated Types type Rep GetTagsResponse :: Type -> Type # Methods from :: GetTagsResponse -> Rep GetTagsResponse x # to :: Rep GetTagsResponse x -> GetTagsResponse #
NFData GetTagsResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetTags Methods rnf :: GetTagsResponse -> () #
type Rep GetTagsResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetTags type Rep GetTagsResponse = D1 ('MetaData "GetTagsResponse" "Amazonka.CostExplorer.GetTags" "libZSservicesZSamazonka-cost-explorerZSamazonka-cost-explorer" 'False) (C1 ('MetaCons "GetTagsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :: (S1 ('MetaSel ('Just "returnSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "totalSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetTagsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetTagsResponse'`
-> Int	`$sel:returnSize:GetTagsResponse'`
-> Int	`$sel:totalSize:GetTagsResponse'`
-> 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:

$sel:nextPageToken: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.

$sel:tags: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.