StartingPosition
The starting position in the data stream from which to start streaming.
Contents
- Type
-
You can set the starting position to one of the following values:
AT_SEQUENCE_NUMBER
: Start streaming from the position denoted by the sequence number specified in theSequenceNumber
field.AFTER_SEQUENCE_NUMBER
: Start streaming right after the position denoted by the sequence number specified in theSequenceNumber
field.AT_TIMESTAMP
: Start streaming from the position denoted by the time stamp specified in theTimestamp
field.TRIM_HORIZON
: Start streaming at the last untrimmed record in the shard, which is the oldest data record in the shard.LATEST
: Start streaming just after the most recent record in the shard, so that you always read the most recent data in the shard.Type: String
Valid Values:
AT_SEQUENCE_NUMBER | AFTER_SEQUENCE_NUMBER | TRIM_HORIZON | LATEST | AT_TIMESTAMP
Required: Yes
- SequenceNumber
-
The sequence number of the data record in the shard from which to start streaming. To specify a sequence number, set
StartingPosition
toAT_SEQUENCE_NUMBER
orAFTER_SEQUENCE_NUMBER
.Type: String
Pattern:
0|([1-9]\d{0,128})
Required: No
- Timestamp
-
The time stamp of the data record from which to start reading. To specify a time stamp, set
StartingPosition
toType AT_TIMESTAMP
. A time stamp is the Unix epoch date with precision in milliseconds. For example,2016-04-04T19:58:46.480-00:00
or1459799926.480
. If a record with this exact time stamp does not exist, records will be streamed from the next (later) record. If the time stamp is older than the current trim horizon, records will be streamed from the oldest untrimmed data record (TRIM_HORIZON
).Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: