Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SubscribeToShardEvent

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

Hierarchy

  • SubscribeToShardEvent

Index

Properties

Optional ChildShards

ChildShards: ChildShard[]

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

ContinuationSequenceNumber

ContinuationSequenceNumber: string | undefined

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

MillisBehindLatest: number | undefined

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.

Records

Records: _Record[] | undefined