2018/04/20 - Amazon Kinesis Firehose - 3 new api methods
Changes With this release, Amazon Kinesis Data Firehose allows you to tag your delivery streams. Tags are metadata that you can create and use to manage your delivery streams. For more information about tagging, see AWS Tagging Strategies. For technical documentation, look for the tagging operations in the Amazon Kinesis Firehose API reference.
Adds or updates tags for the specified delivery stream. A tag is a key-value pair (the value is optional) that you can define and assign to AWS 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 delivery stream. For more information about tags, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide .
Each delivery stream can have up to 50 tags.
This operation has a limit of five transactions per second per account.
See also: AWS API Documentation
Request Syntax
client.tag_delivery_stream(
DeliveryStreamName='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the delivery stream to which you want to add the tags.
list
[REQUIRED]
A set of key-value pairs to use to create the tags.
(dict) --
Metadata that you can assign to a delivery stream, consisting of a key-value pair.
Key (string) -- [REQUIRED]
A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
Value (string) --
An optional string, which you can use to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
dict
Response Syntax
{}
Response Structure
(dict) --
Lists the tags for the specified delivery stream. This operation has a limit of five transactions per second per account.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_delivery_stream(
DeliveryStreamName='string',
ExclusiveStartTagKey='string',
Limit=123
)
string
[REQUIRED]
The name of the delivery stream whose tags you want to list.
string
The key to use as the starting point for the list of tags. If you set this parameter, ListTagsForDeliveryStream gets all tags that occur after ExclusiveStartTagKey .
integer
The number of tags to return. If this number is less than the total number of tags associated with the delivery stream, HasMoreTags is set to true in the response. To list additional tags, set ExclusiveStartTagKey to the last key in the response.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'HasMoreTags': True|False
}
Response Structure
(dict) --
Tags (list) --
A list of tags associated with DeliveryStreamName , starting with the first tag after ExclusiveStartTagKey and up to the specified Limit .
(dict) --
Metadata that you can assign to a delivery stream, consisting of a key-value pair.
Key (string) --
A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
Value (string) --
An optional string, which you can use to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
HasMoreTags (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.
Removes tags from the specified delivery 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.
See also: AWS API Documentation
Request Syntax
client.untag_delivery_stream(
DeliveryStreamName='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The name of the delivery stream.
list
[REQUIRED]
A list of tag keys. Each corresponding tag is removed from the delivery stream.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --