Struct aws_sdk_firehose::client::fluent_builders::DescribeDeliveryStream

pub struct DescribeDeliveryStream<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to DescribeDeliveryStream.

Describes the specified delivery stream and its status. For example, after your delivery stream is created, call DescribeDeliveryStream to see whether the delivery stream is ACTIVE and therefore ready for data to be sent to it.

If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it. If the status is DELETING_FAILED, you can force deletion by invoking DeleteDeliveryStream again but with DeleteDeliveryStreamInput$AllowForceDelete set to true.

Implementations

impl<C, M, R> DescribeDeliveryStream<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<DescribeDeliveryStreamOutput, SdkError<DescribeDeliveryStreamError>> where
    R::Policy: SmithyRetryPolicy<DescribeDeliveryStreamInputOperationOutputAlias, DescribeDeliveryStreamOutput, DescribeDeliveryStreamError, DescribeDeliveryStreamInputOperationRetryAlias>, 

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 delivery_stream_name(self, inp: impl Into<String>) -> Self

The name of the delivery stream.

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

The name of the delivery stream.

pub fn limit(self, inp: i32) -> Self

The limit on the number of destinations to return. You can have one destination per delivery stream.

pub fn set_limit(self, input: Option<i32>) -> Self

The limit on the number of destinations to return. You can have one destination per delivery stream.

pub fn exclusive_start_destination_id(self, inp: impl Into<String>) -> Self

The ID of the destination to start returning the destination information. Kinesis Data Firehose supports one destination per delivery stream.

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

The ID of the destination to start returning the destination information. Kinesis Data Firehose supports one destination per delivery stream.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for DescribeDeliveryStream<C, M, R>

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

Formats the value using the given formatter.