Struct aws_sdk_kinesis::client::fluent_builders::DeleteStream [−][src]
pub struct DeleteStream<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }
Expand description
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
.
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<C, M, R> DeleteStream<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> DeleteStream<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<DeleteStreamOutput, SdkError<DeleteStreamError>> where
R::Policy: SmithyRetryPolicy<DeleteStreamInputOperationOutputAlias, DeleteStreamOutput, DeleteStreamError, DeleteStreamInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<DeleteStreamOutput, SdkError<DeleteStreamError>> where
R::Policy: SmithyRetryPolicy<DeleteStreamInputOperationOutputAlias, DeleteStreamOutput, DeleteStreamError, DeleteStreamInputOperationRetryAlias>,
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.
The name of the stream to delete.
The name of the stream to delete.
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
.
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
.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for DeleteStream<C, M, R>
impl<C, M, R> Unpin for DeleteStream<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for DeleteStream<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more