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>,
}

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) of the stream for which to get the shard iterator. The ARN uniquely identifies the stream within Amazon Keyspaces.

shard_id: Option<String>

The identifier of the shard within the stream. The shard ID uniquely identifies a subset of the stream's data records that you want to access.

shard_iterator_type: Option<ShardIteratorType>

Determines how the shard iterator is positioned. Must be one of the following:

• TRIM_HORIZON - Start reading at the last untrimmed record in the shard, which is the oldest data record in the shard.

• AT_SEQUENCE_NUMBER - Start reading exactly from the specified sequence number.

• AFTER_SEQUENCE_NUMBER - Start reading right after the specified sequence number.

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

sequence_number: Option<String>

The sequence number of the data record in the shard from which to start reading. Required if ShardIteratorType is AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. This parameter is ignored for other iterator types.

Implementations

impl GetShardIteratorInput

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

The Amazon Resource Name (ARN) of the stream for which to get the shard iterator. The ARN uniquely identifies the stream within Amazon Keyspaces.

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

The identifier of the shard within the stream. The shard ID uniquely identifies a subset of the stream's data records that you want to access.

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

Determines how the shard iterator is positioned. Must be one of the following:

• TRIM_HORIZON - Start reading at the last untrimmed record in the shard, which is the oldest data record in the shard.

• AT_SEQUENCE_NUMBER - Start reading exactly from the specified sequence number.

• AFTER_SEQUENCE_NUMBER - Start reading right after the specified sequence number.

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

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

The sequence number of the data record in the shard from which to start reading. Required if ShardIteratorType is AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. This parameter is ignored for other iterator types.

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.

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

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