Skip to content

Kinesis  >  Operations  >  update_stream_warm_throughput

update_stream_warm_throughput

Operation

update_stream_warm_throughput async

update_stream_warm_throughput(request: UpdateStreamWarmThroughputInput | UpdateStreamWarmThroughputInputDict, /, *, plugins: list[Plugin] | None = None) -> UpdateStreamWarmThroughputOutput
update_stream_warm_throughput(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateStreamWarmThroughputInputDict]) -> UpdateStreamWarmThroughputOutput

Updates the warm throughput configuration for the specified Amazon Kinesis Data Streams on-demand data stream. Updates the warm throughput configuration for the specified on-demand data stream. Use this operation to scale your stream to a specified throughput level before anticipated traffic spikes, or to release excess capacity after traffic has decreased.

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 warm throughput 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.

This operation is only supported for data streams with the on-demand capacity mode in accounts that have MinimumThroughputBillingCommitment enabled. Provisioned capacity mode streams do not support warm throughput configuration.

To release excess capacity, call the API again and set the warm throughput to the same or a lower value.

This operation has the following default limits. By default, you cannot do the following:

  • Scale to more than 10 GiBps for an on-demand stream.

  • This API has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. TPS over 5 will initiate 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
UpdateStreamWarmThroughputOutput

An instance of UpdateStreamWarmThroughputOutput.

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

UpdateStreamWarmThroughputInput dataclass

Bases: _SerdeShape

Dataclass for UpdateStreamWarmThroughputInput structure.

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

The ARN of the stream to be updated.

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 to be updated.

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

The target warm throughput in MB/s that the stream should be scaled to handle. This represents the throughput capacity that will be immediately available for write operations.

Dictionaries

UpdateStreamWarmThroughputInputDict

Bases: TypedDict

Dictionary form of UpdateStreamWarmThroughputInput.

Attributes
stream_arn instance-attribute
stream_arn: str | None

The ARN of the stream to be updated.

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 to be updated.

warm_throughput_mi_bps instance-attribute
warm_throughput_mi_bps: Required[int]

The target warm throughput in MB/s that the stream should be scaled to handle. This represents the throughput capacity that will be immediately available for write operations.

Output

UpdateStreamWarmThroughputOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateStreamWarmThroughputOutput structure.

Attributes

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 that was updated.

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

The name of the stream that was updated.

warm_throughput class-attribute instance-attribute
warm_throughput: WarmThroughputObject | None = ...

Specifies the updated warm throughput configuration for your data stream.