Amazonka.CostExplorer.Types.Expression

Documentation

data 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, and Dimensions.

    • 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 the DimensionValues .

  • 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. For GetRightsizingRecommendation, 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 operators AND/OR/NOT to create a list of one or more Expression 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 an Expression 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"

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.

See: newExpression smart constructor.

Constructors

Expression'

Fields

• and :: Maybe [Expression]

  Return results that match both Dimension objects.

• costCategories :: Maybe CostCategoryValues

  The filter that's based on CostCategory values.

• dimensions :: Maybe DimensionValues

  The specific Dimension to use for Expression.

• not :: Maybe Expression

  Return results that don't match a Dimension object.

• or :: Maybe [Expression]

  Return results that match either Dimension object.

• tags :: Maybe TagValues

  The specific Tag to use for Expression.

Instances

FromJSON Expression

Defined in Amazonka.CostExplorer.Types.Expression

Methods

parseJSON :: Value -> Parser Expression

parseJSONList :: Value -> Parser [Expression]

ToJSON Expression

Defined in Amazonka.CostExplorer.Types.Expression

Methods

toJSON :: Expression -> Value

toEncoding :: Expression -> Encoding

toJSONList :: [Expression] -> Value

toEncodingList :: [Expression] -> Encoding

Generic Expression

Defined in Amazonka.CostExplorer.Types.Expression

Associated Types

type Rep Expression :: Type -> Type

Methods

from :: Expression -> Rep Expression x

to :: Rep Expression x -> Expression

Read Expression

Defined in Amazonka.CostExplorer.Types.Expression

Methods

readsPrec :: Int -> ReadS Expression

readList :: ReadS [Expression]

readPrec :: ReadPrec Expression

readListPrec :: ReadPrec [Expression]

Show Expression

Defined in Amazonka.CostExplorer.Types.Expression

Methods

showsPrec :: Int -> Expression -> ShowS

show :: Expression -> String

showList :: [Expression] -> ShowS

NFData Expression

Defined in Amazonka.CostExplorer.Types.Expression

Methods

rnf :: Expression -> ()

Eq Expression

Defined in Amazonka.CostExplorer.Types.Expression

Methods

(==) :: Expression -> Expression -> Bool

(/=) :: Expression -> Expression -> Bool

Hashable Expression

Defined in Amazonka.CostExplorer.Types.Expression

Methods

hashWithSalt :: Int -> Expression -> Int

hash :: Expression -> Int

type Rep Expression

Defined in Amazonka.CostExplorer.Types.Expression

type Rep Expression = D1 ('MetaData "Expression" "Amazonka.CostExplorer.Types.Expression" "amazonka-cost-explorer-2.0-QqVzyVvst98QYs5s2Ea4h" 'False) (C1 ('MetaCons "Expression'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "and") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Expression])) :*: (S1 ('MetaSel ('Just "costCategories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CostCategoryValues)) :*: S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DimensionValues)))) :*: (S1 ('MetaSel ('Just "not") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Expression)) :*: (S1 ('MetaSel ('Just "or") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Expression])) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TagValues))))))

newExpression :: Expression

Create a value of Expression with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:and:Expression', expression_and - Return results that match both Dimension objects.

$sel:costCategories:Expression', expression_costCategories - The filter that's based on CostCategory values.

$sel:dimensions:Expression', expression_dimensions - The specific Dimension to use for Expression.

$sel:not:Expression', expression_not - Return results that don't match a Dimension object.

$sel:or:Expression', expression_or - Return results that match either Dimension object.

$sel:tags:Expression', expression_tags - The specific Tag to use for Expression.

expression_and :: Lens' Expression (Maybe [Expression])

Return results that match both Dimension objects.

expression_costCategories :: Lens' Expression (Maybe CostCategoryValues)

The filter that's based on CostCategory values.

expression_dimensions :: Lens' Expression (Maybe DimensionValues)

The specific Dimension to use for Expression.

expression_not :: Lens' Expression (Maybe Expression)

Return results that don't match a Dimension object.

expression_or :: Lens' Expression (Maybe [Expression])

Return results that match either Dimension object.

expression_tags :: Lens' Expression (Maybe TagValues)

The specific Tag to use for Expression.