Class: Aws::CostExplorer::Types::GetDimensionValuesRequest

Inherits:

Struct

Object
Struct
Aws::CostExplorer::Types::GetDimensionValuesRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-costexplorer/types.rb

Overview

Note:

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

{
  search_string: "SearchString",
  time_period: { # required
    start: "YearMonthDay", # required
    end: "YearMonthDay", # required
  },
  dimension: "AZ", # required, 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
  context: "COST_AND_USAGE", # accepts COST_AND_USAGE, RESERVATIONS, SAVINGS_PLANS
  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
    },
  ],
  max_results: 1,
  next_page_token: "NextPageToken",
}

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#context ⇒ String

The context for the call to ‘GetDimensionValues`.
#dimension ⇒ String

The name of the dimension.
#filter ⇒ Types::Expression

Use ‘Expression` to filter by cost or by usage.
#max_results ⇒ Integer

This field is only used when SortBy is provided in the request.
#next_page_token ⇒ String

The token to retrieve the next set of results.
#search_string ⇒ String

The value that you want to search the filter values for.
#sort_by ⇒ Array<Types::SortDefinition>

The value by which you want to sort the data.
#time_period ⇒ Types::DateInterval

The start and end dates for retrieving the dimension values.

Instance Attribute Details

#context ⇒ `String`

The context for the call to ‘GetDimensionValues`. This can be `RESERVATIONS` or `COST_AND_USAGE`. The default value is `COST_AND_USAGE`. If the context is set to `RESERVATIONS`, the resulting dimension values can be used in the `GetReservationUtilization` operation. If the context is set to `COST_AND_USAGE`, the resulting dimension values can be used in the `GetCostAndUsage` operation.

If you set the context to ‘COST_AND_USAGE`, you can use the following dimensions for searching:

AZ - The Availability Zone. An example is ‘us-east-1a`.
DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
INSTANCE_TYPE - The type of Amazon EC2 instance. An example is ‘m4.xlarge`.
LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.
OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
OPERATION - The action performed. Examples include ‘RunInstance` and `CreateBucket`.
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.
SERVICE - The AWS service such as Amazon DynamoDB.
USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the ‘GetDimensionValues` operation includes a unit attribute. Examples include GB and Hrs.
USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
REGION - The AWS Region.
RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.

If you set the context to ‘RESERVATIONS`, you can use the following dimensions for searching:

AZ - The Availability Zone. An example is ‘us-east-1a`.
CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are ‘SingleAZ` and `MultiAZ`.
INSTANCE_TYPE - The type of Amazon EC2 instance. An example is ‘m4.xlarge`.
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
REGION - The AWS Region.
SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
TENANCY - The tenancy of a resource. Examples are shared or dedicated.

If you set the context to ‘SAVINGS_PLANS`, you can use the following dimensions for searching:

SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)
REGION - The AWS Region.
INSTANCE_TYPE_FAMILY - The family of instances (For example, ‘m5`)
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.
SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan

Returns:

(String)

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

