Class: Aws::CostExplorer::Types::Expression

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-costexplorer/types.rb

Overview

Note:

When making an API call, you may pass Expression data as a hash:

{
  or: [
    {
      or: {
        # recursive Expressions
      },
      and: {
        # recursive Expressions
      },
      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, AGREEMENT_END_DATE_TIME_AFTER, AGREEMENT_END_DATE_TIME_BEFORE
        values: ["Value"],
        match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
      },
      tags: {
        key: "TagKey",
        values: ["Value"],
        match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
      },
      cost_categories: {
        key: "CostCategoryName",
        values: ["Value"],
        match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
      },
    },
  ],
  and: [
    {
      or: {
        # recursive Expressions
      },
      and: {
        # recursive Expressions
      },
      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, AGREEMENT_END_DATE_TIME_AFTER, AGREEMENT_END_DATE_TIME_BEFORE
        values: ["Value"],
        match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
      },
      tags: {
        key: "TagKey",
        values: ["Value"],
        match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
      },
      cost_categories: {
        key: "CostCategoryName",
        values: ["Value"],
        match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
      },
    },
  ],
  not: {
    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, AGREEMENT_END_DATE_TIME_AFTER, AGREEMENT_END_DATE_TIME_BEFORE
      values: ["Value"],
      match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
    },
    tags: {
      key: "TagKey",
      values: ["Value"],
      match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
    },
    cost_categories: {
      key: "CostCategoryName",
      values: ["Value"],
      match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
    },
  },
  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, AGREEMENT_END_DATE_TIME_AFTER, AGREEMENT_END_DATE_TIME_BEFORE
    values: ["Value"],
    match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
  },
  tags: {
    key: "TagKey",
    values: ["Value"],
    match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
  },
  cost_categories: {
    key: "CostCategoryName",
    values: ["Value"],
    match_options: ["EQUALS"], # accepts EQUALS, ABSENT, 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`. 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”: [ [ {“Dimensions”: { “Key”: “REGION”, “Values”:

    “us-east-1”, “us-west-1”

    }, {“Tags”: { “Key”: “TagName”,

    “Values”: [“Value1”] } } ]}, {“Dimensions”: { “Key”: “USAGE_TYPE”, “Values”: [“DataTransfer”] }} ] } ‘

    <note markdown=“1”> 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.

    </note>

    ‘ { “And”: [ … ], “DimensionValues”: { “Dimension”: “USAGE_TYPE”, “Values”: [ “DataTransfer” ] } } `

<note markdown=“1”> 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`.

</note>

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#and ⇒ Array<Types::Expression>

Return results that match both ‘Dimension` objects.

Returns:



1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 1764

class Expression < Struct.new(
  :or,
  :and,
  :not,
  :dimensions,
  :tags,
  :cost_categories)
  SENSITIVE = []
  include Aws::Structure
end

#cost_categories ⇒ Types::CostCategoryValues

The filter based on ‘CostCategory` values.

Returns:



1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 1764

class Expression < Struct.new(
  :or,
  :and,
  :not,
  :dimensions,
  :tags,
  :cost_categories)
  SENSITIVE = []
  include Aws::Structure
end

#dimensions ⇒ Types::DimensionValues

The specific ‘Dimension` to use for `Expression`.

Returns:



1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 1764

class Expression < Struct.new(
  :or,
  :and,
  :not,
  :dimensions,
  :tags,
  :cost_categories)
  SENSITIVE = []
  include Aws::Structure
end

#not ⇒ Types::Expression

Return results that don’t match a ‘Dimension` object.

Returns:



1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 1764

class Expression < Struct.new(
  :or,
  :and,
  :not,
  :dimensions,
  :tags,
  :cost_categories)
  SENSITIVE = []
  include Aws::Structure
end

#or ⇒ Array<Types::Expression>

Return results that match either ‘Dimension` object.

Returns:



1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 1764

class Expression < Struct.new(
  :or,
  :and,
  :not,
  :dimensions,
  :tags,
  :cost_categories)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Types::TagValues

The specific ‘Tag` to use for `Expression`.

Returns:



1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 1764

class Expression < Struct.new(
  :or,
  :and,
  :not,
  :dimensions,
  :tags,
  :cost_categories)
  SENSITIVE = []
  include Aws::Structure
end