KinesisVideo / Client / list_tags_for_stream

list_tags_for_stream#

KinesisVideo.Client.list_tags_for_stream(**kwargs)#

Returns a list of tags associated with the specified stream.

In the request, you must specify either the StreamName or the StreamARN.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_stream(
    NextToken='string',
    StreamARN='string',
    StreamName='string'
)
Parameters:
  • NextToken (string) – 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.

  • StreamARN (string) – The Amazon Resource Name (ARN) of the stream that you want to list tags for.

  • StreamName (string) – The name of the stream that you want to list tags for.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • NextToken (string) –

      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.

    • Tags (dict) –

      A map of tag keys and values associated with the specified stream.

      • (string) –

        • (string) –

Exceptions

  • KinesisVideo.Client.exceptions.ClientLimitExceededException

  • KinesisVideo.Client.exceptions.InvalidArgumentException

  • KinesisVideo.Client.exceptions.ResourceNotFoundException

  • KinesisVideo.Client.exceptions.NotAuthorizedException

  • KinesisVideo.Client.exceptions.InvalidResourceFormatException