UntagDeliveryStream
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.
Request Syntax
{
"DeliveryStreamName": "string
",
"TagKeys": [ "string
" ]
}
Request Parameters
The request accepts the following data in JSON format.
- DeliveryStreamName
-
The name of the Firehose stream.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_.-]+
Required: Yes
- TagKeys
-
A list of tag keys. Each corresponding tag is removed from the delivery stream.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^(?!aws:)[\p{L}\p{Z}\p{N}_.:\/=+\-@%]*$
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidArgumentException
-
The specified input parameter has a value that is not valid.
HTTP Status Code: 400
- LimitExceededException
-
You have already reached the limit for a requested resource.
HTTP Status Code: 400
- ResourceInUseException
-
The resource is already in use and not available for this operation.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource could not be found.
HTTP Status Code: 400
Examples
To remove tags from a stream
The following JSON example removes the specified tag from the specified stream.
Sample Request
POST / HTTP/1.1
Host: firehose.<region>.<domain>
Content-Length: <PayloadSizeBytes>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Authorization: <AuthParams>
Connection: Keep-Alive
X-Amz-Date: <Date>
X-Amz-Target: Firehose_20150804.UntagDeliveryStream
{
"DeliveryStreamName": "exampleDeliveryStreamName",
"TagKeys": ["Project", "Environment"]
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: