amazonka-kinesis-0.1.3: Amazon Kinesis SDK.

Safe HaskellNone
LanguageHaskell2010

Network.AWS.Kinesis.DeleteStream

Contents

Description

Deletes a 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 will receive the exception ResourceNotFoundException.

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 Amazon Kinesis completes the deletion.

Note: Amazon Kinesis 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 DescribeStream operation to check the state of the stream, which is returned in StreamStatus.

DeleteStream has a limit of 5 transactions per second per account.

http://docs.aws.amazon.com/kinesis/latest/APIReference/API_DeleteStream.html

Synopsis

Request

Request constructor

deleteStream Source

DeleteStream constructor.

The fields accessible through corresponding lenses are:

Request lenses

dsStreamName :: Lens' DeleteStream Text Source

The name of the stream to delete.

Response

Response constructor