Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Kinesis.Types.StartingPosition

Description

Documentation

data StartingPosition Source #

See: newStartingPosition smart constructor.

Constructors

StartingPosition'

Fields

sequenceNumber :: Maybe Text
The sequence number of the data record in the shard from which to start streaming. To specify a sequence number, set StartingPosition to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.
timestamp :: Maybe POSIX
The time stamp of the data record from which to start reading. To specify a time stamp, set StartingPosition to 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, 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' :: ShardIteratorType
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 the SequenceNumber field.
AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted by the sequence number specified in the SequenceNumber field.
AT_TIMESTAMP: Start streaming from the position denoted by the time stamp specified in the Timestamp 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.

Instances

Instances details

Eq StartingPosition Source #
Instance details Defined in Amazonka.Kinesis.Types.StartingPosition Methods (==) :: StartingPosition -> StartingPosition -> Bool # (/=) :: StartingPosition -> StartingPosition -> Bool #
Read StartingPosition Source #
Instance details Defined in Amazonka.Kinesis.Types.StartingPosition Methods readsPrec :: Int -> ReadS StartingPosition # readList :: ReadS [StartingPosition] # readPrec :: ReadPrec StartingPosition # readListPrec :: ReadPrec [StartingPosition] #
Show StartingPosition Source #
Instance details Defined in Amazonka.Kinesis.Types.StartingPosition Methods showsPrec :: Int -> StartingPosition -> ShowS # show :: StartingPosition -> String # showList :: [StartingPosition] -> ShowS #
Generic StartingPosition Source #
Instance details Defined in Amazonka.Kinesis.Types.StartingPosition Associated Types type Rep StartingPosition :: Type -> Type # Methods from :: StartingPosition -> Rep StartingPosition x # to :: Rep StartingPosition x -> StartingPosition #
NFData StartingPosition Source #
Instance details Defined in Amazonka.Kinesis.Types.StartingPosition Methods rnf :: StartingPosition -> () #
Hashable StartingPosition Source #
Instance details Defined in Amazonka.Kinesis.Types.StartingPosition Methods hashWithSalt :: Int -> StartingPosition -> Int # hash :: StartingPosition -> Int #
ToJSON StartingPosition Source #
Instance details Defined in Amazonka.Kinesis.Types.StartingPosition Methods toJSON :: StartingPosition -> Value # toEncoding :: StartingPosition -> Encoding # toJSONList :: [StartingPosition] -> Value # toEncodingList :: [StartingPosition] -> Encoding #
type Rep StartingPosition Source #
Instance details Defined in Amazonka.Kinesis.Types.StartingPosition type Rep StartingPosition = D1 ('MetaData "StartingPosition" "Amazonka.Kinesis.Types.StartingPosition" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "StartingPosition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sequenceNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShardIteratorType))))

newStartingPosition Source #

Arguments

:: ShardIteratorType	`$sel:type':StartingPosition'`
-> StartingPosition

Create a value of StartingPosition with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sequenceNumber:StartingPosition', startingPosition_sequenceNumber - The sequence number of the data record in the shard from which to start streaming. To specify a sequence number, set StartingPosition to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.

$sel:timestamp:StartingPosition', startingPosition_timestamp - The time stamp of the data record from which to start reading. To specify a time stamp, set StartingPosition to 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, 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).

$sel:type':StartingPosition', startingPosition_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 the SequenceNumber field.

AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted by the sequence number specified in the SequenceNumber field.

AT_TIMESTAMP: Start streaming from the position denoted by the time stamp specified in the Timestamp 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.

startingPosition_sequenceNumber :: Lens' StartingPosition (Maybe Text) Source #

The sequence number of the data record in the shard from which to start streaming. To specify a sequence number, set StartingPosition to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.

startingPosition_timestamp :: Lens' StartingPosition (Maybe UTCTime) Source #

The time stamp of the data record from which to start reading. To specify a time stamp, set StartingPosition to 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, 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).

startingPosition_type :: Lens' StartingPosition ShardIteratorType Source #

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 the SequenceNumber field.

AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted by the sequence number specified in the SequenceNumber field.

AT_TIMESTAMP: Start streaming from the position denoted by the time stamp specified in the Timestamp 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.