Get Reservation Coverage
costexplorer_get_reservation_coverage | R Documentation |
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¶
Description¶
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:
-
AZ
-
CACHE_ENGINE
-
DATABASE_ENGINE
-
DEPLOYMENT_OPTION
-
INSTANCE_TYPE
-
LINKED_ACCOUNT
-
OPERATING_SYSTEM
-
PLATFORM
-
REGION
-
SERVICE
-
TAG
-
TENANCY
To determine valid values for a dimension, use the
get_dimension_values
operation.
Usage¶
costexplorer_get_reservation_coverage(TimePeriod, GroupBy, Granularity,
Filter, Metrics, NextPageToken, SortBy, MaxResults)
Arguments¶
TimePeriod
[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
is2017-01-01
andend
is2017-05-01
, then the cost and usage data is retrieved from2017-01-01
up to and including2017-04-30
but not including2017-05-01
.GroupBy
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
Granularity
The granularity of the Amazon Web Services cost data for the reservation. Valid values are
MONTHLY
andDAILY
.If
GroupBy
is set,Granularity
can't be set. IfGranularity
isn't set, the response object doesn't includeGranularity
, eitherMONTHLY
orDAILY
.The
get_reservation_coverage
operation supports onlyDAILY
andMONTHLY
granularities.Filter
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 onlyAND
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.
Metrics
The measurement that you want your reservation coverage reported in.
Valid values are
Hour
,Unit
, andCost
. You can use multiple values in a request.NextPageToken
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.
SortBy
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
areASCENDING
orDESCENDING
.MaxResults
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.
Value¶
A list with the following syntax:
list(
CoveragesByTime = list(
list(
TimePeriod = list(
Start = "string",
End = "string"
),
Groups = list(
list(
Attributes = list(
"string"
),
Coverage = list(
CoverageHours = list(
OnDemandHours = "string",
ReservedHours = "string",
TotalRunningHours = "string",
CoverageHoursPercentage = "string"
),
CoverageNormalizedUnits = list(
OnDemandNormalizedUnits = "string",
ReservedNormalizedUnits = "string",
TotalRunningNormalizedUnits = "string",
CoverageNormalizedUnitsPercentage = "string"
),
CoverageCost = list(
OnDemandCost = "string"
)
)
)
),
Total = list(
CoverageHours = list(
OnDemandHours = "string",
ReservedHours = "string",
TotalRunningHours = "string",
CoverageHoursPercentage = "string"
),
CoverageNormalizedUnits = list(
OnDemandNormalizedUnits = "string",
ReservedNormalizedUnits = "string",
TotalRunningNormalizedUnits = "string",
CoverageNormalizedUnitsPercentage = "string"
),
CoverageCost = list(
OnDemandCost = "string"
)
)
)
),
Total = list(
CoverageHours = list(
OnDemandHours = "string",
ReservedHours = "string",
TotalRunningHours = "string",
CoverageHoursPercentage = "string"
),
CoverageNormalizedUnits = list(
OnDemandNormalizedUnits = "string",
ReservedNormalizedUnits = "string",
TotalRunningNormalizedUnits = "string",
CoverageNormalizedUnitsPercentage = "string"
),
CoverageCost = list(
OnDemandCost = "string"
)
),
NextPageToken = "string"
)
Request syntax¶
svc$get_reservation_coverage(
TimePeriod = list(
Start = "string",
End = "string"
),
GroupBy = list(
list(
Type = "DIMENSION"|"TAG"|"COST_CATEGORY",
Key = "string"
)
),
Granularity = "DAILY"|"MONTHLY"|"HOURLY",
Filter = list(
Or = list(
list()
),
And = list(
list()
),
Not = list(),
Dimensions = list(
Key = "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"LINKED_ACCOUNT_NAME"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"SERVICE_CODE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION"|"AGREEMENT_END_DATE_TIME_AFTER"|"AGREEMENT_END_DATE_TIME_BEFORE"|"INVOICING_ENTITY"|"ANOMALY_TOTAL_IMPACT_ABSOLUTE"|"ANOMALY_TOTAL_IMPACT_PERCENTAGE",
Values = list(
"string"
),
MatchOptions = list(
"EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL"
)
),
Tags = list(
Key = "string",
Values = list(
"string"
),
MatchOptions = list(
"EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL"
)
),
CostCategories = list(
Key = "string",
Values = list(
"string"
),
MatchOptions = list(
"EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"|"GREATER_THAN_OR_EQUAL"
)
)
),
Metrics = list(
"string"
),
NextPageToken = "string",
SortBy = list(
Key = "string",
SortOrder = "ASCENDING"|"DESCENDING"
),
MaxResults = 123
)