Skip to content

Shard

Source code in docs_src/capo_kinesis/types/shard.py
class Shard(TypedDict, closed=True):
    shard_id: "capo_kinesis.types.shard_id.ShardId"
    """<p>The unique identifier of the shard within the stream.</p>"""
    parent_shard_id: NotRequired["capo_kinesis.types.shard_id.ShardId"]
    """<p>The shard ID of the shard's parent.</p>"""
    adjacent_parent_shard_id: NotRequired["capo_kinesis.types.shard_id.ShardId"]
    """<p>The shard ID of the shard adjacent to the shard's parent.</p>"""
    hash_key_range: "capo_kinesis.types.hash_key_range.HashKeyRange"
    """<p>The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.</p>"""
    sequence_number_range: (
        "capo_kinesis.types.sequence_number_range.SequenceNumberRange"
    )
    """<p>The range of possible sequence numbers for the shard.</p>"""

adjacent_parent_shard_id instance-attribute

adjacent_parent_shard_id: NotRequired[ShardId]

The shard ID of the shard adjacent to the shard's parent.

hash_key_range instance-attribute

hash_key_range: HashKeyRange

The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.

parent_shard_id instance-attribute

parent_shard_id: NotRequired[ShardId]

The shard ID of the shard's parent.

sequence_number_range instance-attribute

sequence_number_range: SequenceNumberRange

The range of possible sequence numbers for the shard.

shard_id instance-attribute

shard_id: ShardId

The unique identifier of the shard within the stream.