Skip to content

Kinesis  >  Structures  >  SubscribeToShardEvent

SubscribeToShardEvent

Structure Class

SubscribeToShardEvent dataclass

Bases: _SerdeShape

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

Attributes

child_shards class-attribute instance-attribute
child_shards: list[ChildShard] | None = ...

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

continuation_sequence_number instance-attribute
continuation_sequence_number: str

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.

millis_behind_latest instance-attribute
millis_behind_latest: int

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 instance-attribute
records: list[Record]