Struct aws_sdk_dynamodbstreams::client::fluent_builders::GetShardIterator

pub struct GetShardIterator { /* private fields */ }

Fluent builder constructing a request to GetShardIterator.

Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent GetRecords request to read the stream records from the shard.

A shard iterator expires 15 minutes after it is returned to the requester.

Implementations

impl GetShardIterator

pub async fn send(
    self
) -> Result<GetShardIteratorOutput, SdkError<GetShardIteratorError>>

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

The identifier of the shard. The iterator will be returned for this shard ID.

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

The identifier of the shard. The iterator will be returned for this shard ID.

pub fn shard_iterator_type(self, input: ShardIteratorType) -> Self

Determines how the shard iterator is used to start reading stream records from the shard:

• AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

• AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

• TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

• LATEST - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.

pub fn set_shard_iterator_type(self, input: Option<ShardIteratorType>) -> Self

Determines how the shard iterator is used to start reading stream records from the shard:

• AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

• AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

• TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

• LATEST - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.

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

The sequence number of a stream record in the shard from which to start reading.

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

The sequence number of a stream record in the shard from which to start reading.

Trait Implementations

impl Clone for GetShardIterator

fn clone(&self) -> GetShardIterator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetShardIterator

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

Formats the value using the given formatter.