Struct aws_sdk_kinesis::client::fluent_builders::DescribeStream

pub struct DescribeStream { /* private fields */ }

Fluent builder constructing a request to DescribeStream.

Describes the specified Kinesis data stream.

This API has been revised. It's highly recommended that you use the DescribeStreamSummary API to get a summarized description of the specified Kinesis data stream and the ListShards API to list the shards in a specified data stream and obtain information about each shard.

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), creation time, enhanced metric configuration, and shard map. The shard map is an array of shard objects. For each shard object, there is the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. Every record ingested in the stream is identified by a sequence number, which is assigned when the record is put into the stream.

You can limit the number of shards returned by each call. For more information, see Retrieving Shards from a Stream in the Amazon Kinesis Data Streams Developer Guide.

There are no guarantees about the chronological order shards returned. To process shards in chronological order, use the ID of the parent shard to track the lineage to the oldest shard.

This operation has a limit of 10 transactions per second per account.

Implementations

impl DescribeStream

pub async fn customize(
    self
) -> Result<CustomizableOperation<DescribeStream, AwsResponseRetryClassifier>, SdkError<DescribeStreamError>>

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<DescribeStreamOutput, SdkError<DescribeStreamError>>

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 limit(self, input: i32) -> Self

The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.

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

The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.

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

The shard ID of the shard to start with.

Specify this parameter to indicate that you want to describe the stream starting with the shard whose ID immediately follows ExclusiveStartShardId.

If you don't specify this parameter, the default behavior for DescribeStream is to describe the stream starting with the first shard in the stream.

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

The shard ID of the shard to start with.

Specify this parameter to indicate that you want to describe the stream starting with the shard whose ID immediately follows ExclusiveStartShardId.

If you don't specify this parameter, the default behavior for DescribeStream is to describe the stream starting with the first shard in the stream.

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 DescribeStream

fn clone(&self) -> DescribeStream

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeStream

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

Formats the value using the given formatter.