Aws::CostExplorer::Model::Expression Class Reference

#include <Expression.h>

Public Member Functions
	Expression ()
	Expression (Aws::Utils::Json::JsonView jsonValue)
Expression &	operator= (Aws::Utils::Json::JsonView jsonValue)
Aws::Utils::Json::JsonValue	Jsonize () const
const Aws::Vector< Expression > &	GetOr () const
bool	OrHasBeenSet () const
void	SetOr (const Aws::Vector< Expression > &value)
void	SetOr (Aws::Vector< Expression > &&value)
Expression &	WithOr (const Aws::Vector< Expression > &value)
Expression &	WithOr (Aws::Vector< Expression > &&value)
Expression &	AddOr (const Expression &value)
Expression &	AddOr (Expression &&value)
const Aws::Vector< Expression > &	GetAnd () const
bool	AndHasBeenSet () const
void	SetAnd (const Aws::Vector< Expression > &value)
void	SetAnd (Aws::Vector< Expression > &&value)
Expression &	WithAnd (const Aws::Vector< Expression > &value)
Expression &	WithAnd (Aws::Vector< Expression > &&value)
Expression &	AddAnd (const Expression &value)
Expression &	AddAnd (Expression &&value)
const Expression &	GetNot () const
bool	NotHasBeenSet () const
void	SetNot (const Expression &value)
void	SetNot (Expression &&value)
Expression &	WithNot (const Expression &value)
Expression &	WithNot (Expression &&value)
const DimensionValues &	GetDimensions () const
bool	DimensionsHasBeenSet () const
void	SetDimensions (const DimensionValues &value)
void	SetDimensions (DimensionValues &&value)
Expression &	WithDimensions (const DimensionValues &value)
Expression &	WithDimensions (DimensionValues &&value)
const TagValues &	GetTags () const
bool	TagsHasBeenSet () const
void	SetTags (const TagValues &value)
void	SetTags (TagValues &&value)
Expression &	WithTags (const TagValues &value)
Expression &	WithTags (TagValues &&value)
const CostCategoryValues &	GetCostCategories () const
bool	CostCategoriesHasBeenSet () const
void	SetCostCategories (const CostCategoryValues &value)
void	SetCostCategories (CostCategoryValues &&value)
Expression &	WithCostCategories (const CostCategoryValues &value)
Expression &	WithCostCategories (CostCategoryValues &&value)

Detailed Description

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. For GetRightsizingRecommendation, the Region is a full name (for example, REGION==US East (N. Virginia). The Expression 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 and DimensionValues objects using either with* methods or set* methods in multiple lines.

• Compound dimension values 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. 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). The Expression 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 an Expression object that creates an error.

  { "And": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

For the 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.

For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR are not supported. Dimensions are limited to LINKED_ACCOUNT.

See Also:

AWS API Reference

Definition at line 68 of file Expression.h.

Constructor & Destructor Documentation

Expression() [1/2]

Aws::CostExplorer::Model::Expression::Expression

(

)

Expression() [2/2]

Aws::CostExplorer::Model::Expression::Expression

(

Aws::Utils::Json::JsonView

jsonValue

)

Member Function Documentation

AddAnd() [1/2]

Expression& Aws::CostExplorer::Model::Expression::AddAnd ( const Expression &  value )

inline

Return results that match both Dimension objects.

Definition at line 151 of file Expression.h.

AddAnd() [2/2]

Expression& Aws::CostExplorer::Model::Expression::AddAnd ( Expression &&  value )

inline

Return results that match both Dimension objects.

Definition at line 156 of file Expression.h.

AddOr() [1/2]

Expression& Aws::CostExplorer::Model::Expression::AddOr ( const Expression &  value )

inline

Return results that match either Dimension object.

Definition at line 110 of file Expression.h.

AddOr() [2/2]

Expression& Aws::CostExplorer::Model::Expression::AddOr ( Expression &&  value )

inline

Return results that match either Dimension object.

Definition at line 115 of file Expression.h.

AndHasBeenSet()

bool Aws::CostExplorer::Model::Expression::AndHasBeenSet ( ) const

inline

Return results that match both Dimension objects.

Definition at line 126 of file Expression.h.

CostCategoriesHasBeenSet()

bool Aws::CostExplorer::Model::Expression::CostCategoriesHasBeenSet ( ) const

inline

The filter based on CostCategory values.

Definition at line 260 of file Expression.h.

DimensionsHasBeenSet()

bool Aws::CostExplorer::Model::Expression::DimensionsHasBeenSet ( ) const

inline

The specific Dimension to use for Expression.

Definition at line 198 of file Expression.h.

GetAnd()

const Aws::Vector<Expression>& Aws::CostExplorer::Model::Expression::GetAnd ( ) const

inline

Return results that match both Dimension objects.

Definition at line 121 of file Expression.h.

GetCostCategories()

const CostCategoryValues& Aws::CostExplorer::Model::Expression::GetCostCategories ( ) const

inline

The filter based on CostCategory values.

Definition at line 255 of file Expression.h.

GetDimensions()

const DimensionValues& Aws::CostExplorer::Model::Expression::GetDimensions ( ) const

inline

The specific Dimension to use for Expression.

Definition at line 193 of file Expression.h.

GetNot()

const Expression& Aws::CostExplorer::Model::Expression::GetNot ( ) const

inline

Return results that don't match a Dimension object.

Definition at line 162 of file Expression.h.

GetOr()

const Aws::Vector<Expression>& Aws::CostExplorer::Model::Expression::GetOr ( ) const

inline

Return results that match either Dimension object.

Definition at line 80 of file Expression.h.

GetTags()

const TagValues& Aws::CostExplorer::Model::Expression::GetTags ( ) const

inline

The specific Tag to use for Expression.

Definition at line 224 of file Expression.h.

Jsonize()

Aws::Utils::Json::JsonValue Aws::CostExplorer::Model::Expression::Jsonize

(

)

const

NotHasBeenSet()

bool Aws::CostExplorer::Model::Expression::NotHasBeenSet ( ) const

inline

Return results that don't match a Dimension object.

Definition at line 167 of file Expression.h.

operator=()

Expression& Aws::CostExplorer::Model::Expression::operator=

(

Aws::Utils::Json::JsonView

jsonValue

)

OrHasBeenSet()

bool Aws::CostExplorer::Model::Expression::OrHasBeenSet ( ) const

inline

Return results that match either Dimension object.

Definition at line 85 of file Expression.h.

SetAnd() [1/2]

void Aws::CostExplorer::Model::Expression::SetAnd ( Aws::Vector< Expression > &&  value )

inline

Return results that match both Dimension objects.

Definition at line 136 of file Expression.h.

SetAnd() [2/2]

void Aws::CostExplorer::Model::Expression::SetAnd ( const Aws::Vector< Expression > &  value )

inline

Return results that match both Dimension objects.

Definition at line 131 of file Expression.h.

SetCostCategories() [1/2]

void Aws::CostExplorer::Model::Expression::SetCostCategories ( const CostCategoryValues &  value )

inline

The filter based on CostCategory values.

Definition at line 265 of file Expression.h.

SetCostCategories() [2/2]

void Aws::CostExplorer::Model::Expression::SetCostCategories ( CostCategoryValues &&  value )

inline

The filter based on CostCategory values.

Definition at line 270 of file Expression.h.

SetDimensions() [1/2]

void Aws::CostExplorer::Model::Expression::SetDimensions ( const DimensionValues &  value )

inline

The specific Dimension to use for Expression.

Definition at line 203 of file Expression.h.

SetDimensions() [2/2]

void Aws::CostExplorer::Model::Expression::SetDimensions ( DimensionValues &&  value )

inline

The specific Dimension to use for Expression.

Definition at line 208 of file Expression.h.

SetNot() [1/2]

void Aws::CostExplorer::Model::Expression::SetNot ( const Expression &  value )

inline

Return results that don't match a Dimension object.

Definition at line 172 of file Expression.h.

SetNot() [2/2]

void Aws::CostExplorer::Model::Expression::SetNot ( Expression &&  value )

inline

Return results that don't match a Dimension object.

Definition at line 177 of file Expression.h.

SetOr() [1/2]

void Aws::CostExplorer::Model::Expression::SetOr ( Aws::Vector< Expression > &&  value )

inline

Return results that match either Dimension object.

Definition at line 95 of file Expression.h.

SetOr() [2/2]

void Aws::CostExplorer::Model::Expression::SetOr ( const Aws::Vector< Expression > &  value )

inline

Return results that match either Dimension object.

Definition at line 90 of file Expression.h.

SetTags() [1/2]

void Aws::CostExplorer::Model::Expression::SetTags ( const TagValues &  value )

inline

The specific Tag to use for Expression.

Definition at line 234 of file Expression.h.

SetTags() [2/2]

void Aws::CostExplorer::Model::Expression::SetTags ( TagValues &&  value )

inline

The specific Tag to use for Expression.

Definition at line 239 of file Expression.h.

TagsHasBeenSet()

bool Aws::CostExplorer::Model::Expression::TagsHasBeenSet ( ) const

inline

The specific Tag to use for Expression.

Definition at line 229 of file Expression.h.

WithAnd() [1/2]

Expression& Aws::CostExplorer::Model::Expression::WithAnd ( Aws::Vector< Expression > &&  value )

inline

Return results that match both Dimension objects.

Definition at line 146 of file Expression.h.

WithAnd() [2/2]

Expression& Aws::CostExplorer::Model::Expression::WithAnd ( const Aws::Vector< Expression > &  value )

inline

Return results that match both Dimension objects.

Definition at line 141 of file Expression.h.

WithCostCategories() [1/2]

Expression& Aws::CostExplorer::Model::Expression::WithCostCategories ( const CostCategoryValues &  value )

inline

The filter based on CostCategory values.

Definition at line 275 of file Expression.h.

WithCostCategories() [2/2]

Expression& Aws::CostExplorer::Model::Expression::WithCostCategories ( CostCategoryValues &&  value )

inline

The filter based on CostCategory values.

Definition at line 280 of file Expression.h.

WithDimensions() [1/2]

Expression& Aws::CostExplorer::Model::Expression::WithDimensions ( const DimensionValues &  value )

inline

The specific Dimension to use for Expression.

Definition at line 213 of file Expression.h.

WithDimensions() [2/2]

Expression& Aws::CostExplorer::Model::Expression::WithDimensions ( DimensionValues &&  value )

inline

The specific Dimension to use for Expression.

Definition at line 218 of file Expression.h.

WithNot() [1/2]

Expression& Aws::CostExplorer::Model::Expression::WithNot ( const Expression &  value )

inline

Return results that don't match a Dimension object.

Definition at line 182 of file Expression.h.

WithNot() [2/2]

Expression& Aws::CostExplorer::Model::Expression::WithNot ( Expression &&  value )

inline

Return results that don't match a Dimension object.

Definition at line 187 of file Expression.h.

WithOr() [1/2]

Expression& Aws::CostExplorer::Model::Expression::WithOr ( Aws::Vector< Expression > &&  value )

inline

Return results that match either Dimension object.

Definition at line 105 of file Expression.h.

WithOr() [2/2]

Expression& Aws::CostExplorer::Model::Expression::WithOr ( const Aws::Vector< Expression > &  value )

inline

Return results that match either Dimension object.

Definition at line 100 of file Expression.h.

WithTags() [1/2]

Expression& Aws::CostExplorer::Model::Expression::WithTags ( const TagValues &  value )

inline

The specific Tag to use for Expression.

Definition at line 244 of file Expression.h.

WithTags() [2/2]

Expression& Aws::CostExplorer::Model::Expression::WithTags ( TagValues &&  value )

inline

The specific Tag to use for Expression.

Definition at line 249 of file Expression.h.

---

The documentation for this class was generated from the following file:

• aws-cpp-sdk-ce/include/aws/ce/model/Expression.h