DeleteDeliveryStream
Deletes a Firehose stream and its data.
You can delete a Firehose stream only if it is in one of the following states:
ACTIVE, DELETING, CREATING_FAILED, or
DELETING_FAILED. You can't delete a Firehose stream that is in the
CREATING state. To check the state of a Firehose stream, use DescribeDeliveryStream.
DeleteDeliveryStream is an asynchronous API. When an API request to DeleteDeliveryStream succeeds, the Firehose stream is marked for deletion, and it goes into the
DELETING state.While the Firehose stream is in the DELETING state, the service might
continue to accept records, but it doesn't make any guarantees with respect to delivering
the data. Therefore, as a best practice, first stop any applications that are sending
records before you delete a Firehose stream.
Removal of a Firehose stream that is in the DELETING state is a low priority operation for the service. A stream may remain in the
DELETING state for several minutes. Therefore, as a best practice, applications should not wait for streams in the DELETING state
to be removed.
Request Syntax
{
"AllowForceDelete": boolean,
"DeliveryStreamName": "string"
}Request Parameters
The request accepts the following data in JSON format.
- AllowForceDelete
-
Set this to true if you want to delete the Firehose stream even if Firehose is unable to retire the grant for the CMK. Firehose might be unable to retire the grant due to a customer error, such as when the CMK or the grant are in an invalid state. If you force deletion, you can then use the RevokeGrant operation to revoke the grant you gave to Firehose. If a failure to retire the grant happens due to an AWS KMS issue, Firehose keeps retrying the delete operation.
The default value is false.
Type: Boolean
Required: No
- 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
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.
- 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
Example
The following JSON example deletes a Firehose stream named
exampleStreamName.
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.DeleteDeliveryStream
{
"DeliveryStreamName": "exampleStreamName"
}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 AWS SDKs, see the following:
