Struct aws_sdk_kinesis::client::fluent_builders::DescribeStreamSummary

pub struct DescribeStreamSummary { /* private fields */ }

Fluent builder constructing a request to DescribeStreamSummary.

Provides a summarized description of the specified Kinesis data stream without the shard list.

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

The information returned includes the stream name, Amazon Resource Name (ARN), status, record retention period, approximate creation time, monitoring, encryption details, and open shard count.

DescribeStreamSummary has a limit of 20 transactions per second per account.

Implementations

impl DescribeStreamSummary

pub async fn customize(
    self
) -> Result<CustomizableOperation<DescribeStreamSummary, AwsResponseRetryClassifier>, SdkError<DescribeStreamSummaryError>>

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<DescribeStreamSummaryOutput, SdkError<DescribeStreamSummaryError>>

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

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

The name of the stream to describe.

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 DescribeStreamSummary

fn clone(&self) -> DescribeStreamSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeStreamSummary

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

Formats the value using the given formatter.