GetSavingsPlansUtilizationDetails - AWS Cost Explorer Service

GetSavingsPlansUtilizationDetails

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.

Note

GetSavingsPlanUtilizationDetails internally groups data by SavingsPlansArn.

Request Syntax

{ "Filter": { "And": [ "Expression" ], "CostCategories": { "Key": "string", "Values": [ "string" ] }, "Dimensions": { "Key": "string", "Values": [ "string" ] }, "Not": "Expression", "Or": [ "Expression" ], "Tags": { "Key": "string", "Values": [ "string" ] } }, "MaxResults": number, "NextToken": "string", "TimePeriod": { "End": "string", "Start": "string" } }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

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.

Type: Expression object

Required: No

MaxResults

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

Type: Integer

Valid Range: Minimum value of 1.

Required: No

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.

Type: String

Required: No

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.

Type: DateInterval object

Required: Yes

Response Syntax

{ "NextToken": "string", "SavingsPlansUtilizationDetails": [ { "AmortizedCommitment": { "AmortizedRecurringCommitment": "string", "AmortizedUpfrontCommitment": "string", "TotalAmortizedCommitment": "string" }, "Attributes": { "string" : "string" }, "Savings": { "NetSavings": "string", "OnDemandCostEquivalent": "string" }, "SavingsPlanArn": "string", "Utilization": { "TotalCommitment": "string", "UnusedCommitment": "string", "UsedCommitment": "string", "UtilizationPercentage": "string" } } ], "TimePeriod": { "End": "string", "Start": "string" }, "Total": { "AmortizedCommitment": { "AmortizedRecurringCommitment": "string", "AmortizedUpfrontCommitment": "string", "TotalAmortizedCommitment": "string" }, "Savings": { "NetSavings": "string", "OnDemandCostEquivalent": "string" }, "Utilization": { "TotalCommitment": "string", "UnusedCommitment": "string", "UsedCommitment": "string", "UtilizationPercentage": "string" } } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

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.

Type: String

SavingsPlansUtilizationDetails

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

Type: Array of SavingsPlansUtilizationDetail objects

TimePeriod

The time period that you want the usage and costs for.

Type: DateInterval object

Total

The total Savings Plans utilization, regardless of time period.

Type: SavingsPlansUtilizationAggregates object

Errors

For information about the errors that are common to all actions, see Common Errors.

DataUnavailableException

The requested data is unavailable.

HTTP Status Code: 400

InvalidNextTokenException

The pagination token is invalid. Try again without a pagination token.

HTTP Status Code: 400

LimitExceededException

You made too many calls in a short period of time. Try again later.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: