Struct GetShardIteratorInput

#[non_exhaustive]
pub struct GetShardIteratorInput {
    pub stream_arn: Option<String>,
    pub shard_id: Option<String>,
    pub shard_iterator_type: Option<ShardIteratorType>,
    pub sequence_number: Option<String>,
}

Represents the input of a GetShardIterator operation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

stream_arn: Option<String>

The Amazon Resource Name (ARN) for the stream.

shard_id: Option<String>

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

shard_iterator_type: Option<ShardIteratorType>

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.

sequence_number: Option<String>

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

Implementations

impl GetShardIteratorInput

pub fn stream_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) for the stream.

pub fn shard_id(&self) -> Option<&str>

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

pub fn shard_iterator_type(&self) -> Option<&ShardIteratorType>

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) -> Option<&str>

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

impl GetShardIteratorInput

pub fn builder() -> GetShardIteratorInputBuilder

Creates a new builder-style object to manufacture GetShardIteratorInput.

Trait Implementations

impl Clone for GetShardIteratorInput

fn clone(&self) -> GetShardIteratorInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetShardIteratorInput

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

Formats the value using the given formatter.

impl PartialEq for GetShardIteratorInput

fn eq(&self, other: &GetShardIteratorInput) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetShardIteratorInput