Firehose / Client / list_tags_for_delivery_stream

list_tags_for_delivery_stream#

Firehose.Client.list_tags_for_delivery_stream(**kwargs)#

Lists the tags for the specified delivery stream. This operation has a limit of five transactions per second per account.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_delivery_stream(
    DeliveryStreamName='string',
    ExclusiveStartTagKey='string',
    Limit=123
)
Parameters:
  • DeliveryStreamName (string) –

    [REQUIRED]

    The name of the delivery stream whose tags you want to list.

  • ExclusiveStartTagKey (string) – The key to use as the starting point for the list of tags. If you set this parameter, ListTagsForDeliveryStream gets all tags that occur after ExclusiveStartTagKey.

  • Limit (integer) – The number of tags to return. If this number is less than the total number of tags associated with the delivery stream, HasMoreTags is set to true in the response. To list additional tags, set ExclusiveStartTagKey to the last key in the response.

Return type:

dict

Returns:

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'HasMoreTags': True|False
}

Response Structure

  • (dict) –

    • Tags (list) –

      A list of tags associated with DeliveryStreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.

      • (dict) –

        Metadata that you can assign to a delivery 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, which you can use to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

    • HasMoreTags (boolean) –

      If this is true in the response, more tags are available. To list the remaining tags, set ExclusiveStartTagKey to the key of the last tag returned and call ListTagsForDeliveryStream again.

Exceptions