You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-costexplorer/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",
  next_page_token: "NextPageToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#next_page_tokenString

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)


715
716
717
718
719
720
721
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 715

class GetTagsRequest < Struct.new(
  :search_string,
  :time_period,
  :tag_key,
  :next_page_token)
  include Aws::Structure
end

#search_stringString

The value that you want to search for.

Returns:

  • (String)


715
716
717
718
719
720
721
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 715

class GetTagsRequest < Struct.new(
  :search_string,
  :time_period,
  :tag_key,
  :next_page_token)
  include Aws::Structure
end

#tag_keyString

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

Returns:

  • (String)


715
716
717
718
719
720
721
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 715

class GetTagsRequest < Struct.new(
  :search_string,
  :time_period,
  :tag_key,
  :next_page_token)
  include Aws::Structure
end

#time_periodTypes::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:



715
716
717
718
719
720
721
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 715

class GetTagsRequest < Struct.new(
  :search_string,
  :time_period,
  :tag_key,
  :next_page_token)
  include Aws::Structure
end