You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CostExplorer::Types::GetReservationCoverageRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CostExplorer::Types::GetReservationCoverageRequest
- Defined in:
- (unknown)
Overview
When passing GetReservationCoverageRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
time_period: { # required
start: "YearMonthDay", # required
end: "YearMonthDay", # required
},
group_by: [
{
type: "DIMENSION", # accepts DIMENSION, TAG, COST_CATEGORY
key: "GroupDefinitionKey",
},
],
granularity: "DAILY", # accepts DAILY, MONTHLY, HOURLY
filter: {
or: [
{
# recursive Expression
},
],
and: [
{
# recursive Expression
},
],
not: {
# recursive Expression
},
dimensions: {
key: "AZ", # accepts 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
values: ["Value"],
match_options: ["EQUALS"], # accepts EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
},
tags: {
key: "TagKey",
values: ["Value"],
match_options: ["EQUALS"], # accepts EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
},
cost_categories: {
key: "CostCategoryName",
values: ["Value"],
match_options: ["EQUALS"], # accepts EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
},
},
metrics: ["MetricName"],
next_page_token: "NextPageToken",
}
You can use the following request parameters to query for how much of your instance usage a reservation covered.
Instance Attribute Summary collapse
-
#filter ⇒ Types::Expression
Filters utilization data by dimensions.
-
#granularity ⇒ String
The granularity of the AWS cost data for the reservation.
-
#group_by ⇒ Array<Types::GroupDefinition>
You can group the data by the following attributes:.
-
#metrics ⇒ Array<String>
The measurement that you want your reservation coverage reported in.
-
#next_page_token ⇒ String
The token to retrieve the next set of results.
-
#time_period ⇒ Types::DateInterval
The start and end dates of the period that you want to retrieve data about reservation coverage for.
Instance Attribute Details
#filter ⇒ Types::Expression
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.
#granularity ⇒ String
The granularity of the AWS 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.
Possible values:
- DAILY
- MONTHLY
- HOURLY
#group_by ⇒ Array<Types::GroupDefinition>
You can group the data by the following attributes:
AZ
CACHE_ENGINE
DATABASE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
TENANCY
#metrics ⇒ Array<String>
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.
#next_page_token ⇒ String
The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
#time_period ⇒ Types::DateInterval
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
.