You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CostExplorer::Types::GetReservationUtilizationRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CostExplorer::Types::GetReservationUtilizationRequest
- Defined in:
- (unknown)
Overview
When passing GetReservationUtilizationRequest 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
},
},
next_page_token: "NextPageToken",
}
Instance Attribute Summary collapse
-
#filter ⇒ Types::Expression
Filters utilization data by dimensions.
-
#granularity ⇒ String
If
GroupBy
is set,Granularity
can\'t be set. -
#group_by ⇒ Array<Types::GroupDefinition>
Groups only by
SUBSCRIPTION_ID
. -
#next_page_token ⇒ String
The token to retrieve the next set of results.
-
#time_period ⇒ Types::DateInterval
Sets the start and end dates for retrieving RI utilization.
Instance Attribute Details
#filter ⇒ Types::Expression
Filters utilization data by dimensions. You can filter by the following dimensions:
AZ
CACHE_ENGINE
DEPLOYMENT_OPTION
INSTANCE_TYPE
LINKED_ACCOUNT
OPERATING_SYSTEM
PLATFORM
REGION
SERVICE
SCOPE
TENANCY
GetReservationUtilization
uses the same Expression object as the
other operations, but only AND
is supported among each dimension, and
nesting is supported up to only one level deep. If there are multiple
values for a dimension, they are OR\'d together.
#granularity ⇒ String
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
. If both GroupBy
and Granularity
aren\'t set,
GetReservationUtilization
defaults to DAILY
.
The GetReservationUtilization
operation supports only DAILY
and
MONTHLY
granularities.
Possible values:
- DAILY
- MONTHLY
- HOURLY
#group_by ⇒ Array<Types::GroupDefinition>
Groups only by SUBSCRIPTION_ID
. Metadata is included.
#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
Sets the start and end dates for retrieving RI utilization. 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
.