Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Synopsis
- data Expression = Expression' {}
- newExpression :: Expression
- expression_not :: Lens' Expression (Maybe Expression)
- expression_and :: Lens' Expression (Maybe [Expression])
- expression_or :: Lens' Expression (Maybe [Expression])
- expression_costCategories :: Lens' Expression (Maybe CostCategoryValues)
- expression_dimensions :: Lens' Expression (Maybe DimensionValues)
- expression_tags :: Lens' Expression (Maybe TagValues)
Documentation
data Expression Source #
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 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. 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"] }}} ] }
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 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.
Expression' | |
|
Instances
newExpression :: Expression Source #
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:not:Expression'
, expression_not
- Return results that don't match a Dimension
object.
$sel:and:Expression'
, expression_and
- Return results that match both Dimension
objects.
$sel:or:Expression'
, expression_or
- Return results that match either Dimension
object.
$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:tags:Expression'
, expression_tags
- The specific Tag
to use for Expression
.
expression_not :: Lens' Expression (Maybe Expression) Source #
Return results that don't match a Dimension
object.
expression_and :: Lens' Expression (Maybe [Expression]) Source #
Return results that match both Dimension
objects.
expression_or :: Lens' Expression (Maybe [Expression]) Source #
Return results that match either Dimension
object.
expression_costCategories :: Lens' Expression (Maybe CostCategoryValues) Source #
The filter that's based on CostCategory
values.
expression_dimensions :: Lens' Expression (Maybe DimensionValues) Source #
The specific Dimension
to use for Expression
.
expression_tags :: Lens' Expression (Maybe TagValues) Source #
The specific Tag
to use for Expression
.