Struct rusoto_kinesis::GetShardIteratorInput
[−]
[src]
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
The shard ID of the Amazon Kinesis shard to get the iterator for.
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 timestamp, 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.
stream_name: String
The name of the Amazon Kinesis stream.
timestamp: Option<f64>
The timestamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A timestamp 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 timestamp does not exist, the iterator returned is for the next (later) record. If the timestamp 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
[src]
fn default() -> GetShardIteratorInput
Returns the "default value" for a type. Read more
impl Debug for GetShardIteratorInput
[src]
impl Clone for GetShardIteratorInput
[src]
fn clone(&self) -> GetShardIteratorInput
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0
Performs copy-assignment from source
. Read more