AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Merges two adjacent shards in an Amazon Kinesis stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. 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.
MergeShards is 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 Streams Developer Guide.
If the stream is in the
ACTIVE state, you can call
If a stream is in the
MergeShards returns a
the specified stream does not exist,
MergeShards returns a
You can use DescribeStream to check the state of the stream, which is returned
MergeShards is an asynchronous operation. Upon receiving a
request, Amazon Kinesis immediately returns a response and sets the
UPDATING. After the operation is completed, Amazon Kinesis sets the
ACTIVE. Read and write operations continue
to work while the stream is in the
You use DescribeStream to determine the shard IDs that are specified in the
MergeShards has limit of 5 transactions per second per account.
For PCL and Unity this operation is only available in asynchronous form. Please refer to MergeShardsAsync.
public virtual MergeShardsResponse MergeShards( MergeShardsRequest request )
Container for the necessary parameters to execute the MergeShards service method.
|InvalidArgumentException||A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.|
|LimitExceededException||The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).|
|ResourceInUseException||The resource is not available for this operation. For successful operation, the resource needs to be in the ACTIVE state.|
|ResourceNotFoundException||The requested resource could not be found. The stream might not be specified correctly.|
Supported in: 4.5, 4.0, 3.5
Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone