You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CostExplorer::Types::Expression
- Inherits:
-
Struct
- Object
- Struct
- Aws::CostExplorer::Types::Expression
- Defined in:
- (unknown)
Overview
When passing Expression as input to an Aws::Client method, you can use a vanilla Hash:
{
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
values: ["Value"],
match_options: ["EQUALS"], # accepts EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
},
tags: {
key: "TagKey",
values: ["Value"],
match_options: ["EQUALS"], # accepts EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
},
cost_categories: {
key: "CostCategoryName",
values: ["Value"],
match_options: ["EQUALS"], # accepts EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
},
}
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
. ForGetRightsizingRecommendation
, the Region is a full name (for example,REGION==US East (N. Virginia)
. TheExpression
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
andDimensionValues
objects using eitherwith
methods orset
methods in multiple lines. -
Compound dimension values with logical operations - You can use multiple
Expression
types and the logical operatorsAND/OR/NOT
to create a list of one or moreExpression
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)
. TheExpression
for that looks like this:{ "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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }
For 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
.
Returned by:
- AnomalyMonitor#monitor_specification
- CostCategoryRule#rule
- #not
- GetCostAndUsageRequest#filter
- GetCostAndUsageWithResourcesRequest#filter
- GetCostForecastRequest#filter
- GetReservationCoverageRequest#filter
- GetReservationUtilizationRequest#filter
- GetRightsizingRecommendationRequest#filter
- GetSavingsPlansCoverageRequest#filter
- GetSavingsPlansPurchaseRecommendationRequest#filter
- GetSavingsPlansUtilizationDetailsRequest#filter
- GetSavingsPlansUtilizationRequest#filter
- GetUsageForecastRequest#filter
Instance Attribute Summary collapse
-
#and ⇒ Array<Types::Expression>
Return results that match both
Dimension
objects. -
#cost_categories ⇒ Types::CostCategoryValues
The filter based on
CostCategory
values. -
#dimensions ⇒ Types::DimensionValues
The specific
Dimension
to use forExpression
. -
#not ⇒ Types::Expression
Return results that don\'t match a
Dimension
object. -
#or ⇒ Array<Types::Expression>
Return results that match either
Dimension
object. -
#tags ⇒ Types::TagValues
The specific
Tag
to use forExpression
.
Instance Attribute Details
#and ⇒ Array<Types::Expression>
Return results that match both Dimension
objects.
#cost_categories ⇒ Types::CostCategoryValues
The filter based on CostCategory
values.
#dimensions ⇒ Types::DimensionValues
The specific Dimension
to use for Expression
.
#not ⇒ Types::Expression
Return results that don\'t match a Dimension
object.
#or ⇒ Array<Types::Expression>
Return results that match either Dimension
object.
#tags ⇒ Types::TagValues
The specific Tag
to use for Expression
.