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.
When invoking this API, you must use either the 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. This API is only supported for the data
streams with the provisioned capacity mode.
StreamARN
or the StreamName
parameter, or both. It is recommended that you use the StreamARN
input parameter
when you invoke this API.
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 SplitShard
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 DescribeStreamSummary and the ListShards APIs to determine
the shard ID and hash key values for the ShardToSplit
and NewStartingHashKey
parameters that are specified in the SplitShard
request.
SplitShard
is an asynchronous operation. Upon receiving a SplitShard
request, Kinesis Data Streams immediately returns a response and sets the stream status
to 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 UPDATING
state.
You can use DescribeStreamSummary to check the status of the stream, which
is returned in StreamStatus
. If the stream is in the ACTIVE
state, you
can call SplitShard
.
If the specified stream does not exist, DescribeStreamSummary returns a ResourceNotFoundException
.
If you try to create more shards than are authorized for your account, you receive
a LimitExceededException
.
For the default shard limit for an Amazon Web Services account, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact Amazon Web Services Support.
If you try to operate on too many streams simultaneously using CreateStream,
DeleteStream, MergeShards, and/or SplitShard, you receive a LimitExceededException
.
SplitShard
has a limit of five transactions per second per account.
Namespace: Amazon.Kinesis.Model
Assembly: AWSSDK.Kinesis.dll
Version: 3.x.y.z
public class SplitShardRequest : AmazonKinesisRequest IAmazonWebServiceRequest
The SplitShardRequest type exposes the following members
Name | Description | |
---|---|---|
SplitShardRequest() |
Name | Type | Description | |
---|---|---|---|
NewStartingHashKey | System.String |
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 |
|
ShardToSplit | System.String |
Gets and sets the property ShardToSplit. The shard ID of the shard to split. |
|
StreamARN | System.String |
Gets and sets the property StreamARN. The ARN of the stream. |
|
StreamName | System.String |
Gets and sets the property StreamName. The name of the stream for the shard split. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5