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, it is recommended you use the StreamARN
input parameter rather than the StreamName
input parameter.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_stream(
StreamName='string',
ExclusiveStartTagKey='string',
Limit=123,
StreamARN='string'
)
ListTagsForStream
gets all tags that occur after ExclusiveStartTagKey
.HasMoreTags
is set to true
. To list additional tags, set ExclusiveStartTagKey
to the last key in the response.dict
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 after ExclusiveStartTagKey
and up to the specified Limit
.
(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, set ExclusiveStartTagKey
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