You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CostExplorer::Types::GetReservationCoverageRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb

Overview

Note:

When making an API call, you may pass GetReservationCoverageRequest data as a hash:

{
  time_period: { # required
    start: "YearMonthDay", # required
    end: "YearMonthDay", # required
  },
  group_by: [
    {
      type: "DIMENSION", # accepts DIMENSION, TAG
      key: "GroupDefinitionKey",
    },
  ],
  granularity: "DAILY", # accepts DAILY, MONTHLY
  filter: {
    or: [
      {
        # recursive Expression
      },
    ],
    and: [
      {
        # recursive Expression
      },
    ],
    not: {
      # recursive Expression
    },
    dimensions: {
      key: "AZ", # accepts AZ, INSTANCE_TYPE, LINKED_ACCOUNT, OPERATION, PURCHASE_TYPE, REGION, SERVICE, 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
      values: ["Value"],
    },
    tags: {
      key: "TagKey",
      values: ["Value"],
    },
  },
  next_page_token: "NextPageToken",
}

You can use the following request parameters to query for how much of your instance usage is covered by a reservation.

Instance Attribute Summary collapse

Instance Attribute Details

#filterTypes::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.

Returns:



972
973
974
975
976
977
978
979
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 972

class GetReservationCoverageRequest < Struct.new(
  :time_period,
  :group_by,
  :granularity,
  :filter,
  :next_page_token)
  include Aws::Structure
end

#granularityString

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.

Returns:

  • (String)


972
973
974
975
976
977
978
979
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 972

class GetReservationCoverageRequest < Struct.new(
  :time_period,
  :group_by,
  :granularity,
  :filter,
  :next_page_token)
  include Aws::Structure
end

#group_byArray<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

  • TAG

  • TENANCY

Returns:



972
973
974
975
976
977
978
979
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 972

class GetReservationCoverageRequest < Struct.new(
  :time_period,
  :group_by,
  :granularity,
  :filter,
  :next_page_token)
  include Aws::Structure
end

#next_page_tokenString

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.

Returns:

  • (String)


972
973
974
975
976
977
978
979
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 972

class GetReservationCoverageRequest < Struct.new(
  :time_period,
  :group_by,
  :granularity,
  :filter,
  :next_page_token)
  include Aws::Structure
end

#time_periodTypes::DateInterval

The start and end dates of the period for which you want to retrieve data about reservation coverage. 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.

Returns:



972
973
974
975
976
977
978
979
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 972

class GetReservationCoverageRequest < Struct.new(
  :time_period,
  :group_by,
  :granularity,
  :filter,
  :next_page_token)
  include Aws::Structure
end