/AWS1/CL_CEX=>GETSAVINGSPLANSCOVERAGE()
¶
About GetSavingsPlansCoverage¶
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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IO_TIMEPERIOD
TYPE REF TO /AWS1/CL_CEXDATEINTERVAL
/AWS1/CL_CEXDATEINTERVAL
¶
The time period that you want the usage and costs for. The
Start
date must be within 13 months. TheEnd
date must be after theStart
date, and before the current date. Future dates can't be used as anEnd
date.
Optional arguments:¶
IT_GROUPBY
TYPE /AWS1/CL_CEXGROUPDEFINITION=>TT_GROUPDEFINITIONS
TT_GROUPDEFINITIONS
¶
You can group the data using the attributes
INSTANCE_FAMILY
,REGION
, orSERVICE
.
IV_GRANULARITY
TYPE /AWS1/CEXGRANULARITY
/AWS1/CEXGRANULARITY
¶
The granularity of the Amazon Web Services cost data for your Savings Plans.
Granularity
can't be set ifGroupBy
is set.The
GetSavingsPlansCoverage
operation supports onlyDAILY
andMONTHLY
granularities.
IO_FILTER
TYPE REF TO /AWS1/CL_CEXEXPRESSION
/AWS1/CL_CEXEXPRESSION
¶
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 onlyAND
is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.Cost category is also supported.
IT_METRICS
TYPE /AWS1/CL_CEXMETRICNAMES_W=>TT_METRICNAMES
TT_METRICNAMES
¶
The measurement that you want your Savings Plans coverage reported in. The only valid value is
SpendCoveredBySavingsPlans
.
IV_NEXTTOKEN
TYPE /AWS1/CEXNEXTPAGETOKEN
/AWS1/CEXNEXTPAGETOKEN
¶
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.
IV_MAXRESULTS
TYPE /AWS1/CEXMAXRESULTS
/AWS1/CEXMAXRESULTS
¶
The number of items to be returned in a response. The default is
20
, with a minimum value of1
.
IO_SORTBY
TYPE REF TO /AWS1/CL_CEXSORTDEFINITION
/AWS1/CL_CEXSORTDEFINITION
¶
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
areASCENDING
andDESCENDING
.