tags

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

Overview

Name	tags
Type	Resource
Id	aws.firehose.tags

Fields

The following fields are returned by SELECT queries:

list_tags_for_delivery_stream

Name	Datatype	Description
has_more_tags	boolean	If this is true in the response, more tags are available. To list the remaining tags, set ExclusiveStartTagKey to the key of the last tag returned and call ListTagsForDeliveryStream again.
tags	array	A list of tags associated with DeliveryStreamName, 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_delivery_stream	select	region		Lists the tags for the specified Firehose stream. This operation has a limit of five transactions per second per account.
untag_delivery_stream	update	region, DeliveryStreamName, TagKeys		Removes tags from the specified Firehose stream. Removed tags are deleted, and you can't recover them after this operation successfully completes. If you specify a tag that doesn't exist, the operation ignores it. This operation has a limit of five transactions per second per account.
tag_delivery_stream	update	region, DeliveryStreamName		Adds or updates tags for the specified Firehose stream. A tag is a key-value pair 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. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide. Each Firehose stream can have up to 50 tags. This operation 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_delivery_stream

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

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

UPDATE examples

untag_delivery_stream

Removes tags from the specified Firehose stream. Removed tags are deleted, and you can't recover them after this operation successfully completes. If you specify a tag that doesn't exist, the operation ignores it. This operation has a limit of five transactions per second per account.

UPDATE aws.firehose.tags
SET 
DeliveryStreamName = '{{ DeliveryStreamName }}',
TagKeys = '{{ TagKeys }}'
WHERE 
region = '{{ region }}' --required
AND DeliveryStreamName = '{{ DeliveryStreamName }}' --required
AND TagKeys = '{{ TagKeys }}' --required;

tag_delivery_stream

Adds or updates tags for the specified Firehose stream. A tag is a key-value pair 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. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide. Each Firehose stream can have up to 50 tags. This operation has a limit of five transactions per second per account.

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