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.
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
After the update is complete, Kinesis Data Streams sets the status of the stream back
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
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. We recommend that you double or halve the shard count, as this results in the fewest number of splits or merges.
This operation has the following default limits. By default, you cannot do the following:
Scale more than twice 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 500 shards in a stream
Scale a stream with more than 500 shards down unless the result is less than 500 shards
Scale up to more than the shard limit for your account
For the default limits for an AWS 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.
For .NET Core, PCL and Unity this operation is only available in asynchronous form. Please refer to UpdateShardCountAsync.
public virtual UpdateShardCountResponse UpdateShardCount( UpdateShardCountRequest request )
Container for the necessary parameters to execute the UpdateShardCount 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.|
|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.|
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