Struct aws_sdk_dynamodbstreams::client::fluent_builders::DescribeStream

pub struct DescribeStream { /* private fields */ }

Fluent builder constructing a request to DescribeStream.

Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table.

You can call DescribeStream at a maximum rate of 10 times per second.

Each shard in the stream has a SequenceNumberRange associated with it. If the SequenceNumberRange has a StartingSequenceNumber but no EndingSequenceNumber, then the shard is still open (able to receive more stream records). If both StartingSequenceNumber and EndingSequenceNumber are present, then that shard is closed and can no longer receive more data.

Implementations

impl DescribeStream

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

The Amazon Resource Name (ARN) for the stream.

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

The Amazon Resource Name (ARN) for the stream.

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

The maximum number of shard objects to return. The upper limit is 100.

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

The maximum number of shard objects to return. The upper limit is 100.

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

The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

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

The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

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.