tags

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

Overview

Name	tags
Type	Resource
Id	aws.kinesisvideo.tags

Fields

The following fields are returned by SELECT queries:

list_tags_for_resource

Name	Datatype	Description
next_token	string	If you specify this parameter and the result of a ListTagsForResource call is truncated, the response includes a token that you can use in the next request to fetch the next set of tags. (pattern: <code>[a-zA-Z0-9+/=]*</code>)
tags	object	A map of tag keys and values associated with the specified signaling channel.

list_tags_for_stream

Name	Datatype	Description
next_token	string	If you specify this parameter and the result of a ListTags call is truncated, the response includes a token that you can use in the next request to fetch the next set of tags. (pattern: <code>[a-zA-Z0-9+/=]*</code>)
tags	object	A map of tag keys and values associated with the specified stream.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_tags_for_resource	select	region		Returns a list of tags associated with the specified signaling channel.
list_tags_for_stream	select	region		Returns a list of tags associated with the specified stream. In the request, you must specify either the StreamName or the StreamARN.
untag_resource	update	region, ResourceARN, TagKeyList		Removes one or more tags from a signaling channel. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.
tag_resource	update	region, ResourceARN		Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the Billing and Cost Management and Cost Management User Guide.
untag_stream	update	region, TagKeyList		Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored. In the request, you must provide the StreamName or StreamARN.
tag_stream	update	region		Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the Billing and Cost Management and Cost Management User Guide. You must provide either the StreamName or the StreamARN. This operation requires permission for the KinesisVideo:TagStream action. A Kinesis video stream can support up to 50 tags.

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

Returns a list of tags associated with the specified signaling channel.

SELECT
next_token,
tags
FROM aws.kinesisvideo.tags
WHERE region = '{{ region }}' -- required
;

list_tags_for_stream

Returns a list of tags associated with the specified stream. In the request, you must specify either the StreamName or the StreamARN.

SELECT
next_token,
tags
FROM aws.kinesisvideo.tags
WHERE region = '{{ region }}' -- required
;

UPDATE examples

untag_resource

Removes one or more tags from a signaling channel. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.

UPDATE aws.kinesisvideo.tags
SET 
ResourceARN = '{{ ResourceARN }}',
TagKeyList = '{{ TagKeyList }}'
WHERE 
region = '{{ region }}' --required
AND ResourceARN = '{{ ResourceARN }}' --required
AND TagKeyList = '{{ TagKeyList }}' --required;

tag_resource

Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the Billing and Cost Management and Cost Management User Guide.

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

untag_stream

Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored. In the request, you must provide the StreamName or StreamARN.

UPDATE aws.kinesisvideo.tags
SET 
StreamARN = '{{ StreamARN }}',
StreamName = '{{ StreamName }}',
TagKeyList = '{{ TagKeyList }}'
WHERE 
region = '{{ region }}' --required
AND TagKeyList = '{{ TagKeyList }}' --required;

tag_stream

Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the Billing and Cost Management and Cost Management User Guide. You must provide either the StreamName or the StreamARN. This operation requires permission for the KinesisVideo:TagStream action. A Kinesis video stream can support up to 50 tags.

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