Kinesis / Client / list_tags_for_stream
list_tags_for_stream#
- Kinesis.Client.list_tags_for_stream(**kwargs)#
Lists the tags for the specified Kinesis data stream. This operation has a limit of five transactions per second per account.
Note
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_stream( StreamName='string', ExclusiveStartTagKey='string', Limit=123, StreamARN='string' )
- Parameters:
StreamName (string) – The name of the stream.
ExclusiveStartTagKey (string) – The key to use as the starting point for the list of tags. If this parameter is set,
ListTagsForStream
gets all tags that occur afterExclusiveStartTagKey
.Limit (integer) – The number of tags to return. If this number is less than the total number of tags associated with the stream,
HasMoreTags
is set totrue
. To list additional tags, setExclusiveStartTagKey
to the last key in the response.StreamARN (string) – The ARN of the stream.
- Return type:
dict
- Returns:
Response Syntax
{ 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'HasMoreTags': True|False }
Response Structure
(dict) –
Represents the output for
ListTagsForStream
.Tags (list) –
A list of tags associated with
StreamName
, starting with the first tag afterExclusiveStartTagKey
and up to the specifiedLimit
.(dict) –
Metadata assigned to the stream, consisting of a key-value pair.
Key (string) –
A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
Value (string) –
An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
HasMoreTags (boolean) –
If set to
true
, more tags are available. To request additional tags, setExclusiveStartTagKey
to the key of the last tag returned.
Exceptions
Kinesis.Client.exceptions.ResourceNotFoundException
Kinesis.Client.exceptions.InvalidArgumentException
Kinesis.Client.exceptions.LimitExceededException
Kinesis.Client.exceptions.AccessDeniedException