Class: Aws::CostExplorer::Types::GetReservationCoverageRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CostExplorer::Types::GetReservationCoverageRequest
- Defined in:
- gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb
Overview
You can use the following request parameters to query for how much of your instance usage a reservation covered.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#filter ⇒ Types::Expression
Filters utilization data by dimensions.
-
#granularity ⇒ String
The granularity of the Amazon Web Services cost data for the reservation.
-
#group_by ⇒ Array<Types::GroupDefinition>
You can group the data by the following attributes:.
-
#max_results ⇒ Integer
The maximum number of objects that you returned for this request.
-
#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.
-
#sort_by ⇒ Types::SortDefinition
The value by which you want to sort the data.
-
#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.
3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 3570 class GetReservationCoverageRequest < Struct.new( :time_period, :group_by, :granularity, :filter, :metrics, :next_page_token, :sort_by, :max_results) SENSITIVE = [] include Aws::Structure end |
#granularity ⇒ String
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.
3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 3570 class GetReservationCoverageRequest < Struct.new( :time_period, :group_by, :granularity, :filter, :metrics, :next_page_token, :sort_by, :max_results) SENSITIVE = [] include Aws::Structure end |
#group_by ⇒ Array<Types::GroupDefinition>
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
3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 3570 class GetReservationCoverageRequest < Struct.new( :time_period, :group_by, :granularity, :filter, :metrics, :next_page_token, :sort_by, :max_results) SENSITIVE = [] include Aws::Structure end |
#max_results ⇒ Integer
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.
3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 3570 class GetReservationCoverageRequest < Struct.new( :time_period, :group_by, :granularity, :filter, :metrics, :next_page_token, :sort_by, :max_results) SENSITIVE = [] include Aws::Structure end |
#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.
3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 3570 class GetReservationCoverageRequest < Struct.new( :time_period, :group_by, :granularity, :filter, :metrics, :next_page_token, :sort_by, :max_results) SENSITIVE = [] include Aws::Structure end |
#next_page_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.
3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 3570 class GetReservationCoverageRequest < Struct.new( :time_period, :group_by, :granularity, :filter, :metrics, :next_page_token, :sort_by, :max_results) SENSITIVE = [] include Aws::Structure end |
#sort_by ⇒ Types::SortDefinition
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
.
3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 3570 class GetReservationCoverageRequest < Struct.new( :time_period, :group_by, :granularity, :filter, :metrics, :next_page_token, :sort_by, :max_results) SENSITIVE = [] include Aws::Structure end |
#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
.
3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 3570 class GetReservationCoverageRequest < Struct.new( :time_period, :group_by, :granularity, :filter, :metrics, :next_page_token, :sort_by, :max_results) SENSITIVE = [] include Aws::Structure end |