Struct aws_sdk_kinesis::input::GetShardIteratorInput

#[non_exhaustive]
pub struct GetShardIteratorInput {
    pub stream_name: Option<String>,
    pub shard_id: Option<String>,
    pub shard_iterator_type: Option<ShardIteratorType>,
    pub starting_sequence_number: Option<String>,
    pub timestamp: Option<DateTime>,
}

Represents the input for GetShardIterator.

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_name: Option<String>

The name of the Amazon Kinesis data stream.

shard_id: Option<String>

The shard ID of the Kinesis Data Streams shard to get the iterator for.

shard_iterator_type: Option<ShardIteratorType>

Determines how the shard iterator is used to start reading data records from the shard.

The following are the valid Amazon Kinesis shard iterator types:

• AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

• AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

• AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.

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

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

starting_sequence_number: Option<String>

The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

timestamp: Option<DateTime>

The time stamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. If a record with this exact time stamp does not exist, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).

Implementations

impl GetShardIteratorInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<GetShardIterator, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<GetShardIterator>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture GetShardIteratorInput

impl GetShardIteratorInput

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

The name of the Amazon Kinesis data stream.

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

The shard ID of the Kinesis Data Streams shard to get the iterator for.

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

Determines how the shard iterator is used to start reading data records from the shard.

The following are the valid Amazon Kinesis shard iterator types:

• AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

• AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

• AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.

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

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

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

The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

pub fn timestamp(&self) -> Option<&DateTime>

The time stamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. If a record with this exact time stamp does not exist, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).

Trait Implementations

impl Clone for GetShardIteratorInput

fn clone(&self) -> GetShardIteratorInput

Returns a copy 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<GetShardIteratorInput> for GetShardIteratorInput

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for GetShardIteratorInput