Kinesis / Client / update_stream_mode

update_stream_mode

Kinesis.Client.update_stream_mode(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.update_stream_mode(
    StreamARN='string',
    StreamModeDetails={
        'StreamMode': 'PROVISIONED'|'ON_DEMAND'
    }
)

Parameters:

• StreamARN (string) –

  [REQUIRED]

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

• StreamModeDetails (dict) –

  [REQUIRED]

  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.

  • StreamMode (string) – [REQUIRED]

    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.

Returns:

None

Exceptions

• Kinesis.Client.exceptions.InvalidArgumentException

• Kinesis.Client.exceptions.LimitExceededException

• Kinesis.Client.exceptions.ResourceInUseException

• Kinesis.Client.exceptions.ResourceNotFoundException