Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Deletes an Amazon Kinesis 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.
Creating a Request
Creates a value of DeleteStream
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dsStreamName
- The name of the stream to delete.
data DeleteStream Source #
Represents the input for DeleteStream
.
See: deleteStream
smart constructor.
Request Lenses
dsStreamName :: Lens' DeleteStream Text Source #
The name of the stream to delete.
Destructuring the Response
deleteStreamResponse :: DeleteStreamResponse Source #
Creates a value of DeleteStreamResponse
with the minimum fields required to make a request.
data DeleteStreamResponse Source #
See: deleteStreamResponse
smart constructor.