Skip to contents

Deletes a Kinesis data stream and all its shards and data

Source: R/kinesis_operations.R
kinesis_delete_stream.Rd

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 ResourceNotFoundException.

See https://www.paws-r-sdk.com/docs/kinesis_delete_stream/ for full documentation.

Usage

kinesis_delete_stream(
  StreamName = NULL,
  EnforceConsumerDeletion = NULL,
  StreamARN = NULL,
  StreamId = NULL
)

Arguments

StreamName

The name of the stream to delete.

EnforceConsumerDeletion

If this parameter is unset (null) or if you set it to false, and the stream has registered consumers, the call to delete_stream fails with a ResourceInUseException.

StreamARN

The ARN of the stream.

StreamId

Not Implemented. Reserved for future use.