ListTagsForStream
Returns a list of tags associated with the specified stream.
In the request, you must specify either the StreamName
or the
StreamARN
.
Request Syntax
POST /listTagsForStream HTTP/1.1
Content-type: application/json
{
"NextToken": "string
",
"StreamARN": "string
",
"StreamName": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- NextToken
-
If you specify this parameter and the result of a
ListTagsForStream
call is truncated, the response includes a token that you can use in the next request to fetch the next batch of tags.Type: String
Length Constraints: Minimum length of 0. Maximum length of 512.
Pattern:
[a-zA-Z0-9+/=]*
Required: No
- StreamARN
-
The Amazon Resource Name (ARN) of the stream that you want to list tags for.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
Required: No
- StreamName
-
The name of the stream that you want to list tags for.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9_.-]+
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Tags": {
"string" : "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.
- NextToken
-
If you specify this parameter and the result of a
ListTags
call is truncated, the response includes a token that you can use in the next request to fetch the next set of tags.Type: String
Length Constraints: Minimum length of 0. Maximum length of 512.
Pattern:
[a-zA-Z0-9+/=]*
- Tags
-
A map of tag keys and values associated with the specified stream.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
[\p{L}\p{Z}\p{N}_.:/=+\-@]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- ClientLimitExceededException
-
Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
HTTP Status Code: 400
- InvalidArgumentException
-
The value for this input parameter is invalid.
HTTP Status Code: 400
- InvalidResourceFormatException
-
The format of the
StreamARN
is invalid.HTTP Status Code: 400
- NotAuthorizedException
-
The caller is not authorized to perform this operation.
HTTP Status Code: 401
- ResourceNotFoundException
-
Amazon Kinesis Video Streams can't find the stream that you specified.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: