tags

Creates, updates, deletes, gets or lists a tags resource.

Overview

Name	tags
Type	Resource
Id	aws.kinesis.tags

Fields

The following fields are returned by SELECT queries:

list_tags_for_resource

Name	Datatype	Description
tags	array	An array of tags associated with the specified Kinesis resource.

list_tags_for_stream

Name	Datatype	Description
has_more_tags	boolean	If set to true, more tags are available. To request additional tags, set ExclusiveStartTagKey to the key of the last tag returned.
tags	array	A list of tags associated with StreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_tags_for_resource	select	region		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.
list_tags_for_stream	select	region		Lists the tags for the specified Kinesis data stream. This operation has a limit of five transactions per second per account. 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.
untag_resource	update	region, TagKeys, ResourceARN		Removes tags from the specified Kinesis resource. Removed tags are deleted and can't be recovered after this operation completes successfully.
remove_tags_from_stream	update	region, TagKeys		Removes tags from the specified Kinesis data stream. Removed tags are deleted and cannot be recovered after this operation successfully completes. 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.
tag_resource	update	region, ResourceARN		Adds or updates tags for 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. You can assign up to 50 tags to a Kinesis resource.
add_tags_to_stream	update	region		Adds or updates tags for the specified Kinesis data stream. You can assign up to 50 tags to a data stream. 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 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_tags_for_resource

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.

SELECT
tags
FROM aws.kinesis.tags
WHERE region = '{{ region }}' -- required
;

list_tags_for_stream

Lists the tags for the specified Kinesis data stream. This operation has a limit of five transactions per second per account. 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.

SELECT
has_more_tags,
tags
FROM aws.kinesis.tags
WHERE region = '{{ region }}' -- required
;

UPDATE examples

untag_resource

Removes tags from the specified Kinesis resource. Removed tags are deleted and can't be recovered after this operation completes successfully.

UPDATE aws.kinesis.tags
SET 
TagKeys = '{{ TagKeys }}',
ResourceARN = '{{ ResourceARN }}',
StreamId = '{{ StreamId }}'
WHERE 
region = '{{ region }}' --required
AND TagKeys = '{{ TagKeys }}' --required
AND ResourceARN = '{{ ResourceARN }}' --required;

remove_tags_from_stream

Removes tags from the specified Kinesis data stream. Removed tags are deleted and cannot be recovered after this operation successfully completes. 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.

UPDATE aws.kinesis.tags
SET 
StreamName = '{{ StreamName }}',
TagKeys = '{{ TagKeys }}',
StreamARN = '{{ StreamARN }}',
StreamId = '{{ StreamId }}'
WHERE 
region = '{{ region }}' --required
AND TagKeys = '{{ TagKeys }}' --required;

tag_resource

Adds or updates tags for 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. You can assign up to 50 tags to a Kinesis resource.

UPDATE aws.kinesis.tags
SET 
Tags = '{{ Tags }}',
ResourceARN = '{{ ResourceARN }}',
StreamId = '{{ StreamId }}'
WHERE 
region = '{{ region }}' --required
AND ResourceARN = '{{ ResourceARN }}' --required;

add_tags_to_stream

Adds or updates tags for the specified Kinesis data stream. You can assign up to 50 tags to a data stream. 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 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.

UPDATE aws.kinesis.tags
SET 
StreamName = '{{ StreamName }}',
Tags = '{{ Tags }}',
StreamARN = '{{ StreamARN }}',
StreamId = '{{ StreamId }}'
WHERE 
region = '{{ region }}' --required;