| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Kinesis.DeleteStream
Description
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, it is recommended you use the StreamARN input
parameter rather than the StreamName input parameter.
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.
Synopsis
- data DeleteStream = DeleteStream' {}
- newDeleteStream :: DeleteStream
- deleteStream_enforceConsumerDeletion :: Lens' DeleteStream (Maybe Bool)
- deleteStream_streamARN :: Lens' DeleteStream (Maybe Text)
- deleteStream_streamName :: Lens' DeleteStream (Maybe Text)
- data DeleteStreamResponse = DeleteStreamResponse' {
- newDeleteStreamResponse :: DeleteStreamResponse
Creating a Request
data DeleteStream Source #
Represents the input for DeleteStream.
See: newDeleteStream smart constructor.
Constructors
| DeleteStream' | |
Fields
| |
Instances
newDeleteStream :: DeleteStream Source #
Create a value of DeleteStream with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enforceConsumerDeletion:DeleteStream', deleteStream_enforceConsumerDeletion - If this parameter is unset (null) or if you set it to false, and the
stream has registered consumers, the call to DeleteStream fails with a
ResourceInUseException.
DeleteStream, deleteStream_streamARN - The ARN of the stream.
DeleteStream, deleteStream_streamName - The name of the stream to delete.
Request Lenses
deleteStream_enforceConsumerDeletion :: Lens' DeleteStream (Maybe Bool) Source #
If this parameter is unset (null) or if you set it to false, and the
stream has registered consumers, the call to DeleteStream fails with a
ResourceInUseException.
deleteStream_streamARN :: Lens' DeleteStream (Maybe Text) Source #
The ARN of the stream.
deleteStream_streamName :: Lens' DeleteStream (Maybe Text) Source #
The name of the stream to delete.
Destructuring the Response
data DeleteStreamResponse Source #
See: newDeleteStreamResponse smart constructor.
Constructors
| DeleteStreamResponse' | |
Instances
newDeleteStreamResponse :: DeleteStreamResponse Source #
Create a value of DeleteStreamResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.