Class: Aws::CostExplorer::Types::GetSavingsPlansUtilizationDetailsRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_typeArray<String>

The data type.

Returns:

  • (Array<String>)


4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
# File 'lib/aws-sdk-costexplorer/types.rb', line 4213

class GetSavingsPlansUtilizationDetailsRequest < Struct.new(
  :time_period,
  :filter,
  :data_type,
  :next_token,
  :max_results,
  :sort_by)
  SENSITIVE = []
  include Aws::Structure
end

#filterTypes::Expression

Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

  • ‘LINKED_ACCOUNT`

  • ‘SAVINGS_PLAN_ARN`

  • ‘REGION`

  • ‘PAYMENT_OPTION`

  • ‘INSTANCE_TYPE_FAMILY`

‘GetSavingsPlansUtilizationDetails` uses the same [Expression] object as the other operations, but only `AND` is supported among each dimension.

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

Returns:



4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
# File 'lib/aws-sdk-costexplorer/types.rb', line 4213

class GetSavingsPlansUtilizationDetailsRequest < Struct.new(
  :time_period,
  :filter,
  :data_type,
  :next_token,
  :max_results,
  :sort_by)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The number of items to be returned in a response. The default is ‘20`, with a minimum value of `1`.

Returns:

  • (Integer)


4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
# File 'lib/aws-sdk-costexplorer/types.rb', line 4213

class GetSavingsPlansUtilizationDetailsRequest < Struct.new(
  :time_period,
  :filter,
  :data_type,
  :next_token,
  :max_results,
  :sort_by)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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.

Returns:

  • (String)


4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
# File 'lib/aws-sdk-costexplorer/types.rb', line 4213

class GetSavingsPlansUtilizationDetailsRequest < Struct.new(
  :time_period,
  :filter,
  :data_type,
  :next_token,
  :max_results,
  :sort_by)
  SENSITIVE = []
  include Aws::Structure
end

#sort_byTypes::SortDefinition

The value that you want to sort the data by.

The following values are supported for ‘Key`:

  • ‘UtilizationPercentage`

  • ‘TotalCommitment`

  • ‘UsedCommitment`

  • ‘UnusedCommitment`

  • ‘NetSavings`

  • ‘AmortizedRecurringCommitment`

  • ‘AmortizedUpfrontCommitment`

The supported values for ‘SortOrder` are `ASCENDING` and `DESCENDING`.



4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
# File 'lib/aws-sdk-costexplorer/types.rb', line 4213

class GetSavingsPlansUtilizationDetailsRequest < Struct.new(
  :time_period,
  :filter,
  :data_type,
  :next_token,
  :max_results,
  :sort_by)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:



4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
# File 'lib/aws-sdk-costexplorer/types.rb', line 4213

class GetSavingsPlansUtilizationDetailsRequest < Struct.new(
  :time_period,
  :filter,
  :data_type,
  :next_token,
  :max_results,
  :sort_by)
  SENSITIVE = []
  include Aws::Structure
end