Skip to content

SplitShardInput

Source code in docs_src/capo_kinesis/types/split_shard_input.py
class SplitShardInput(TypedDict, closed=True):
    stream_name: NotRequired["capo_kinesis.types.stream_name.StreamName"]
    """<p>The name of the stream for the shard split.</p>"""
    shard_to_split: "capo_kinesis.types.shard_id.ShardId"
    """<p>The shard ID of the shard to split.</p>"""
    new_starting_hash_key: "capo_kinesis.types.hash_key.HashKey"
    """<p>A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for <code>NewStartingHashKey</code> must be in the range of hash keys being mapped into the shard. The <code>NewStartingHashKey</code> hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.</p>"""
    stream_arn: NotRequired["capo_kinesis.types.stream_arn.StreamARN"]
    """<p>The ARN of the stream.</p>"""
    stream_id: NotRequired["capo_kinesis.types.stream_id.StreamId"]
    """<p>Not Implemented. Reserved for future use.</p>"""

new_starting_hash_key instance-attribute

new_starting_hash_key: HashKey

A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for NewStartingHashKey must be in the range of hash keys being mapped into the shard. The NewStartingHashKey hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.

shard_to_split instance-attribute

shard_to_split: ShardId

The shard ID of the shard to split.

stream_arn instance-attribute

stream_arn: NotRequired[StreamARN]

The ARN of the stream.

stream_id instance-attribute

stream_id: NotRequired[StreamId]

Not Implemented. Reserved for future use.

stream_name instance-attribute

stream_name: NotRequired[StreamName]

The name of the stream for the shard split.