Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetSavingsPlansUtilization

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.

Note

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

Request Syntax


{
   "Filter": { 
      "And": [ 
         "Expression"
      ],
      "CostCategories": { 
         "Key": "string",
         "MatchOptions": [ "string" ],
         "Values": [ "string" ]
      },
      "Dimensions": { 
         "Key": "string",
         "MatchOptions": [ "string" ],
         "Values": [ "string" ]
      },
      "Not": "Expression",
      "Or": [ 
         "Expression"
      ],
      "Tags": { 
         "Key": "string",
         "MatchOptions": [ "string" ],
         "Values": [ "string" ]
      }
   },
   "Granularity": "string",
   "SortBy": { 
      "Key": "string",
      "SortOrder": "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
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.

Type: Expression object

Required: No

Granularity

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

The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY granularities.

Type: String

Valid Values: DAILY | MONTHLY | HOURLY

Required: No

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.

Type: SortDefinition object

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


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