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 ResourceNotFoundException
.
If the stream is in the ACTIVE
state, you can delete it. After a
delete_stream
request, the specified stream
is in the DELETING
state until Kinesis Data Streams completes the
deletion.
Note: Kinesis Data Streams might continue to accept data read and
write operations, such as put_record
,
put_records
, and
get_records
, on a stream in the DELETING
state 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 describe_stream
operation
to check the state of the stream, which is returned in StreamStatus
.
delete_stream
has a limit of five
transactions per second per account.
kinesis_delete_stream(StreamName, EnforceConsumerDeletion)
[required] The name of the stream to delete.
If this parameter is unset (null
) or if you set it to false
, and the
stream has registered consumers, the call to
delete_stream
fails with a
ResourceInUseException
.
An empty list.
svc$delete_stream( StreamName = "string", EnforceConsumerDeletion = TRUE|FALSE )