ListTagsForStream
Lists the tags for the specified Kinesis data stream. This operation has a limit of five transactions per second per account.
Request Syntax
{
"ExclusiveStartTagKey": "string
",
"Limit": number
,
"StreamName": "string
"
}
Request Parameters
The request accepts the following data in JSON format.
- ExclusiveStartTagKey
-
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
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
- 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 totrue
. To list additional tags, setExclusiveStartTagKey
to the last key in the response.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
- StreamName
-
The name of the stream.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_.-]+
Required: Yes
Response Syntax
{
"HasMoreTags": boolean,
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- HasMoreTags
-
If set to
true
, more tags are available. To request additional tags, setExclusiveStartTagKey
to the key of the last tag returned.Type: Boolean
- Tags
-
A list of tags associated with
StreamName
, starting with the first tag afterExclusiveStartTagKey
and up to the specifiedLimit
.Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidArgumentException
-
A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
HTTP Status Code: 400
- LimitExceededException
-
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
HTTP Status Code: 400
- ResourceNotFoundException
-
The requested resource could not be found. The stream might not be specified correctly.
HTTP Status Code: 400
Examples
To list the tags for a stream
The following JSON example lists the tags for the specified stream.
Sample Request
POST / HTTP/1.1
Host: kinesis.<region>.<domain>
Content-Length: <PayloadSizeBytes>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Authorization: <AuthParams>
Connection: Keep-Alive
X-Amz-Date: <Date>
X-Amz-Target: Kinesis_20131202.ListTagsForStream
{
"StreamName": "exampleStreamName"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
"HasMoreTags": "false",
"Tags" : [
{
"Key": "Project",
"Value": "myProject"
},
{
"Key": "Environment",
"Value": "Production"
}
]
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: