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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves attribute data along with aggregate utilization and savings data for a given time period. This doesn't support granular or grouped data (daily/monthly) in response. You can't retrieve data by dates in a single response similar to GetSavingsPlanUtilization, but you have the option to make multiple calls to GetSavingsPlanUtilizationDetails by providing individual dates. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.

GetSavingsPlanUtilizationDetails internally groups data by SavingsPlansArn.

Synopsis

Creating a Request

data GetSavingsPlansUtilizationDetails Source #

See: newGetSavingsPlansUtilizationDetails smart constructor.

Constructors

GetSavingsPlansUtilizationDetails'

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.
dataType :: Maybe [SavingsPlansDataType]
The data type.
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
```
- ```
REGION
```
- ```
PAYMENT_OPTION
```
- ```
INSTANCE_TYPE_FAMILY
```
GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations, but only AND is supported among each dimension.
maxResults :: Maybe Natural
The number of items to be returned in a response. The default is 20, with a minimum value of 1.
sortBy :: Maybe SortDefinition
The value by which you want to sort the data.
The following values are supported for Key:
- ```
UtilizationPercentage
```
- ```
TotalCommitment
```
- ```
UsedCommitment
```
- ```
UnusedCommitment
```
- ```
NetSavings
```
- ```
AmortizedRecurringCommitment
```
- ```
AmortizedUpfrontCommitment
```
Supported values for SortOrder are ASCENDING or 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

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

newGetSavingsPlansUtilizationDetails Source #

Arguments

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

Create a value of GetSavingsPlansUtilizationDetails 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:nextToken:GetSavingsPlansUtilizationDetails', getSavingsPlansUtilizationDetails_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:dataType:GetSavingsPlansUtilizationDetails', getSavingsPlansUtilizationDetails_dataType - The data type.

$sel:filter':GetSavingsPlansUtilizationDetails', getSavingsPlansUtilizationDetails_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
```
```
REGION
```
```
PAYMENT_OPTION
```
```
INSTANCE_TYPE_FAMILY
```

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

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

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

The following values are supported for Key:

```
UtilizationPercentage
```
```
TotalCommitment
```
```
UsedCommitment
```
```
UnusedCommitment
```
```
NetSavings
```
```
AmortizedRecurringCommitment
```
```
AmortizedUpfrontCommitment
```

Supported values for SortOrder are ASCENDING or DESCENDING.

$sel:timePeriod:GetSavingsPlansUtilizationDetails', getSavingsPlansUtilizationDetails_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

getSavingsPlansUtilizationDetails_nextToken :: Lens' GetSavingsPlansUtilizationDetails (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.

getSavingsPlansUtilizationDetails_dataType :: Lens' GetSavingsPlansUtilizationDetails (Maybe [SavingsPlansDataType]) Source #

The data type.

getSavingsPlansUtilizationDetails_filter :: Lens' GetSavingsPlansUtilizationDetails (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
```
```
REGION
```
```
PAYMENT_OPTION
```
```
INSTANCE_TYPE_FAMILY
```

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

getSavingsPlansUtilizationDetails_maxResults :: Lens' GetSavingsPlansUtilizationDetails (Maybe Natural) Source #

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

getSavingsPlansUtilizationDetails_sortBy :: Lens' GetSavingsPlansUtilizationDetails (Maybe SortDefinition) Source #

The value by which you want to sort the data.

The following values are supported for Key:

```
UtilizationPercentage
```
```
TotalCommitment
```
```
UsedCommitment
```
```
UnusedCommitment
```
```
NetSavings
```
```
AmortizedRecurringCommitment
```
```
AmortizedUpfrontCommitment
```

Supported values for SortOrder are ASCENDING or DESCENDING.

getSavingsPlansUtilizationDetails_timePeriod :: Lens' GetSavingsPlansUtilizationDetails 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 GetSavingsPlansUtilizationDetailsResponse Source #

See: newGetSavingsPlansUtilizationDetailsResponse smart constructor.

Constructors

GetSavingsPlansUtilizationDetailsResponse'

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.
total :: Maybe SavingsPlansUtilizationAggregates
The total Savings Plans utilization, regardless of time period.
httpStatus :: Int
The response's http status code.
savingsPlansUtilizationDetails :: [SavingsPlansUtilizationDetail]
Retrieves a single daily or monthly Savings Plans utilization rate and details for your account.
timePeriod :: DateInterval

Instances

Instances details

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

newGetSavingsPlansUtilizationDetailsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetSavingsPlansUtilizationDetailsResponse'`
-> DateInterval	`$sel:timePeriod:GetSavingsPlansUtilizationDetails'`
-> GetSavingsPlansUtilizationDetailsResponse

Create a value of GetSavingsPlansUtilizationDetailsResponse 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:nextToken:GetSavingsPlansUtilizationDetails', getSavingsPlansUtilizationDetailsResponse_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:total:GetSavingsPlansUtilizationDetailsResponse', getSavingsPlansUtilizationDetailsResponse_total - The total Savings Plans utilization, regardless of time period.

$sel:httpStatus:GetSavingsPlansUtilizationDetailsResponse', getSavingsPlansUtilizationDetailsResponse_httpStatus - The response's http status code.

$sel:savingsPlansUtilizationDetails:GetSavingsPlansUtilizationDetailsResponse', getSavingsPlansUtilizationDetailsResponse_savingsPlansUtilizationDetails - Retrieves a single daily or monthly Savings Plans utilization rate and details for your account.

$sel:timePeriod:GetSavingsPlansUtilizationDetails', getSavingsPlansUtilizationDetailsResponse_timePeriod - Undocumented member.

Response Lenses

getSavingsPlansUtilizationDetailsResponse_nextToken :: Lens' GetSavingsPlansUtilizationDetailsResponse (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.

getSavingsPlansUtilizationDetailsResponse_total :: Lens' GetSavingsPlansUtilizationDetailsResponse (Maybe SavingsPlansUtilizationAggregates) Source #

The total Savings Plans utilization, regardless of time period.

getSavingsPlansUtilizationDetailsResponse_httpStatus :: Lens' GetSavingsPlansUtilizationDetailsResponse Int Source #

The response's http status code.

getSavingsPlansUtilizationDetailsResponse_savingsPlansUtilizationDetails :: Lens' GetSavingsPlansUtilizationDetailsResponse [SavingsPlansUtilizationDetail] Source #

Retrieves a single daily or monthly Savings Plans utilization rate and details for your account.

getSavingsPlansUtilizationDetailsResponse_timePeriod :: Lens' GetSavingsPlansUtilizationDetailsResponse DateInterval Source #

Undocumented member.