UpdateShardCountCommand

Suggest an Edit

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 .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { KinesisClient, UpdateShardCountCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
// const { KinesisClient, UpdateShardCountCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
const client = new KinesisClient(config);
const input = { // UpdateShardCountInput
  StreamName: "STRING_VALUE",
  TargetShardCount: Number("int"), // required
  ScalingType: "UNIFORM_SCALING", // required
  StreamARN: "STRING_VALUE",
};
const command = new UpdateShardCountCommand(input);
const response = await client.send(command);
// { // UpdateShardCountOutput
//   StreamName: "STRING_VALUE",
//   CurrentShardCount: Number("int"),
//   TargetShardCount: Number("int"),
//   StreamARN: "STRING_VALUE",
// };

UpdateShardCountCommand Input

See UpdateShardCountCommandInput for more details

Parameter
Type
Description
ScalingType
Required
ScalingType | undefined

The scaling type. Uniform scaling creates shards of equal size.

TargetShardCount
Required
number | undefined

The new number of shards. This value has the following default limits. By default, you cannot do the following:

  • Set this value to more than double your current shard count for a stream.

  • Set this value below half your current shard count for a stream.

  • Set this value to more than 10000 shards in a stream (the default limit for shard count per stream is 10000 per account per region), unless you request a limit increase.

  • Scale a stream with more than 10000 shards down unless you set this value to less than 10000 shards.

StreamARN
string | undefined

The ARN of the stream.

StreamName
string | undefined

The name of the stream.

UpdateShardCountCommand Output

See UpdateShardCountCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CurrentShardCount
number | undefined

The current number of shards.

StreamARN
string | undefined

The ARN of the stream.

StreamName
string | undefined

The name of the stream.

TargetShardCount
number | undefined

The updated number of shards.

Throws

Name
Fault
Details
AccessDeniedException
client

Specifies that you do not have the permissions required to perform this operation.

InvalidArgumentException
client

A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

LimitExceededException
client

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

ResourceInUseException
client

The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

ResourceNotFoundException
client

The requested resource could not be found. The stream might not be specified correctly.

ValidationException
client

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.

KinesisServiceException
Base exception class for all service exceptions from Kinesis service.