GetReservationCoverageRequest
import type { GetReservationCoverageRequest } from "https://aws-api.deno.dev/v0.4/services/costexplorer.ts?docs=full";
You can use the following request parameters to query for how much of your instance usage a reservation covered.
§Properties
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
GetReservationCoverage
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 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 GetReservationCoverage
operation supports only DAILY
and MONTHLY
granularities.
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 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.
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 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
.