DeleteDeliveryStreamCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { FirehoseClient, DeleteDeliveryStreamCommand } from "@aws-sdk/client-firehose"; // ES Modules import
// const { FirehoseClient, DeleteDeliveryStreamCommand } = require("@aws-sdk/client-firehose"); // CommonJS import
const client = new FirehoseClient(config);
const input = { // DeleteDeliveryStreamInput
  DeliveryStreamName: "STRING_VALUE", // required
  AllowForceDelete: true || false,
};
const command = new DeleteDeliveryStreamCommand(input);
const response = await client.send(command);
// {};

DeleteDeliveryStreamCommand Input

See DeleteDeliveryStreamCommandInput for more details

Parameter
Type
Description
DeliveryStreamName
Required
string | undefined

The name of the Firehose stream.

AllowForceDelete
boolean | undefined

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 Amazon Web Services KMS issue, Firehose keeps retrying the delete operation.

The default value is false.

DeleteDeliveryStreamCommand Output

See DeleteDeliveryStreamCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
ResourceInUseException
client

The resource is already in use and not available for this operation.

ResourceNotFoundException
client

The specified resource could not be found.

FirehoseServiceException
Base exception class for all service exceptions from Firehose service.