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

Inherits:

Struct

• Object
• Struct
• Aws::CostExplorer::Types::GetSavingsPlansUtilizationDetailsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-costexplorer/types.rb

Overview

Note:

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

{
  time_period: { # required
    start: "YearMonthDay", # required
    end: "YearMonthDay", # required
  },
  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
    },
  },
  data_type: ["ATTRIBUTES"], # accepts ATTRIBUTES, UTILIZATION, AMORTIZED_COMMITMENT, SAVINGS
  next_token: "NextPageToken",
  max_results: 1,
  sort_by: {
    key: "SortDefinitionKey", # required
    sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  },
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #data_type ⇒ Array<String>

  The data type.

• #filter ⇒ Types::Expression

  Filters Savings Plans utilization coverage data for active Savings Plans dimensions.

• #max_results ⇒ Integer

  The number of items to be returned in a response.

• #next_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 time period that you want the usage and costs for.

Instance Attribute Details

#data_type ⇒ Array<String>

The data type.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-costexplorer/types.rb', line 4356

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

#filter ⇒ Types::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:

• (Types::Expression)

# File 'lib/aws-sdk-costexplorer/types.rb', line 4356

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

#max_results ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-costexplorer/types.rb', line 4356

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

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

Returns:

• (String)

# File 'lib/aws-sdk-costexplorer/types.rb', line 4356

class GetSavingsPlansUtilizationDetailsRequest < Struct.new(
  :time_period,
  :filter,
  :data_type,
  :next_token,
  :max_results,
  :sort_by)
  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`

• ‘TotalCommitment`

• ‘UsedCommitment`

• ‘UnusedCommitment`

• ‘NetSavings`

• ‘AmortizedRecurringCommitment`

• ‘AmortizedUpfrontCommitment`

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

Returns:

• (Types::SortDefinition)

# File 'lib/aws-sdk-costexplorer/types.rb', line 4356

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

#time_period ⇒ Types::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:

• (Types::DateInterval)

# File 'lib/aws-sdk-costexplorer/types.rb', line 4356

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