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.GetCostCategories

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves an array of Cost Category names and values incurred cost.

If some Cost Category names and values are not associated with any cost, they will not be returned by this API.

Synopsis

data GetCostCategories = GetCostCategories' {
- nextPageToken :: Maybe Text
- searchString :: Maybe Text
- costCategoryName :: Maybe Text
- filter' :: Maybe Expression
- maxResults :: Maybe Natural
- sortBy :: Maybe [SortDefinition]
- timePeriod :: DateInterval
}
newGetCostCategories :: DateInterval -> GetCostCategories
getCostCategories_nextPageToken :: Lens' GetCostCategories (Maybe Text)
getCostCategories_searchString :: Lens' GetCostCategories (Maybe Text)
getCostCategories_costCategoryName :: Lens' GetCostCategories (Maybe Text)
getCostCategories_filter :: Lens' GetCostCategories (Maybe Expression)
getCostCategories_maxResults :: Lens' GetCostCategories (Maybe Natural)
getCostCategories_sortBy :: Lens' GetCostCategories (Maybe [SortDefinition])
getCostCategories_timePeriod :: Lens' GetCostCategories DateInterval
data GetCostCategoriesResponse = GetCostCategoriesResponse' {
- nextPageToken :: Maybe Text
- costCategoryNames :: Maybe [Text]
- costCategoryValues :: Maybe [Text]
- httpStatus :: Int
- returnSize :: Int
- totalSize :: Int
}
newGetCostCategoriesResponse :: Int -> Int -> Int -> GetCostCategoriesResponse
getCostCategoriesResponse_nextPageToken :: Lens' GetCostCategoriesResponse (Maybe Text)
getCostCategoriesResponse_costCategoryNames :: Lens' GetCostCategoriesResponse (Maybe [Text])
getCostCategoriesResponse_costCategoryValues :: Lens' GetCostCategoriesResponse (Maybe [Text])
getCostCategoriesResponse_httpStatus :: Lens' GetCostCategoriesResponse Int
getCostCategoriesResponse_returnSize :: Lens' GetCostCategoriesResponse Int
getCostCategoriesResponse_totalSize :: Lens' GetCostCategoriesResponse Int

Creating a Request

data GetCostCategories Source #

See: newGetCostCategories smart constructor.

Constructors

GetCostCategories'

Fields

nextPageToken :: Maybe Text
If the number of objects that are still available for retrieval exceeds the limit, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the prior call in your next request.
searchString :: Maybe Text
The value that you want to search the filter values for.
If you do not specify a CostCategoryName, SearchString will be used to filter Cost Category names that match the SearchString pattern. If you do specifiy a CostCategoryName, SearchString will be used to filter Cost Category values that match the SearchString pattern.
costCategoryName :: Maybe Text
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 GetCostCategories, 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

Instances

Instances details

