update_stream_mode¶
Operation¶
async
¶
update_stream_mode(input: UpdateStreamModeInput, plugins: list[Plugin] | None = None) -> UpdateStreamModeOutput
Updates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data stream.
If you'd still like to proactively scale your on-demand data stream's
capacity, you can unlock the warm throughput feature for on-demand data
streams by enabling MinimumThroughputBillingCommitment for your
account. Once your account has MinimumThroughputBillingCommitment
enabled, you can specify the warm throughput in MiB per second that your
stream can support in writes.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateStreamModeInput
|
An instance of |
required |
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 |
|---|---|
UpdateStreamModeOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateStreamModeInput structure.
Attributes¶
class-attribute
instance-attribute
¶
stream_arn: str | None = ...
Specifies the ARN of the data stream whose capacity mode you want to update.
class-attribute
instance-attribute
¶
stream_id: str | None = ...
Not Implemented. Reserved for future use.
class-attribute
instance-attribute
¶
stream_mode_details: StreamModeDetails | None = ...
Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.
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. This field is only valid when the stream mode is being updated to on-demand.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateStreamModeOutput structure.