Struct rusoto_kinesis::GetShardIteratorInput

pub struct GetShardIteratorInput {
    pub shard_id: String,
    pub shard_iterator_type: String,
    pub starting_sequence_number: Option<String>,
    pub stream_name: String,
    pub timestamp: Option<f64>,
}

Represents the input for GetShardIterator.

Fields

shard_id: String

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

shard_iterator_type: String

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:

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

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

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

• TRIMHORIZON - 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.

stream_name: String

The name of the Amazon Kinesis stream.

timestamp: Option<f64>

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 Default for GetShardIteratorInput

fn default() -> GetShardIteratorInput

Returns the "default value" for a type.

impl Debug for GetShardIteratorInput

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

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.