add_tags_to_stream

Kinesis.Client.add_tags_to_stream(**kwargs)

Adds or updates tags for the specified Kinesis data stream. You can assign up to 50 tags to a data stream.

Note

When invoking this API, it is recommended you use the StreamARN input parameter rather than the StreamName input parameter.

If tags have already been assigned to the stream, AddTagsToStream overwrites any existing tags that correspond to the specified tag keys.

AddTagsToStream has a limit of five transactions per second per account.

See also: AWS API Documentation

Request Syntax

response = client.add_tags_to_stream(
    StreamName='string',
    Tags={
        'string': 'string'
    },
    StreamARN='string'
)
Parameters
  • StreamName (string) -- The name of the stream.
  • Tags (dict) --

    [REQUIRED]

    A set of up to 10 key-value pairs to use to create the tags.

    • (string) --
      • (string) --
  • StreamARN (string) -- The ARN of the stream.
Returns

None

Exceptions

  • Kinesis.Client.exceptions.ResourceNotFoundException
  • Kinesis.Client.exceptions.ResourceInUseException
  • Kinesis.Client.exceptions.InvalidArgumentException
  • Kinesis.Client.exceptions.LimitExceededException
  • Kinesis.Client.exceptions.AccessDeniedException