Skip to content

UpdateStreamModeInput

Source code in docs_src/capo_kinesis/types/update_stream_mode_input.py 
16
17
18
19
20
21
22
23
24
25
26
class UpdateStreamModeInput(TypedDict, closed=True):
    stream_arn: "capo_kinesis.types.stream_arn.StreamARN"
    """<p> Specifies the ARN of the data stream whose capacity mode you want to update. </p>"""
    stream_id: NotRequired["capo_kinesis.types.stream_id.StreamId"]
    """<p>Not Implemented. Reserved for future use.</p>"""
    stream_mode_details: "capo_kinesis.types.stream_mode_details.StreamModeDetails"
    """<p> Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an <b>on-demand</b> capacity mode and a <b>provisioned</b> capacity mode for your data streams. </p>"""
    warm_throughput_mi_bps: NotRequired[
        "capo_kinesis.types.natural_integer_object.NaturalIntegerObject"
    ]
    """<p>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.</p>"""

stream_arn instance-attribute 

stream_arn: StreamARN

Specifies the ARN of the data stream whose capacity mode you want to update.

stream_id instance-attribute 

stream_id: NotRequired[StreamId]

Not Implemented. Reserved for future use.

stream_mode_details instance-attribute 

stream_mode_details: StreamModeDetails

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.

warm_throughput_mi_bps instance-attribute 

warm_throughput_mi_bps: NotRequired[NaturalIntegerObject]

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.