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.
Updates the shard count of the specified stream to the specified number of shards.
This API is only supported for the data streams with the provisioned capacity mode.
When invoking this API, you must use either the StreamARN
or the StreamName
parameter, or both. It is recommended that you use the StreamARN
input parameter
when you invoke this API.
Updating the shard count is an asynchronous operation. Upon receiving the request,
Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING
.
After the update is complete, Kinesis Data Streams sets the status of the stream back
to ACTIVE
. Depending on the size of the stream, the scaling action could take
a few minutes to complete. You can continue to read and write data to your stream
while its status is UPDATING
.
To update the shard count, Kinesis Data Streams performs splits or merges on individual shards. This can cause short-lived shards to be created, in addition to the final shards. These short-lived shards count towards your total shard limit for your account in the Region.
When using this operation, we recommend that you specify a target shard count that is a multiple of 25% (25%, 50%, 75%, 100%). You can specify any target value within your shard limit. However, if you specify a target that isn't a multiple of 25%, the scaling action might take longer to complete.
This operation has the following default limits. By default, you cannot do the following:
Scale more than ten times per rolling 24-hour period per stream
Scale up to more than double your current shard count for a stream
Scale down below half your current shard count for a stream
Scale up to more than 10000 shards in a stream
Scale a stream with more than 10000 shards down unless the result is less than 10000 shards
Scale up to more than the shard limit for your account
Make over 10 TPS. TPS over 10 will trigger the LimitExceededException
For the default limits for an Amazon Web Services account, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To request an increase in the call rate limit, the shard limit for this API, or your overall shard limit, use the limits form.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginUpdateShardCount and EndUpdateShardCount.
Namespace: Amazon.Kinesis
Assembly: AWSSDK.Kinesis.dll
Version: 3.x.y.z
public virtual Task<UpdateShardCountResponse> UpdateShardCountAsync( UpdateShardCountRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the UpdateShardCount service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Exception | Condition |
---|---|
AccessDeniedException | Specifies that you do not have the permissions required to perform this operation. |
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. |
ResourceInUseException | The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state. |
ResourceNotFoundException | The requested resource could not be found. The stream might not be specified correctly. |
ValidationException | Specifies that you tried to invoke this API for a data stream with the on-demand capacity mode. This API is only supported for data streams with the provisioned capacity mode. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5