class GetDimensionValuesRequest < Struct.new(
  :search_string,
  :time_period,
  :dimension,
  :context,
  :filter,
  :sort_by,
  :max_results,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

#dimension ⇒ `String`

The name of the dimension. Each ‘Dimension` is available for a different `Context`. For more information, see `Context`.

Returns:

(String)

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

class GetDimensionValuesRequest < Struct.new(
  :search_string,
  :time_period,
  :dimension,
  :context,
  :filter,
  :sort_by,
  :max_results,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

#filter ⇒ `Types::Expression`

Use ‘Expression` to filter by cost or by usage. There are two patterns:

Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for ‘REGION==us-east-1 OR REGION==us-west-1`. For `GetRightsizingRecommendation`, the Region is a full name (for example, `REGION==US East (N. Virginia)`. The `Expression` example looks like:

‘{ “Dimensions”: { “Key”: “REGION”, “Values”: [ “us-east-1”, “us-west-1” ] } }`

The list of dimension values are OR’d together to retrieve cost or usage data. You can create ‘Expression` and `DimensionValues` objects using either `with*` methods or `set*` methods in multiple lines.
Compound dimension values with logical operations - You can use multiple ‘Expression` types and the logical operators `AND/OR/NOT` to create a list of one or more `Expression` objects. This allows you to filter on more advanced options. For example, you can filter on `((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)`. The `Expression` for that looks like this:

‘{ “And”: [ [ {“Dimensions”: { “Key”: “REGION”, “Values”: [ “us-east-1”, “us-west-1” ] }, {“Tags”: { “Key”: “TagName”, “Values”: [“Value1”] } } ]}, {“Dimensions”: { “Key”: “USAGE_TYPE”, “Values”: [“DataTransfer”] }} ] } `

<note markdown=“1”> Because each ‘Expression` can have only one operator, the service returns an error if more than one is specified. The following example shows an `Expression` object that creates an error.
```
</note>
```
‘ { “And”: [ … ], “DimensionValues”: { “Dimension”: “USAGE_TYPE”, “Values”: [ “DataTransfer” ] } } `

<note markdown=“1”> For the ‘GetRightsizingRecommendation` action, a combination of OR and NOT is not supported. OR is not supported between different dimensions, or dimensions and tags. NOT operators aren’t supported. Dimensions are also limited to ‘LINKED_ACCOUNT`, `REGION`, or `RIGHTSIZING_TYPE`.

For the `GetReservationPurchaseRecommendation` action, only NOT is

supported. AND and OR are not supported. Dimensions are limited to ‘LINKED_ACCOUNT`.

</note>

Returns:

(Types::Expression)

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

class GetDimensionValuesRequest < Struct.new(
  :search_string,
  :time_period,
  :dimension,
  :context,
  :filter,
  :sort_by,
  :max_results,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ `Integer`

This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

For ‘GetDimensionValues`, MaxResults has an upper limit of 1000.

Returns:

(Integer)

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

class GetDimensionValuesRequest < Struct.new(
  :search_string,
  :time_period,
  :dimension,
  :context,
  :filter,
  :sort_by,
  :max_results,
  :next_page_token)
  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)

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

class GetDimensionValuesRequest < Struct.new(
  :search_string,
  :time_period,
  :dimension,
  :context,
  :filter,
  :sort_by,
  :max_results,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

#search_string ⇒ `String`

The value that you want to search the filter values for.

Returns:

(String)

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

class GetDimensionValuesRequest < Struct.new(
  :search_string,
  :time_period,
  :dimension,
  :context,
  :filter,
  :sort_by,
  :max_results,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

#sort_by ⇒ `Array<Types::SortDefinition>`

The value by which you want to sort the data.

The key represents cost and usage metrics. The following values are supported:

‘BlendedCost`
‘UnblendedCost`
‘AmortizedCost`
‘NetAmortizedCost`
‘NetUnblendedCost`
‘UsageQuantity`
‘NormalizedUsageAmount`

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

When you specify a ‘SortBy` paramater, the context must be `COST_AND_USAGE`. Further, when using `SortBy`, `NextPageToken` and `SearchString` are not supported.

Returns:

(Array<Types::SortDefinition>)

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

class GetDimensionValuesRequest < Struct.new(
  :search_string,
  :time_period,
  :dimension,
  :context,
  :filter,
  :sort_by,
  :max_results,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

#time_period ⇒ `Types::DateInterval`

The start and end dates for retrieving the dimension values. 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:

(Types::DateInterval)

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

class GetDimensionValuesRequest < Struct.new(
  :search_string,
  :time_period,
  :dimension,
  :context,
  :filter,
  :sort_by,
  :max_results,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::CostExplorer::Types::GetDimensionValuesRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#context ⇒ String

#dimension ⇒ String

#filter ⇒ Types::Expression

#max_results ⇒ Integer

#next_page_token ⇒ String

#search_string ⇒ String

#sort_by ⇒ Array<Types::SortDefinition>

#time_period ⇒ Types::DateInterval

#context ⇒ `String`

#dimension ⇒ `String`

#filter ⇒ `Types::Expression`

#max_results ⇒ `Integer`

#next_page_token ⇒ `String`

#search_string ⇒ `String`

#sort_by ⇒ `Array<Types::SortDefinition>`

#time_period ⇒ `Types::DateInterval`