Retrieves the reservation coverage for your account, which you can use to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. 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 about reservation usage by the following dimensions:
See https://www.paws-r-sdk.com/docs/costexplorer_get_reservation_coverage/ for full documentation.
costexplorer_get_reservation_coverage(
TimePeriod,
GroupBy = NULL,
Granularity = NULL,
Filter = NULL,
Metrics = NULL,
NextPageToken = NULL,
SortBy = NULL,
MaxResults = NULL
)[required] The start and end dates of the period that you want to retrieve data
about reservation coverage for. You can retrieve data for a maximum of
13 months: the last 12 months and the current month. The start date is
inclusive, but the end date is exclusive. For example, if start is
2017-01-01 and end is 2017-05-01, then the cost and usage data is
retrieved from 2017-01-01 up to and including 2017-04-30 but not
including 2017-05-01.
You can group the data by the following attributes:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
INVOICING_ENTITY
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
TENANCY
The granularity of the Amazon Web Services cost data for the
reservation. Valid values are MONTHLY and DAILY.
If GroupBy is set, Granularity can't be set. If Granularity isn't
set, the response object doesn't include Granularity, either MONTHLY
or DAILY.
The get_reservation_coverage
operation supports only DAILY and MONTHLY granularities.
Filters utilization data by dimensions. You can filter by the following dimensions:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE
TAG
TENANCY
get_reservation_coverage uses
the same
Expression
object as the other operations, but only AND is supported among each
dimension. You can nest only one level deep. If there are multiple
values for a dimension, they are OR'd together.
If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.
Cost category is also supported.
The measurement that you want your reservation coverage reported in.
Valid values are Hour, Unit, and Cost. You can use multiple values
in a request.
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.
The value by which you want to sort the data.
The following values are supported for Key:
OnDemandCost
CoverageHoursPercentage
OnDemandHours
ReservedHours
TotalRunningHours
CoverageNormalizedUnitsPercentage
OnDemandNormalizedUnits
ReservedNormalizedUnits
TotalRunningNormalizedUnits
Time
Supported values for SortOrder are ASCENDING or DESCENDING.
The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.