List Tags For Stream

kinesis_list_tags_for_stream

R Documentation

Lists the tags for the specified Kinesis data stream

Description

Lists the tags for the specified Kinesis data stream. This operation has a limit of five transactions per second per account.

When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.

Usage

kinesis_list_tags_for_stream(StreamName, ExclusiveStartTagKey, Limit,
  StreamARN)

Arguments

StreamName	The name of the stream.
ExclusiveStartTagKey	The key to use as the starting point for the list of tags. If this parameter is set, list_tags_for_stream gets all tags that occur after ExclusiveStartTagKey.
Limit	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.
StreamARN	The ARN of the stream.

Value

A list with the following syntax:

list(
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  HasMoreTags = TRUE|FALSE
)

Request syntax

svc$list_tags_for_stream(
  StreamName = "string",
  ExclusiveStartTagKey = "string",
  Limit = 123,
  StreamARN = "string"
)