Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . kinesis ]

list-tags-for-stream

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-tags-for-stream
--stream-name <value>
[--exclusive-start-tag-key <value>]
[--limit <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--stream-name (string)

The name of the stream.

--exclusive-start-tag-key (string)

The key to use as the starting point for the list of tags. If this parameter is set, ListTagsForStream 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 stream, HasMoreTags is set to true . To list additional tags, set ExclusiveStartTagKey to the last key in the response.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To list tags for a data stream

The following list-tags-for-stream example lists the tags attached to the specified data stream.

aws kinesis list-tags-for-stream \
    --stream-name samplestream

Output:

{
    "Tags": [
        {
            "Key": "samplekey",
            "Value": "example"
        }
    ],
    "HasMoreTags": false
}

For more information, see Tagging Your Streams in the Amazon Kinesis Data Streams Developer Guide.

Output

Tags -> (list)

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

(structure)

Metadata assigned to the 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, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

HasMoreTags -> (boolean)

If set to true , more tags are available. To request additional tags, set ExclusiveStartTagKey to the key of the last tag returned.