Class: Aws::CostExplorer::Types::GetTagsRequest

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 GetTagsRequest data as a hash:

{
  search_string: "SearchString",
  time_period: { # required
    start: "YearMonthDay", # required
    end: "YearMonthDay", # required
  },
  tag_key: "TagKey",
  filter: {
    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
    },
  },
  sort_by: [
    {
      key: "SortDefinitionKey", # required
      sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
    },
  ],
  max_results: 1,
  next_page_token: "NextPageToken",
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ Types::Expression

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>

Returns:



4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 4694

class GetTagsRequest < Struct.new(
  :search_string,
  :time_period,
  :tag_key,
  :filter,
  :sort_by,
  :max_results,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

For ‘GetTags`, MaxResults has an upper limit of 1000.

Returns:

  • (Integer) 


4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 4694

class GetTagsRequest < Struct.new(
  :search_string,
  :time_period,
  :tag_key,
  :filter,
  :sort_by,
  :max_results,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_page_token ⇒ String

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

Returns:

  • (String) 


4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 4694

class GetTagsRequest < Struct.new(
  :search_string,
  :time_period,
  :tag_key,
  :filter,
  :sort_by,
  :max_results,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

#search_string ⇒ String

The value that you want to search for.

Returns:

  • (String) 


4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 4694

class GetTagsRequest < Struct.new(
  :search_string,
  :time_period,
  :tag_key,
  :filter,
  :sort_by,
  :max_results,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

#sort_by ⇒ Array<Types::SortDefinition>

The value by which you want to sort the data.

The key represents cost and usage metrics. The following values are supported:

  • ‘BlendedCost`

  • ‘UnblendedCost`

  • ‘AmortizedCost`

  • ‘NetAmortizedCost`

  • ‘NetUnblendedCost`

  • ‘UsageQuantity`

  • ‘NormalizedUsageAmount`

Supported values for ‘SortOrder` are `ASCENDING` or `DESCENDING`.

When using ‘SortBy`, `NextPageToken` and `SearchString` are not supported.

Returns:



4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 4694

class GetTagsRequest < Struct.new(
  :search_string,
  :time_period,
  :tag_key,
  :filter,
  :sort_by,
  :max_results,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

#tag_key ⇒ String

The key of the tag that you want to return values for.

Returns:

  • (String) 


4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 4694

class GetTagsRequest < Struct.new(
  :search_string,
  :time_period,
  :tag_key,
  :filter,
  :sort_by,
  :max_results,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end

#time_period ⇒ Types::DateInterval

The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if ‘start` is `2017-01-01` and `end` is `2017-05-01`, then the cost and usage data is retrieved from `2017-01-01` up to and including `2017-04-30` but not including `2017-05-01`.

Returns:



4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
 
# File 'lib/aws-sdk-costexplorer/types.rb', line 4694

class GetTagsRequest < Struct.new(
  :search_string,
  :time_period,
  :tag_key,
  :filter,
  :sort_by,
  :max_results,
  :next_page_token)
  SENSITIVE = []
  include Aws::Structure
end