Splits a shard into two new shards in the Amazon Kinesis stream to increase the stream's
capacity to ingest and transport data.
SplitShard 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.
You can also use
SplitShard when a shard appears to be approaching its
maximum utilization; for example, the producers sending data into the specific shard
are suddenly sending more than previously anticipated. You can also call
to increase stream capacity, so that more Amazon Kinesis applications can simultaneously
read data from the stream for real-time processing.
You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might simply be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information about splitting shards, see Split a Shard in the Amazon Kinesis Streams Developer Guide.
You can use DescribeStream to determine the shard ID and hash key values for
NewStartingHashKey parameters that
are specified in the
SplitShard is an asynchronous operation. Upon receiving a
request, Amazon Kinesis immediately returns a response and sets the stream status
UPDATING. After the operation is completed, Amazon Kinesis sets the
stream status to
ACTIVE. Read and write operations continue to work while
the stream is in the
You can use
DescribeStream to check the status of the stream, which is
StreamStatus. If the stream is in the
state, you can call
SplitShard. If a stream is in
If the specified stream does not exist,
DescribeStream returns a
If you try to create more shards than are authorized for your account, you receive
SplitShard has limit of 5 transactions per second per account.
For PCL and Unity this operation is only available in asynchronous form. Please refer to SplitShardAsync.
public virtual SplitShardResponse SplitShard( SplitShardRequest request )
Container for the necessary parameters to execute the SplitShard 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
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