Kinesis / Client / list_tags_for_resource

list_tags_for_resource

Kinesis.Client.list_tags_for_resource(**kwargs)

List all tags added to the specified Kinesis resource. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.

For more information about tagging Kinesis resources, see Tag your Amazon Kinesis Data Streams resources.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceARN='string'
)
Parameters:

ResourceARN (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the Kinesis resource for which to list tags.

Return type:

dict

Returns:

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • Tags (list) –

      An array of tags associated with the specified Kinesis resource.

      • (dict) –

        Metadata assigned to the stream or consumer, 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, _ . / = + - % @

Exceptions