Kinesis / Client / merge_shards
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.
When invoking this API, it is recommended you use the
StreamARNinput parameter rather than the
MergeShardsis called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see Merge Two Shards in the Amazon Kinesis Data Streams Developer Guide.
If the stream is in the
ACTIVEstate, you can call
MergeShards. If a stream is in the
ResourceInUseException. If the specified stream does not exist,
You can use DescribeStreamSummary to check the state of the stream, which is returned in
MergeShardsis an asynchronous operation. Upon receiving a
MergeShardsrequest, Amazon Kinesis Data Streams immediately returns a response and sets the
UPDATING. After the operation is completed, Kinesis Data Streams sets the
ACTIVE. Read and write operations continue to work while the stream is in the
You use DescribeStreamSummary and the ListShards APIs to determine the shard IDs that are specified in the
If you try to operate on too many streams in parallel using CreateStream, DeleteStream,
MergeShards, or SplitShard, you receive a
MergeShardshas a limit of five transactions per second per account.
See also: AWS API Documentation
response = client.merge_shards( StreamName='string', ShardToMerge='string', AdjacentShardToMerge='string', StreamARN='string' )
StreamName (string) – The name of the stream for the merge.
ShardToMerge (string) –
The shard ID of the shard to combine with the adjacent shard for the merge.
AdjacentShardToMerge (string) –
The shard ID of the adjacent shard for the merge.
StreamARN (string) – The ARN of the stream.