Skip to content

Kinesis  >  Operations  >  update_shard_count

update_shard_count

Operation

update_shard_count async

update_shard_count(request: UpdateShardCountInput | UpdateShardCountInputDict, /, *, plugins: list[Plugin] | None = None) -> UpdateShardCountOutput
update_shard_count(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateShardCountInputDict]) -> UpdateShardCountOutput

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.

Note

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.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
UpdateShardCountOutput

An instance of UpdateShardCountOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

UpdateShardCountInput dataclass

Bases: _SerdeShape

Dataclass for UpdateShardCountInput structure.

Attributes
scaling_type class-attribute instance-attribute
scaling_type: str | None = ...

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

stream_arn class-attribute instance-attribute
stream_arn: str | None = ...

The ARN of the stream.

stream_id class-attribute instance-attribute
stream_id: str | None = ...

Not Implemented. Reserved for future use.

stream_name class-attribute instance-attribute
stream_name: str | None = ...

The name of the stream.

target_shard_count class-attribute instance-attribute
target_shard_count: int | None = ...

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.

Dictionaries

UpdateShardCountInputDict

Bases: TypedDict

Dictionary form of UpdateShardCountInput.

Attributes
scaling_type instance-attribute
scaling_type: Required[str]

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

stream_arn instance-attribute
stream_arn: str | None

The ARN of the stream.

stream_id instance-attribute
stream_id: str | None

Not Implemented. Reserved for future use.

stream_name instance-attribute
stream_name: str | None

The name of the stream.

target_shard_count instance-attribute
target_shard_count: Required[int]

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.

Output

UpdateShardCountOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateShardCountOutput structure.

Attributes

current_shard_count class-attribute instance-attribute
current_shard_count: int | None = ...

The current number of shards.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

stream_arn class-attribute instance-attribute
stream_arn: str | None = ...

The ARN of the stream.

stream_name class-attribute instance-attribute
stream_name: str | None = ...

The name of the stream.

target_shard_count class-attribute instance-attribute
target_shard_count: int | None = ...

The updated number of shards.