Kinesis / Client / delete_stream
Deletes a Kinesis data stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it receives the exception
When invoking this API, you must use either the
StreamNameparameter, or both. It is recommended that you use the
StreamARNinput parameter when you invoke this API.
If the stream is in the
ACTIVEstate, you can delete it. After a
DeleteStreamrequest, the specified stream is in the
DELETINGstate until Kinesis Data Streams completes the deletion.
Note: Kinesis Data Streams might continue to accept data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the
DELETINGstate until the stream deletion is complete.
When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.
You can use the DescribeStreamSummary operation to check the state of the stream, which is returned in
DeleteStream has a limit of five transactions per second per account.
See also: AWS API Documentation
response = client.delete_stream( StreamName='string', EnforceConsumerDeletion=True|False, StreamARN='string' )
StreamName (string) – The name of the stream to delete.
EnforceConsumerDeletion (boolean) – If this parameter is unset (
null) or if you set it to
false, and the stream has registered consumers, the call to
DeleteStreamfails with a
StreamARN (string) – The ARN of the stream.