Class: Aws::CostExplorer::Types::GetDimensionValuesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CostExplorer::Types::GetDimensionValuesRequest
- Defined in:
- gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb
Overview
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 in various Cost Explorer APIs. -
#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 that you want to sort the data by.
-
#time_period ⇒ Types::DateInterval
The start date and end date 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
.BILLING_ENTITY - The Amazon Web Services seller that your account is with. Possible values are the following:
- Amazon Web Services(Amazon Web Services): The entity that sells Amazon Web Services.
- AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that's an acting reseller for Amazon Web Services in India.
- Amazon Web Services Marketplace: The entity that supports the sale of solutions that are built on Amazon Web Services by third-party software providers.
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
andMultiAZ
.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
.INSTANCE_TYPE_FAMILY - A family of instance types optimized to fit different use cases. Examples are
Compute Optimized
(for example,C4
,C5
,C6g
, andC7g
),Memory Optimization
(for example,R4
,R5n
,R5b
, andR6g
).INVOICING_ENTITY - The name of the entity that issues the Amazon Web Services invoice.
LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services 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 Amazon Web Services ID of the member account.
OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
OPERATION - The action performed. Examples include
RunInstance
andCreateBucket
.PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
PURCHASE_TYPE - The reservation type of the purchase that this usage is related to. Examples include On-Demand Instances and Standard Reserved Instances.
RESERVATION_ID - The unique identifier for an Amazon Web Services Reservation Instance.
SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.
SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute).
SERVICE - The Amazon Web Services service such as Amazon DynamoDB.
TENANCY - The tenancy of a resource. Examples are shared or dedicated.
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 Amazon Web Services Region.
RECORD_TYPE - The different types of charges such as Reserved Instance (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
andMultiAZ
.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 Amazon Web Services ID of the member account.
PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
REGION - The Amazon Web Services 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 - The payment option for the given Savings Plans (for example, All Upfront)
REGION - The Amazon Web Services 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 Amazon Web Services ID of the member account.
SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.
3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 3083 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
.
LINK_ACCOUNT_NAME
and SERVICE_CODE
can only be used in
CostCategoryRule.
3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 3083 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 in various Cost Explorer APIs.
Not all Expression
types are supported in each API. Refer to the
documentation for each specific API to see what is supported.
There are two patterns:
Simple dimension values.
There are three types of simple dimension values:
CostCategories
,Tags
, andDimensions
.Specify the
CostCategories
field to define a filter that acts on Cost Categories.Specify the
Tags
field to define a filter that acts on Cost Allocation Tags.Specify the
Dimensions
field to define a filter that acts on theDimensionValues
.
For each filter type, 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
. ForGetRightsizingRecommendation
, the Region is a full name (for example,REGION==US East (N. Virginia)
.The corresponding
Expression
for this example is as follows:\{ "Dimensions": \{ "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] \} \}
As shown in the previous example, lists of dimension values are combined with
OR
when applying the filter.
You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.
For example, you can filter for linked account names that start with "a".
The corresponding
Expression
for this example is as follows:\{ "Dimensions": \{ "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] \} \}
Compound
Expression
types with logical operations.You can use multiple
Expression
types and the logical operatorsAND/OR/NOT
to create a list of one or moreExpression
objects. By doing this, you can filter by more advanced options.For example, you can filter by
((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)
.The corresponding
Expression
for this example is as follows:\{ "And": [ \{"Or": [ \{"Dimensions": \{ "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] \}\}, \{"Tags": \{ "Key": "TagName", "Values": ["Value1"] \} \} ]\}, \{"Not": \{"Dimensions": \{ "Key": "USAGE_TYPE", "Values": ["DataTransfer"] \}\}\} ] \}
Because each Expression
can have only one operator, the service returns an error if more than one is specified. The following example shows anExpression
object that creates an error:\{ "And": [ ... ], "Dimensions": \{ "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] \} \}
The following is an example of the corresponding error message:
"Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"
GetRightsizingRecommendation
action, a combination of OR
and NOT isn't supported. OR isn't 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 aren't supported. Dimensions are limited to
LINKED_ACCOUNT
.
3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 3083 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 are returned for this request. If MaxResults isn't specified with SortBy, the request returns 1000 results as the default value for this parameter.
For GetDimensionValues
, MaxResults has an upper limit of 1000.
3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 3083 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. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 3083 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.
3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 3083 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 that you want to sort the data by.
The key represents cost and usage metrics. The following values are supported:
BlendedCost
UnblendedCost
AmortizedCost
NetAmortizedCost
NetUnblendedCost
UsageQuantity
NormalizedUsageAmount
The supported values for the SortOrder
key are ASCENDING
or
DESCENDING
.
When you specify a SortBy
paramater, the context must be
COST_AND_USAGE
. Further, when using SortBy
, NextPageToken
and
SearchString
aren't supported.
3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 3083 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 date and end date 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
.
3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 |
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 3083 class GetDimensionValuesRequest < Struct.new( :search_string, :time_period, :dimension, :context, :filter, :sort_by, :max_results, :next_page_token) SENSITIVE = [] include Aws::Structure end |