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

Class: Aws::Kinesis::Types::ListTagsForStreamInput

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

Overview

Note:

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

{
  stream_name: "StreamName", # required
  exclusive_start_tag_key: "TagKey",
  limit: 1,
}

Represents the input for ListTagsForStream.

Instance Attribute Summary collapse

Instance Attribute Details

#exclusive_start_tag_keyString

The key to use as the starting point for the list of tags. If this parameter is set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey.

Returns:

  • (String)


631
632
633
634
635
636
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 631

class ListTagsForStreamInput < Struct.new(
  :stream_name,
  :exclusive_start_tag_key,
  :limit)
  include Aws::Structure
end

#limitInteger

The number of tags to return. If this number is less than the total number of tags associated with the stream, HasMoreTags is set to true. To list additional tags, set ExclusiveStartTagKey to the last key in the response.

Returns:

  • (Integer)


631
632
633
634
635
636
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 631

class ListTagsForStreamInput < Struct.new(
  :stream_name,
  :exclusive_start_tag_key,
  :limit)
  include Aws::Structure
end

#stream_nameString

The name of the stream.

Returns:

  • (String)


631
632
633
634
635
636
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 631

class ListTagsForStreamInput < Struct.new(
  :stream_name,
  :exclusive_start_tag_key,
  :limit)
  include Aws::Structure
end