Eq GetCostCategories Source #
Instance details Defined in Amazonka.CostExplorer.GetCostCategories Methods (==) :: GetCostCategories -> GetCostCategories -> Bool # (/=) :: GetCostCategories -> GetCostCategories -> Bool #
Read GetCostCategories Source #
Instance details Defined in Amazonka.CostExplorer.GetCostCategories Methods readsPrec :: Int -> ReadS GetCostCategories # readList :: ReadS [GetCostCategories] # readPrec :: ReadPrec GetCostCategories # readListPrec :: ReadPrec [GetCostCategories] #
Show GetCostCategories Source #
Instance details Defined in Amazonka.CostExplorer.GetCostCategories Methods showsPrec :: Int -> GetCostCategories -> ShowS # show :: GetCostCategories -> String # showList :: [GetCostCategories] -> ShowS #
Generic GetCostCategories Source #
Instance details Defined in Amazonka.CostExplorer.GetCostCategories Associated Types type Rep GetCostCategories :: Type -> Type # Methods from :: GetCostCategories -> Rep GetCostCategories x # to :: Rep GetCostCategories x -> GetCostCategories #
NFData GetCostCategories Source #
Instance details Defined in Amazonka.CostExplorer.GetCostCategories Methods rnf :: GetCostCategories -> () #
Hashable GetCostCategories Source #
Instance details Defined in Amazonka.CostExplorer.GetCostCategories Methods hashWithSalt :: Int -> GetCostCategories -> Int # hash :: GetCostCategories -> Int #
ToJSON GetCostCategories Source #
Instance details Defined in Amazonka.CostExplorer.GetCostCategories Methods toJSON :: GetCostCategories -> Value # toEncoding :: GetCostCategories -> Encoding # toJSONList :: [GetCostCategories] -> Value # toEncodingList :: [GetCostCategories] -> Encoding #
AWSRequest GetCostCategories Source #
Instance details Defined in Amazonka.CostExplorer.GetCostCategories Associated Types type AWSResponse GetCostCategories # Methods request :: GetCostCategories -> Request GetCostCategories # response :: MonadResource m => Logger -> Service -> Proxy GetCostCategories -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetCostCategories))) #
ToHeaders GetCostCategories Source #
Instance details Defined in Amazonka.CostExplorer.GetCostCategories Methods toHeaders :: GetCostCategories -> [Header] #
ToPath GetCostCategories Source #
Instance details Defined in Amazonka.CostExplorer.GetCostCategories Methods toPath :: GetCostCategories -> ByteString #
ToQuery GetCostCategories Source #
Instance details Defined in Amazonka.CostExplorer.GetCostCategories Methods toQuery :: GetCostCategories -> QueryString #
type Rep GetCostCategories Source #
Instance details Defined in Amazonka.CostExplorer.GetCostCategories type Rep GetCostCategories = D1 ('MetaData "GetCostCategories" "Amazonka.CostExplorer.GetCostCategories" "libZSservicesZSamazonka-cost-explorerZSamazonka-cost-explorer" 'False) (C1 ('MetaCons "GetCostCategories'" '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 "costCategoryName") '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 GetCostCategories Source #
Instance details Defined in Amazonka.CostExplorer.GetCostCategories type AWSResponse GetCostCategories = GetCostCategoriesResponse

newGetCostCategories Source #

Arguments

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

Create a value of GetCostCategories 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:GetCostCategories', getCostCategories_nextPageToken - If the number of objects that are still available for retrieval exceeds the limit, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the prior call in your next request.

$sel:searchString:GetCostCategories', getCostCategories_searchString - The value that you want to search the filter values for.

If you do not specify a CostCategoryName, SearchString will be used to filter Cost Category names that match the SearchString pattern. If you do specifiy a CostCategoryName, SearchString will be used to filter Cost Category values that match the SearchString pattern.

$sel:costCategoryName:GetCostCategories', getCostCategories_costCategoryName - Undocumented member.

$sel:filter':GetCostCategories', getCostCategories_filter - Undocumented member.

$sel:maxResults:GetCostCategories', getCostCategories_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 GetCostCategories, MaxResults has an upper limit of 1000.

$sel:sortBy:GetCostCategories', getCostCategories_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:GetCostCategories', getCostCategories_timePeriod - Undocumented member.

Request Lenses

getCostCategories_nextPageToken :: Lens' GetCostCategories (Maybe Text) Source #

If the number of objects that are still available for retrieval exceeds the limit, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the prior call in your next request.

getCostCategories_searchString :: Lens' GetCostCategories (Maybe Text) Source #

The value that you want to search the filter values for.

If you do not specify a CostCategoryName, SearchString will be used to filter Cost Category names that match the SearchString pattern. If you do specifiy a CostCategoryName, SearchString will be used to filter Cost Category values that match the SearchString pattern.

getCostCategories_costCategoryName :: Lens' GetCostCategories (Maybe Text) Source #

Undocumented member.

getCostCategories_filter :: Lens' GetCostCategories (Maybe Expression) Source #

Undocumented member.

getCostCategories_maxResults :: Lens' GetCostCategories (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 GetCostCategories, MaxResults has an upper limit of 1000.

getCostCategories_sortBy :: Lens' GetCostCategories (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.

getCostCategories_timePeriod :: Lens' GetCostCategories DateInterval Source #

Undocumented member.

Destructuring the Response

data GetCostCategoriesResponse Source #

See: newGetCostCategoriesResponse smart constructor.

Constructors

GetCostCategoriesResponse'

Fields

nextPageToken :: Maybe Text
If the number of objects that are still available for retrieval exceeds the limit, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
costCategoryNames :: Maybe [Text]
The names of the Cost Categories.
costCategoryValues :: Maybe [Text]
The Cost Category values.
CostCategoryValues are not returned if CostCategoryName is not specified in the request.
httpStatus :: Int
The response's http status code.
returnSize :: Int
The number of objects returned.
totalSize :: Int
The total number of objects.

Instances

Instances details

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

newGetCostCategoriesResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetCostCategoriesResponse'`
-> Int	`$sel:returnSize:GetCostCategoriesResponse'`
-> Int	`$sel:totalSize:GetCostCategoriesResponse'`
-> GetCostCategoriesResponse

Create a value of GetCostCategoriesResponse 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:GetCostCategories', getCostCategoriesResponse_nextPageToken - If the number of objects that are still available for retrieval exceeds the limit, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

$sel:costCategoryNames:GetCostCategoriesResponse', getCostCategoriesResponse_costCategoryNames - The names of the Cost Categories.

$sel:costCategoryValues:GetCostCategoriesResponse', getCostCategoriesResponse_costCategoryValues - The Cost Category values.

CostCategoryValues are not returned if CostCategoryName is not specified in the request.

$sel:httpStatus:GetCostCategoriesResponse', getCostCategoriesResponse_httpStatus - The response's http status code.

$sel:returnSize:GetCostCategoriesResponse', getCostCategoriesResponse_returnSize - The number of objects returned.

$sel:totalSize:GetCostCategoriesResponse', getCostCategoriesResponse_totalSize - The total number of objects.

Response Lenses

getCostCategoriesResponse_nextPageToken :: Lens' GetCostCategoriesResponse (Maybe Text) Source #

If the number of objects that are still available for retrieval exceeds the limit, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

getCostCategoriesResponse_costCategoryNames :: Lens' GetCostCategoriesResponse (Maybe [Text]) Source #

The names of the Cost Categories.

getCostCategoriesResponse_costCategoryValues :: Lens' GetCostCategoriesResponse (Maybe [Text]) Source #

The Cost Category values.

CostCategoryValues are not returned if CostCategoryName is not specified in the request.

getCostCategoriesResponse_httpStatus :: Lens' GetCostCategoriesResponse Int Source #

The response's http status code.

getCostCategoriesResponse_returnSize :: Lens' GetCostCategoriesResponse Int Source #

The number of objects returned.

getCostCategoriesResponse_totalSize :: Lens' GetCostCategoriesResponse Int Source #

The total number of objects.