KinesisVideo / Client / delete_stream

delete_stream#

KinesisVideo.Client.delete_stream(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_stream(
    StreamARN='string',
    CurrentVersion='string'
)
Parameters:

  • StreamARN (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the stream that you want to delete.

  • CurrentVersion (string) –

    Optional: The version of the stream that you want to delete.

    Specify the version as a safeguard to ensure that your are deleting the correct stream. To get the stream version, use the DescribeStream API.

    If not specified, only the CreationTime is checked before deleting the stream.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • KinesisVideo.Client.exceptions.ClientLimitExceededException

  • KinesisVideo.Client.exceptions.InvalidArgumentException

  • KinesisVideo.Client.exceptions.ResourceNotFoundException

  • KinesisVideo.Client.exceptions.NotAuthorizedException

  • KinesisVideo.Client.exceptions.VersionMismatchException

  • KinesisVideo.Client.exceptions.ResourceInUseException