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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ Types::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.

Returns:



4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
 
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 4509

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 are returned for this request. If MaxResults isn't specified with SortBy, the request returns 1000 results as the default value for this parameter.

For GetTags, MaxResults has an upper quota of 1000.

Returns:

  • (Integer) 


4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
 
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 4509

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. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

Returns:

  • (String) 


4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
 
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 4509

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) 


4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
 
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 4509

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 that you want to sort the data by.

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

  • BlendedCost

  • UnblendedCost

  • AmortizedCost

  • NetAmortizedCost

  • NetUnblendedCost

  • UsageQuantity

  • NormalizedUsageAmount

The supported values for SortOrder are ASCENDING and DESCENDING.

When you use SortBy, NextPageToken and SearchString aren't supported.

Returns:



4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
 
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 4509

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) 


4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
 
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 4509

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:



4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
 
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 4509

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