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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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, 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, AGREEMENT_END_DATE_TIME_AFTER, AGREEMENT_END_DATE_TIME_BEFORE
      values: ["Value"],
      match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
    },
    tags: {
      key: "TagKey",
      values: ["Value"],
      match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
    },
    cost_categories: {
      key: "CostCategoryName",
      values: ["Value"],
      match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
    },
  },
  sort_by: {
    key: "SortDefinitionKey", # required
    sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  },
  next_page_token: "NextPageToken",
  max_results: 1,
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

[1]: docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html

Returns:



3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 3729

class GetReservationUtilizationRequest < Struct.new(
  :time_period,
  :group_by,
  :granularity,
  :filter,
  :sort_by,
  :next_page_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String) 


3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 3729

class GetReservationUtilizationRequest < Struct.new(
  :time_period,
  :group_by,
  :granularity,
  :filter,
  :sort_by,
  :next_page_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#group_by ⇒ Array<Types::GroupDefinition>

Groups only by ‘SUBSCRIPTION_ID`. Metadata is included.

Returns:



3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 3729

class GetReservationUtilizationRequest < Struct.new(
  :time_period,
  :group_by,
  :granularity,
  :filter,
  :sort_by,
  :next_page_token,
  :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, AWS provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

Returns:

  • (Integer) 


3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 3729

class GetReservationUtilizationRequest < Struct.new(
  :time_period,
  :group_by,
  :granularity,
  :filter,
  :sort_by,
  :next_page_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String) 


3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 3729

class GetReservationUtilizationRequest < Struct.new(
  :time_period,
  :group_by,
  :granularity,
  :filter,
  :sort_by,
  :next_page_token,
  :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`:

  • ‘UtilizationPercentage`

  • ‘UtilizationPercentageInUnits`

  • ‘PurchasedHours`

  • ‘PurchasedUnits`

  • ‘TotalActualHours`

  • ‘TotalActualUnits`

  • ‘UnusedHours`

  • ‘UnusedUnits`

  • ‘OnDemandCostOfRIHoursUsed`

  • ‘NetRISavings`

  • ‘TotalPotentialRISavings`

  • ‘AmortizedUpfrontFee`

  • ‘AmortizedRecurringFee`

  • ‘TotalAmortizedFee`

  • ‘RICostForUnusedHours`

  • ‘RealizedSavings`

  • ‘UnrealizedSavings`

Supported values for ‘SortOrder` are `ASCENDING` or `DESCENDING`.

Returns:



3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 3729

class GetReservationUtilizationRequest < Struct.new(
  :time_period,
  :group_by,
  :granularity,
  :filter,
  :sort_by,
  :next_page_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#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`.

Returns:



3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 3729

class GetReservationUtilizationRequest < Struct.new(
  :time_period,
  :group_by,
  :granularity,
  :filter,
  :sort_by,
  :next_page_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end