Struct aws_sdk_kinesis::client::fluent_builders::DeleteStream

pub struct DeleteStream { /* private fields */ }

Fluent builder constructing a request to DeleteStream.

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.

When invoking this API, it is recommended you use the StreamARN input parameter rather than the StreamName input parameter.

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.

Implementations

impl DeleteStream

pub async fn customize(
    self
) -> Result<CustomizableOperation<DeleteStream, AwsResponseRetryClassifier>, SdkError<DeleteStreamError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<DeleteStreamOutput, SdkError<DeleteStreamError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn stream_name(self, input: impl Into<String>) -> Self

The name of the stream to delete.

pub fn set_stream_name(self, input: Option<String>) -> Self

The name of the stream to delete.

pub fn enforce_consumer_deletion(self, input: bool) -> Self

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

pub fn set_enforce_consumer_deletion(self, input: Option<bool>) -> Self

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

pub fn stream_arn(self, input: impl Into<String>) -> Self

The ARN of the stream.

pub fn set_stream_arn(self, input: Option<String>) -> Self

The ARN of the stream.

Trait Implementations

impl Clone for DeleteStream

fn clone(&self) -> DeleteStream

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DeleteStream

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.