Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kinesis.Types.SubscribeToShardEvent

Description

Documentation

data SubscribeToShardEvent Source #

After you call SubscribeToShard, Kinesis Data Streams sends events of this type over an HTTP/2 connection to your consumer.

See: newSubscribeToShardEvent smart constructor.

Constructors

SubscribeToShardEvent'

Fields

childShards :: Maybe [ChildShard]
The list of the child shards of the current shard, returned only at the end of the current shard.
records :: [Record]
continuationSequenceNumber :: Text
Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use ContinuationSequenceNumber for checkpointing because it captures your shard progress even when no data is written to the shard.
millisBehindLatest :: Natural
The number of milliseconds the read records are from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.

Instances

Instances details

FromJSON SubscribeToShardEvent Source #
Instance details Defined in Amazonka.Kinesis.Types.SubscribeToShardEvent Methods parseJSON :: Value -> Parser SubscribeToShardEvent # parseJSONList :: Value -> Parser [SubscribeToShardEvent] #
Generic SubscribeToShardEvent Source #
Instance details Defined in Amazonka.Kinesis.Types.SubscribeToShardEvent Associated Types type Rep SubscribeToShardEvent :: Type -> Type # Methods from :: SubscribeToShardEvent -> Rep SubscribeToShardEvent x # to :: Rep SubscribeToShardEvent x -> SubscribeToShardEvent #
Read SubscribeToShardEvent Source #
Instance details Defined in Amazonka.Kinesis.Types.SubscribeToShardEvent Methods readsPrec :: Int -> ReadS SubscribeToShardEvent # readList :: ReadS [SubscribeToShardEvent] # readPrec :: ReadPrec SubscribeToShardEvent # readListPrec :: ReadPrec [SubscribeToShardEvent] #
Show SubscribeToShardEvent Source #
Instance details Defined in Amazonka.Kinesis.Types.SubscribeToShardEvent Methods showsPrec :: Int -> SubscribeToShardEvent -> ShowS # show :: SubscribeToShardEvent -> String # showList :: [SubscribeToShardEvent] -> ShowS #
NFData SubscribeToShardEvent Source #
Instance details Defined in Amazonka.Kinesis.Types.SubscribeToShardEvent Methods rnf :: SubscribeToShardEvent -> () #
Eq SubscribeToShardEvent Source #
Instance details Defined in Amazonka.Kinesis.Types.SubscribeToShardEvent Methods (==) :: SubscribeToShardEvent -> SubscribeToShardEvent -> Bool # (/=) :: SubscribeToShardEvent -> SubscribeToShardEvent -> Bool #
Hashable SubscribeToShardEvent Source #
Instance details Defined in Amazonka.Kinesis.Types.SubscribeToShardEvent Methods hashWithSalt :: Int -> SubscribeToShardEvent -> Int # hash :: SubscribeToShardEvent -> Int #
type Rep SubscribeToShardEvent Source #
Instance details Defined in Amazonka.Kinesis.Types.SubscribeToShardEvent type Rep SubscribeToShardEvent = D1 ('MetaData "SubscribeToShardEvent" "Amazonka.Kinesis.Types.SubscribeToShardEvent" "amazonka-kinesis-2.0-AW1spVPMUGf3LUqQQ22bci" 'False) (C1 ('MetaCons "SubscribeToShardEvent'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "childShards") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ChildShard])) :: S1 ('MetaSel ('Just "records") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Record])) :: (S1 ('MetaSel ('Just "continuationSequenceNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "millisBehindLatest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))))

newSubscribeToShardEvent Source #

Arguments

:: Text	`$sel:continuationSequenceNumber:SubscribeToShardEvent'`
-> Natural	`$sel:millisBehindLatest:SubscribeToShardEvent'`
-> SubscribeToShardEvent

Create a value of SubscribeToShardEvent 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:childShards:SubscribeToShardEvent', subscribeToShardEvent_childShards - The list of the child shards of the current shard, returned only at the end of the current shard.

$sel:records:SubscribeToShardEvent', subscribeToShardEvent_records -

$sel:continuationSequenceNumber:SubscribeToShardEvent', subscribeToShardEvent_continuationSequenceNumber - Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use ContinuationSequenceNumber for checkpointing because it captures your shard progress even when no data is written to the shard.

$sel:millisBehindLatest:SubscribeToShardEvent', subscribeToShardEvent_millisBehindLatest - The number of milliseconds the read records are from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.

subscribeToShardEvent_childShards :: Lens' SubscribeToShardEvent (Maybe [ChildShard]) Source #

The list of the child shards of the current shard, returned only at the end of the current shard.

subscribeToShardEvent_records :: Lens' SubscribeToShardEvent [Record] Source #

subscribeToShardEvent_continuationSequenceNumber :: Lens' SubscribeToShardEvent Text Source #

Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use ContinuationSequenceNumber for checkpointing because it captures your shard progress even when no data is written to the shard.

subscribeToShardEvent_millisBehindLatest :: Lens' SubscribeToShardEvent Natural Source #

The number of milliseconds the read records are from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.