Firehose / Client / delete_delivery_stream
delete_delivery_stream#
- Firehose.Client.delete_delivery_stream(**kwargs)#
Deletes a delivery stream and its data.
To check the state of a delivery stream, use DescribeDeliveryStream. You can delete a delivery stream only if it is in one of the following states:
ACTIVE
,DELETING
,CREATING_FAILED
, orDELETING_FAILED
. You can’t delete a delivery stream that is in theCREATING
state. While the deletion request is in process, the delivery stream is in theDELETING
state.While the delivery 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 delivery stream.See also: AWS API Documentation
Request Syntax
response = client.delete_delivery_stream( DeliveryStreamName='string', AllowForceDelete=True|False )
- Parameters:
DeliveryStreamName (string) –
[REQUIRED]
The name of the delivery stream.
AllowForceDelete (boolean) –
Set this to true if you want to delete the delivery stream even if Kinesis Data Firehose is unable to retire the grant for the CMK. Kinesis Data 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 Kinesis Data Firehose. If a failure to retire the grant happens due to an Amazon Web Services KMS issue, Kinesis Data Firehose keeps retrying the delete operation.
The default value is false.
- Return type:
dict
- Returns:
Response Syntax
{}
Response Structure
(dict) –
Exceptions
Firehose.Client.exceptions.ResourceInUseException
Firehose.Client.exceptions.ResourceNotFoundException