UPDATESTREAMMODE()`¶

About UpdateStreamMode¶

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.

Method Signature¶

METHODS /AWS1/IF_KNS~UPDATESTREAMMODE
  IMPORTING
    !IV_STREAMARN TYPE /AWS1/KNSSTREAMARN OPTIONAL
    !IO_STREAMMODEDETAILS TYPE REF TO /AWS1/CL_KNSSTREAMMODEDETAILS OPTIONAL
    !IV_WARMTHROUGHPUTMIBPS TYPE /AWS1/KNSNATURALINTEGEROBJECT OPTIONAL
  RAISING
    /AWS1/CX_KNSINVALIDARGUMENTEX
    /AWS1/CX_KNSLIMITEXCEEDEDEX
    /AWS1/CX_KNSRESOURCEINUSEEX
    /AWS1/CX_KNSRESOURCENOTFOUNDEX
    /AWS1/CX_KNSVALIDATIONEX
    /AWS1/CX_KNSCLIENTEXC
    /AWS1/CX_KNSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_streamarn` `TYPE /AWS1/KNSSTREAMARN` `/AWS1/KNSSTREAMARN`¶

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

`io_streammodedetails` `TYPE REF TO /AWS1/CL_KNSSTREAMMODEDETAILS` `/AWS1/CL_KNSSTREAMMODEDETAILS`¶

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.

Optional arguments:¶

`iv_warmthroughputmibps` `TYPE /AWS1/KNSNATURALINTEGEROBJECT` `/AWS1/KNSNATURALINTEGEROBJECT`¶

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.

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

lo_client->updatestreammode(
  io_streammodedetails = new /aws1/cl_knsstreammodedetails( |string| )
  iv_streamarn = |string|
  iv_warmthroughputmibps = 123
).

/AWS1/IF_KNS=>UPDATESTREAMMODE()¶