Expression
import type { Expression } from "https://aws-api.deno.dev/v0.3/services/costexplorer.ts?docs=full";
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 is as follows: { "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 createExpression
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. By doing this, you can 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 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"] }}} ] } Note: Because eachExpression
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" ] } }
Note:
For the 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
.
interface Expression {
And?: Expression[] | null;
CostCategories?: CostCategoryValues | null;
Dimensions?: DimensionValues | null;
Not?: Expression | null;
Or?: Expression[] | null;
Tags?: TagValues | null;
}§Properties
§
And?: Expression[] | null
[src]Return results that match both Dimension
objects.
§
CostCategories?: CostCategoryValues | null
[src]The filter that's based on CostCategory
values.
§
Dimensions?: DimensionValues | null
[src]The specific Dimension
to use for Expression
.
§
Not?: Expression | null
[src]Return results that don't match a Dimension
object.
§
Or?: Expression[] | null
[src]Return results that match either Dimension
object.