AWS SDK Version 3 for .NET
API Reference

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 delivery stream and its data.

You can delete a delivery stream only if it is in ACTIVE or DELETING state, and not in the CREATING state. While the deletion request is in process, the delivery stream is in the DELETING state.

To check the state of a delivery stream, use DescribeDeliveryStream.

While the delivery stream is DELETING state, the service may continue to accept the records, but the service doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, you should first stop any applications that are sending records before deleting a delivery stream.

Note:

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 BeginDeleteDeliveryStream and EndDeleteDeliveryStream. For Unity the operation does not take CancellationToken as a parameter, and instead takes AmazonServiceCallback<DeleteDeliveryStreamRequest, DeleteDeliveryStreamResponse> and AsyncOptions as additional parameters.

Namespace: Amazon.KinesisFirehose
Assembly: AWSSDK.KinesisFirehose.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<DeleteDeliveryStreamResponse> DeleteDeliveryStreamAsync(
         String deliveryStreamName,
         CancellationToken cancellationToken
)
Parameters
deliveryStreamName
Type: System.String

The name of the delivery stream.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value
The response from the DeleteDeliveryStream service method, as returned by KinesisFirehose.

Exceptions

ExceptionCondition
ResourceInUseException The resource is already in use and not available for this operation.
ResourceNotFoundException The specified resource could not be found.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone

See Also