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

Class: Aws::CostExplorer::Types::GetReservationUtilizationRequest

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 GetReservationUtilizationRequest 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",
}

Instance Attribute Summary collapse

Instance Attribute Details

#filterTypes::Expression

Filters utilization data by using different dimensions. 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.

Returns:



866
867
868
869
870
871
872
873
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 866

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

#granularityString

If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include the Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.

Returns:

  • (String)


866
867
868
869
870
871
872
873
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 866

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

#group_byArray<Types::GroupDefinition>

Groups only by SUBSCRIPTION_ID. Metadata is included.

Returns:



866
867
868
869
870
871
872
873
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 866

class GetReservationUtilizationRequest < 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)


866
867
868
869
870
871
872
873
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 866

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

#time_periodTypes::DateInterval

Sets the start and end dates for retrieving reserve instance (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.

Returns:



866
867
868
869
870
871
872
873
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 866

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