AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the DeleteStream operation.
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
When invoking this API, you must use either the ResourceNotFoundException
.
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.
Namespace: Amazon.Kinesis.Model
Assembly: AWSSDK.Kinesis.dll
Version: 3.x.y.z
public class DeleteStreamRequest : AmazonKinesisRequest IAmazonWebServiceRequest
The DeleteStreamRequest type exposes the following members
Name | Description | |
---|---|---|
DeleteStreamRequest() |
Name | Type | Description | |
---|---|---|---|
EnforceConsumerDeletion | System.Boolean |
Gets and sets the property EnforceConsumerDeletion.
If this parameter is unset ( |
|
StreamARN | System.String |
Gets and sets the property StreamARN. The ARN of the stream. |
|
StreamName | System.String |
Gets and sets the property StreamName. The name of the stream to delete. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5