kinesis_split_shard: Splits a shard into two new shards in the Kinesis data stream, to increase the stream's capacity to ingest and transport data

Description

Splits a shard into two new shards in the Kinesis data stream, to increase the stream's capacity to ingest and transport data. split_shard is called when there is a need to increase the overall capacity of a stream because of an expected increase in the volume of data records being ingested. This API is only supported for the data streams with the provisioned capacity mode.

See https://www.paws-r-sdk.com/docs/kinesis_split_shard/ for full documentation.

Usage

kinesis_split_shard(
  StreamName = NULL,
  ShardToSplit,
  NewStartingHashKey,
  StreamARN = NULL
)

Arguments

StreamName: The name of the stream for the shard split.
ShardToSplit: [required] The shard ID of the shard to split.
NewStartingHashKey: [required] 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.
StreamARN: The ARN of the stream.