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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Management account in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.

You can't group by any dimension values for GetSavingsPlansUtilization.

Synopsis

Creating a Request

data GetSavingsPlansUtilization Source #

See: newGetSavingsPlansUtilization smart constructor.

Constructors

GetSavingsPlansUtilization'

Fields

filter' :: Maybe Expression
Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:
- ```
LINKED_ACCOUNT
```
- ```
SAVINGS_PLAN_ARN
```
- ```
SAVINGS_PLANS_TYPE
```
- ```
REGION
```
- ```
PAYMENT_OPTION
```
- ```
INSTANCE_TYPE_FAMILY
```
GetSavingsPlansUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension.
granularity :: Maybe Granularity
The granularity of the Amazon Web Services utillization data for your Savings Plans.
The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY granularities.
sortBy :: Maybe SortDefinition
The value that you want to sort the data by.
The following values are supported for Key:
- ```
UtilizationPercentage
```
- ```
TotalCommitment
```
- ```
UsedCommitment
```
- ```
UnusedCommitment
```
- ```
NetSavings
```
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 GetSavingsPlansUtilization Source #
Instance details Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization Methods toJSON :: GetSavingsPlansUtilization -> Value # toEncoding :: GetSavingsPlansUtilization -> Encoding # toJSONList :: [GetSavingsPlansUtilization] -> Value # toEncodingList :: [GetSavingsPlansUtilization] -> Encoding #
ToHeaders GetSavingsPlansUtilization Source #
Instance details Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization Methods toHeaders :: GetSavingsPlansUtilization -> [Header] #
ToPath GetSavingsPlansUtilization Source #
Instance details Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization Methods toPath :: GetSavingsPlansUtilization -> ByteString #
ToQuery GetSavingsPlansUtilization Source #
Instance details Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization Methods toQuery :: GetSavingsPlansUtilization -> QueryString #
AWSRequest GetSavingsPlansUtilization Source #
Instance details Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization Associated Types type AWSResponse GetSavingsPlansUtilization # Methods request :: (Service -> Service) -> GetSavingsPlansUtilization -> Request GetSavingsPlansUtilization # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetSavingsPlansUtilization -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetSavingsPlansUtilization))) #
Generic GetSavingsPlansUtilization Source #
Instance details Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization Associated Types type Rep GetSavingsPlansUtilization :: Type -> Type # Methods from :: GetSavingsPlansUtilization -> Rep GetSavingsPlansUtilization x # to :: Rep GetSavingsPlansUtilization x -> GetSavingsPlansUtilization #
Read GetSavingsPlansUtilization Source #
Instance details Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization Methods readsPrec :: Int -> ReadS GetSavingsPlansUtilization # readList :: ReadS [GetSavingsPlansUtilization] # readPrec :: ReadPrec GetSavingsPlansUtilization # readListPrec :: ReadPrec [GetSavingsPlansUtilization] #
Show GetSavingsPlansUtilization Source #
Instance details Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization Methods showsPrec :: Int -> GetSavingsPlansUtilization -> ShowS # show :: GetSavingsPlansUtilization -> String # showList :: [GetSavingsPlansUtilization] -> ShowS #
NFData GetSavingsPlansUtilization Source #
Instance details Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization Methods rnf :: GetSavingsPlansUtilization -> () #
Eq GetSavingsPlansUtilization Source #
Instance details Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization Methods (==) :: GetSavingsPlansUtilization -> GetSavingsPlansUtilization -> Bool # (/=) :: GetSavingsPlansUtilization -> GetSavingsPlansUtilization -> Bool #
Hashable GetSavingsPlansUtilization Source #
Instance details Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization Methods hashWithSalt :: Int -> GetSavingsPlansUtilization -> Int # hash :: GetSavingsPlansUtilization -> Int #
type AWSResponse GetSavingsPlansUtilization Source #
Instance details Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization type AWSResponse GetSavingsPlansUtilization = GetSavingsPlansUtilizationResponse
type Rep GetSavingsPlansUtilization Source #
Instance details Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization type Rep GetSavingsPlansUtilization = D1 ('MetaData "GetSavingsPlansUtilization" "Amazonka.CostExplorer.GetSavingsPlansUtilization" "amazonka-cost-explorer-2.0-QqVzyVvst98QYs5s2Ea4h" 'False) (C1 ('MetaCons "GetSavingsPlansUtilization'" '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 "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortDefinition)) :*: S1 ('MetaSel ('Just "timePeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DateInterval))))

newGetSavingsPlansUtilization Source #

Arguments

:: DateInterval	`GetSavingsPlansUtilization`
-> GetSavingsPlansUtilization

Create a value of GetSavingsPlansUtilization 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':GetSavingsPlansUtilization', getSavingsPlansUtilization_filter - Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

```
LINKED_ACCOUNT
```
```
SAVINGS_PLAN_ARN
```
```
SAVINGS_PLANS_TYPE
```
```
REGION
```
```
PAYMENT_OPTION
```
```
INSTANCE_TYPE_FAMILY
```

GetSavingsPlansUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension.

$sel:granularity:GetSavingsPlansUtilization', getSavingsPlansUtilization_granularity - The granularity of the Amazon Web Services utillization data for your Savings Plans.

The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY granularities.

$sel:sortBy:GetSavingsPlansUtilization', getSavingsPlansUtilization_sortBy - The value that you want to sort the data by.

The following values are supported for Key:

```
UtilizationPercentage
```
```
TotalCommitment
```
```
UsedCommitment
```
```
UnusedCommitment
```
```
NetSavings
```

The supported values for SortOrder are ASCENDING and DESCENDING.

GetSavingsPlansUtilization, getSavingsPlansUtilization_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

getSavingsPlansUtilization_filter :: Lens' GetSavingsPlansUtilization (Maybe Expression) Source #

Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

```
LINKED_ACCOUNT
```
```
SAVINGS_PLAN_ARN
```
```
SAVINGS_PLANS_TYPE
```
```
REGION
```
```
PAYMENT_OPTION
```
```
INSTANCE_TYPE_FAMILY
```

GetSavingsPlansUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension.

getSavingsPlansUtilization_granularity :: Lens' GetSavingsPlansUtilization (Maybe Granularity) Source #

The granularity of the Amazon Web Services utillization data for your Savings Plans.

The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY granularities.

getSavingsPlansUtilization_sortBy :: Lens' GetSavingsPlansUtilization (Maybe SortDefinition) Source #

The value that you want to sort the data by.

The following values are supported for Key:

```
UtilizationPercentage
```
```
TotalCommitment
```
```
UsedCommitment
```
```
UnusedCommitment
```
```
NetSavings
```

The supported values for SortOrder are ASCENDING and DESCENDING.

getSavingsPlansUtilization_timePeriod :: Lens' GetSavingsPlansUtilization 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 GetSavingsPlansUtilizationResponse Source #

See: newGetSavingsPlansUtilizationResponse smart constructor.

Constructors

GetSavingsPlansUtilizationResponse'
Fields savingsPlansUtilizationsByTime :: Maybe [SavingsPlansUtilizationByTime] The amount of cost/commitment that you used your Savings Plans. You can use it to specify date ranges. httpStatus :: Int The response's http status code. total :: SavingsPlansUtilizationAggregates The total amount of cost/commitment that you used your Savings Plans, regardless of date ranges.

Instances

Instances details

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

newGetSavingsPlansUtilizationResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetSavingsPlansUtilizationResponse'`
-> SavingsPlansUtilizationAggregates	`GetSavingsPlansUtilizationResponse`
-> GetSavingsPlansUtilizationResponse

Create a value of GetSavingsPlansUtilizationResponse 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:savingsPlansUtilizationsByTime:GetSavingsPlansUtilizationResponse', getSavingsPlansUtilizationResponse_savingsPlansUtilizationsByTime - The amount of cost/commitment that you used your Savings Plans. You can use it to specify date ranges.

$sel:httpStatus:GetSavingsPlansUtilizationResponse', getSavingsPlansUtilizationResponse_httpStatus - The response's http status code.

GetSavingsPlansUtilizationResponse, getSavingsPlansUtilizationResponse_total - The total amount of cost/commitment that you used your Savings Plans, regardless of date ranges.

Response Lenses

getSavingsPlansUtilizationResponse_savingsPlansUtilizationsByTime :: Lens' GetSavingsPlansUtilizationResponse (Maybe [SavingsPlansUtilizationByTime]) Source #

The amount of cost/commitment that you used your Savings Plans. You can use it to specify date ranges.

getSavingsPlansUtilizationResponse_httpStatus :: Lens' GetSavingsPlansUtilizationResponse Int Source #

The response's http status code.

getSavingsPlansUtilizationResponse_total :: Lens' GetSavingsPlansUtilizationResponse SavingsPlansUtilizationAggregates Source #

The total amount of cost/commitment that you used your Savings Plans, regardless of date ranges.