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 Kinesis video stream and the data contained in the stream.

This method marks the stream for deletion, and makes the data in the stream inaccessible immediately.

To ensure that you have the latest version of the stream before deleting it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API.

This operation requires permission for the KinesisVideo:DeleteStream action.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to DeleteStreamAsync.

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

Syntax

C#
public abstract DeleteStreamResponse DeleteStream(
         DeleteStreamRequest request
)

Parameters

request
Type: Amazon.KinesisVideo.Model.DeleteStreamRequest

Container for the necessary parameters to execute the DeleteStream service method.

Return Value


The response from the DeleteStream service method, as returned by KinesisVideo.

Exceptions

ExceptionCondition
ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
InvalidArgumentException The value for this input parameter is invalid.
NotAuthorizedException The caller is not authorized to perform this operation.
ResourceInUseException When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following : The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to. The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to. The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.
ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
VersionMismatchException The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

See Also