Kinesis / Client / remove_tags_from_stream

remove_tags_from_stream#

Kinesis.Client.remove_tags_from_stream(**kwargs)#

Removes tags from the specified Kinesis data stream. Removed tags are deleted and cannot be recovered after this operation successfully completes.

Note

When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.

If you specify a tag that does not exist, it is ignored.

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

See also: AWS API Documentation

Request Syntax

response = client.remove_tags_from_stream(
    StreamName='string',
    TagKeys=[
        'string',
    ],
    StreamARN='string'
)
Parameters:
  • StreamName (string) – The name of the stream.

  • TagKeys (list) –

    [REQUIRED]

    A list of tag keys. Each corresponding tag is removed from the stream.

    • (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