You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CostExplorer::Types::GetSavingsPlansCoverageRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CostExplorer::Types::GetSavingsPlansCoverageRequest
- Defined in:
- (unknown)
Overview
When passing GetSavingsPlansCoverageRequest 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_token: "NextPageToken",
max_results: 1,
}
Instance Attribute Summary collapse
-
#filter ⇒ Types::Expression
Filters Savings Plans coverage data by dimensions.
-
#granularity ⇒ String
The granularity of the Amazon Web Services cost data for your Savings Plans.
-
#group_by ⇒ Array<Types::GroupDefinition>
You can group the data using the attributes
INSTANCE_FAMILY
,REGION
, orSERVICE
. -
#max_results ⇒ Integer
The number of items to be returned in a response.
-
#metrics ⇒ Array<String>
The measurement that you want your Savings Plans coverage reported in.
-
#next_token ⇒ String
The token to retrieve the next set of results.
-
#time_period ⇒ Types::DateInterval
The time period that you want the usage and costs for.
Instance Attribute Details
#filter ⇒ Types::Expression
Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:
LINKED_ACCOUNT
REGION
SERVICE
INSTANCE_FAMILY
GetSavingsPlansCoverage
uses the same Expression object as the
other operations, but only AND
is supported among each dimension. If
there are multiple values for a dimension, they are OR\'d together.
Cost category is also supported.
#granularity ⇒ String
The granularity of the Amazon Web Services cost data for your Savings
Plans. Granularity
can\'t be set if GroupBy
is set.
The GetSavingsPlansCoverage
operation supports only DAILY
and
MONTHLY
granularities.
Possible values:
- DAILY
- MONTHLY
- HOURLY
#group_by ⇒ Array<Types::GroupDefinition>
You can group the data using the attributes INSTANCE_FAMILY
, REGION
,
or SERVICE
.
#max_results ⇒ Integer
The number of items to be returned in a response. The default is 20
,
with a minimum value of 1
.
#metrics ⇒ Array<String>
The measurement that you want your Savings Plans coverage reported in.
The only valid value is SpendCoveredBySavingsPlans
.
#next_token ⇒ String
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.
#time_period ⇒ Types::DateInterval
The time period that you want the usage and costs for. The Start
date
must be within 13 months. The End
date must be after the Start
date,
and before the current date. Future dates can\'t be used as an End
date.