Smaws_Client_Kinesis.DeleteStream
val request :
Smaws_Lib.Context.t ->
delete_stream_input ->
(unit,
[> Smaws_Lib.Protocols.AwsJson.error
| `AccessDeniedException of access_denied_exception
| `InvalidArgumentException of invalid_argument_exception
| `LimitExceededException of limit_exceeded_exception
| `ResourceInUseException of resource_in_use_exception
| `ResourceNotFoundException of resource_not_found_exception ])
Stdlib.result
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
.
When invoking this API, you must use either the StreamARN
or the StreamName
parameter, or both. It is recommended that you use the StreamARN
input parameter when you invoke this API.
If the stream is in the ACTIVE
state, you can delete it. After a DeleteStream
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 PutRecord
, PutRecords
, and GetRecords
, 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 DescribeStreamSummary
operation to check the state of the stream, which is returned in StreamStatus
.
DeleteStream
has a limit of five transactions per second per account.