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.
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.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDeleteStream and EndDeleteStream.
Namespace: Amazon.Kinesis
Assembly: AWSSDK.Kinesis.dll
Version: 3.x.y.z
public abstract Task<DeleteStreamResponse> DeleteStreamAsync( DeleteStreamRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the DeleteStream service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| AccessDeniedException | Specifies that you do not have the permissions required to perform this operation. |
| InvalidArgumentException | A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. |
| LimitExceededException | The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed. |
| ResourceInUseException | The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state. |
| ResourceNotFoundException | The requested resource could not be found. The stream might not be specified correctly. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5