kinesis_merge_shards: Merges two adjacent shards in a Kinesis data stream and...

View source: R/kinesis_operations.R

kinesis_merge_shardsR Documentation

Merges two adjacent shards in a Kinesis data stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data

Description

Merges two adjacent shards in a Kinesis data stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. This API is only supported for the data streams with the provisioned capacity mode. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards.

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

Usage

kinesis_merge_shards(
  StreamName = NULL,
  ShardToMerge,
  AdjacentShardToMerge,
  StreamARN = NULL
)

Arguments

StreamName

The name of the stream for the merge.

ShardToMerge

[required] The shard ID of the shard to combine with the adjacent shard for the merge.

AdjacentShardToMerge

[required] The shard ID of the adjacent shard for the merge.

StreamARN

The ARN of the stream.


paws.analytics documentation built on Sept. 11, 2023, 5:06 p.m.