#[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>,
}
Expand description
Represents the input of a GetShardIterator
operation.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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§
source§impl GetShardIteratorInput
impl GetShardIteratorInput
sourcepub fn stream_arn(&self) -> Option<&str>
pub fn stream_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) for the stream.
sourcepub fn shard_id(&self) -> Option<&str>
pub fn shard_id(&self) -> Option<&str>
The identifier of the shard. The iterator will be returned for this shard ID.
sourcepub fn shard_iterator_type(&self) -> Option<&ShardIteratorType>
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.
sourcepub fn sequence_number(&self) -> Option<&str>
pub fn sequence_number(&self) -> Option<&str>
The sequence number of a stream record in the shard from which to start reading.
source§impl GetShardIteratorInput
impl GetShardIteratorInput
sourcepub fn builder() -> GetShardIteratorInputBuilder
pub fn builder() -> GetShardIteratorInputBuilder
Creates a new builder-style object to manufacture GetShardIteratorInput
.
Trait Implementations§
source§impl Clone for GetShardIteratorInput
impl Clone for GetShardIteratorInput
source§fn clone(&self) -> GetShardIteratorInput
fn clone(&self) -> GetShardIteratorInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for GetShardIteratorInput
impl Debug for GetShardIteratorInput
source§impl PartialEq for GetShardIteratorInput
impl PartialEq for GetShardIteratorInput
source§fn eq(&self, other: &GetShardIteratorInput) -> bool
fn eq(&self, other: &GetShardIteratorInput) -> bool
self
and other
values to be equal, and is used
by ==
.