Skip to content

SubscribeToShardEvent

Source code in docs_src/capo_kinesis/types/subscribe_to_shard_event.py 
18
19
20
21
22
23
24
25
26
class SubscribeToShardEvent(TypedDict, closed=True):
    records: "capo_kinesis.types.record_list.RecordList"
    """<p></p>"""
    continuation_sequence_number: "capo_kinesis.types.sequence_number.SequenceNumber"
    """<p>Use this as <code>SequenceNumber</code> in the next call to <a>SubscribeToShard</a>, with <code>StartingPosition</code> set to <code>AT_SEQUENCE_NUMBER</code> or <code>AFTER_SEQUENCE_NUMBER</code>. Use <code>ContinuationSequenceNumber</code> for checkpointing because it captures your shard progress even when no data is written to the shard.</p>"""
    millis_behind_latest: "capo_kinesis.types.millis_behind_latest.MillisBehindLatest"
    """<p>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.</p>"""
    child_shards: NotRequired["capo_kinesis.types.child_shard_list.ChildShardList"]
    """<p>The list of the child shards of the current shard, returned only at the end of the current shard.</p>"""

child_shards instance-attribute 

child_shards: NotRequired[ChildShardList]

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: SequenceNumber

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: 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.

records instance-attribute 

records: RecordList