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.
Container for the parameters to the SplitShard operation.
Splits a shard into two new shards in the Kinesis data 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 Kinesis Data Streams 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 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, see Split a Shard in the Amazon Kinesis Data 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, Kinesis Data Streams immediately returns a response and sets the stream status
UPDATING. After the operation is completed, Kinesis Data Streams 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 a limit of five transactions per second per account.
public class SplitShardRequest : AmazonKinesisRequest IAmazonWebServiceRequest
The SplitShardRequest type exposes the following members
Gets and sets the property NewStartingHashKey.
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
Gets and sets the property ShardToSplit.
The shard ID of the shard to split.
Gets and sets the property StreamName.
The name of the stream for the shard split.
Supported in: 1.3
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