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.CostExplorer.GetSavingsPlansCoverage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the Savings Plans covered for your account. This enables you to see how much of your cost is covered by a Savings Plan. An organization’s management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data for Savings Plans usage with the following dimensions:

```
LINKED_ACCOUNT
```
```
REGION
```
```
SERVICE
```
```
INSTANCE_FAMILY
```

To determine valid values for a dimension, use the GetDimensionValues operation.

Synopsis

Creating a Request

data GetSavingsPlansCoverage Source #

See: newGetSavingsPlansCoverage smart constructor.

Constructors

GetSavingsPlansCoverage'

Fields

filter' :: Maybe Expression
Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:
- ```
LINKED_ACCOUNT
```
- ```
REGION
```
- ```
SERVICE
```
- ```
INSTANCE_FAMILY
```
GetSavingsPlansCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.
Cost category is also supported.
granularity :: Maybe Granularity
The granularity of the Amazon Web Services cost data for your Savings Plans. Granularity can't be set if GroupBy is set.
The GetSavingsPlansCoverage operation supports only DAILY and MONTHLY granularities.
groupBy :: Maybe [GroupDefinition]
You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.
maxResults :: Maybe Natural
The number of items to be returned in a response. The default is 20, with a minimum value of 1.
metrics :: Maybe [Text]
The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.
nextToken :: 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.
sortBy :: Maybe SortDefinition
The value that you want to sort the data by.
The following values are supported for Key:
- ```
SpendCoveredBySavingsPlan
```
- ```
OnDemandCost
```
- ```
CoveragePercentage
```
- ```
TotalCost
```
- ```
InstanceFamily
```
- ```
Region
```
- ```
Service
```
The supported values for SortOrder are ASCENDING and DESCENDING.
timePeriod :: DateInterval
The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

Instances

Instances details

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

newGetSavingsPlansCoverage Source #

Arguments

:: DateInterval	`GetSavingsPlansCoverage`
-> GetSavingsPlansCoverage

Create a value of GetSavingsPlansCoverage 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':GetSavingsPlansCoverage', getSavingsPlansCoverage_filter - Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:

```
LINKED_ACCOUNT
```
```
REGION
```
```
SERVICE
```
```
INSTANCE_FAMILY
```

GetSavingsPlansCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.

Cost category is also supported.

$sel:granularity:GetSavingsPlansCoverage', getSavingsPlansCoverage_granularity - The granularity of the Amazon Web Services cost data for your Savings Plans. Granularity can't be set if GroupBy is set.

The GetSavingsPlansCoverage operation supports only DAILY and MONTHLY granularities.

$sel:groupBy:GetSavingsPlansCoverage', getSavingsPlansCoverage_groupBy - You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.

$sel:maxResults:GetSavingsPlansCoverage', getSavingsPlansCoverage_maxResults - The number of items to be returned in a response. The default is 20, with a minimum value of 1.

GetSavingsPlansCoverage, getSavingsPlansCoverage_metrics - The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.

GetSavingsPlansCoverage, getSavingsPlansCoverage_nextToken - 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:sortBy:GetSavingsPlansCoverage', getSavingsPlansCoverage_sortBy - The value that you want to sort the data by.

The following values are supported for Key:

```
SpendCoveredBySavingsPlan
```
```
OnDemandCost
```
```
CoveragePercentage
```
```
TotalCost
```
```
InstanceFamily
```
```
Region
```
```
Service
```

The supported values for SortOrder are ASCENDING and DESCENDING.

GetSavingsPlansCoverage, getSavingsPlansCoverage_timePeriod - The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

Request Lenses

getSavingsPlansCoverage_filter :: Lens' GetSavingsPlansCoverage (Maybe Expression) Source #

Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:

```
LINKED_ACCOUNT
```
```
REGION
```
```
SERVICE
```
```
INSTANCE_FAMILY
```

GetSavingsPlansCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.

Cost category is also supported.

getSavingsPlansCoverage_granularity :: Lens' GetSavingsPlansCoverage (Maybe Granularity) Source #

The granularity of the Amazon Web Services cost data for your Savings Plans. Granularity can't be set if GroupBy is set.

The GetSavingsPlansCoverage operation supports only DAILY and MONTHLY granularities.

getSavingsPlansCoverage_groupBy :: Lens' GetSavingsPlansCoverage (Maybe [GroupDefinition]) Source #

You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.

getSavingsPlansCoverage_maxResults :: Lens' GetSavingsPlansCoverage (Maybe Natural) Source #

The number of items to be returned in a response. The default is 20, with a minimum value of 1.

getSavingsPlansCoverage_metrics :: Lens' GetSavingsPlansCoverage (Maybe [Text]) Source #

The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.

getSavingsPlansCoverage_nextToken :: Lens' GetSavingsPlansCoverage (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.

getSavingsPlansCoverage_sortBy :: Lens' GetSavingsPlansCoverage (Maybe SortDefinition) Source #

The value that you want to sort the data by.

The following values are supported for Key:

```
SpendCoveredBySavingsPlan
```
```
OnDemandCost
```
```
CoveragePercentage
```
```
TotalCost
```
```
InstanceFamily
```
```
Region
```
```
Service
```

The supported values for SortOrder are ASCENDING and DESCENDING.

getSavingsPlansCoverage_timePeriod :: Lens' GetSavingsPlansCoverage DateInterval Source #

The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

Destructuring the Response

data GetSavingsPlansCoverageResponse Source #

See: newGetSavingsPlansCoverageResponse smart constructor.

Constructors

GetSavingsPlansCoverageResponse'
Fields nextToken :: 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. httpStatus :: Int The response's http status code. savingsPlansCoverages :: [SavingsPlansCoverage] The amount of spend that your Savings Plans covered.

Instances

Instances details

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

newGetSavingsPlansCoverageResponse Source #

Arguments

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

Create a value of GetSavingsPlansCoverageResponse 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:

GetSavingsPlansCoverage, getSavingsPlansCoverageResponse_nextToken - 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:httpStatus:GetSavingsPlansCoverageResponse', getSavingsPlansCoverageResponse_httpStatus - The response's http status code.

$sel:savingsPlansCoverages:GetSavingsPlansCoverageResponse', getSavingsPlansCoverageResponse_savingsPlansCoverages - The amount of spend that your Savings Plans covered.

Response Lenses

getSavingsPlansCoverageResponse_nextToken :: Lens' GetSavingsPlansCoverageResponse (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.

getSavingsPlansCoverageResponse_httpStatus :: Lens' GetSavingsPlansCoverageResponse Int Source #

The response's http status code.

getSavingsPlansCoverageResponse_savingsPlansCoverages :: Lens' GetSavingsPlansCoverageResponse [SavingsPlansCoverage] Source #

The amount of spend that your Savings Plans covered.