Skip to content

/AWS1/IF_KNV=>UPDATESIGNALINGCHANNEL()

About UpdateSignalingChannel

Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.

If the MessageTtlSeconds value is updated (either increased or reduced), it only applies to new messages sent via this channel after it's been updated. Existing messages are still expired as per the previous MessageTtlSeconds value.

Method Signature

METHODS /AWS1/IF_KNV~UPDATESIGNALINGCHANNEL
  IMPORTING
    !IV_CHANNELARN TYPE /AWS1/KNVRESOURCEARN OPTIONAL
    !IV_CURRENTVERSION TYPE /AWS1/KNVVERSION OPTIONAL
    !IO_SINGLEMASTERCONFIGURATION TYPE REF TO /AWS1/CL_KNVSINGLEMASTERCONF OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_knvupsignalingchann01
  RAISING
    /AWS1/CX_KNVACCESSDENIEDEX
    /AWS1/CX_KNVCLIENTLIMITEXCDEX
    /AWS1/CX_KNVINVALIDARGUMENTEX
    /AWS1/CX_KNVRESOURCEINUSEEX
    /AWS1/CX_KNVRESOURCENOTFOUNDEX
    /AWS1/CX_KNVVERSIONMISMATCHEX
    /AWS1/CX_KNVCLIENTEXC
    /AWS1/CX_KNVSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_channelarn TYPE /AWS1/KNVRESOURCEARN /AWS1/KNVRESOURCEARN

The Amazon Resource Name (ARN) of the signaling channel that you want to update.

iv_currentversion TYPE /AWS1/KNVVERSION /AWS1/KNVVERSION

The current version of the signaling channel that you want to update.

Optional arguments:

io_singlemasterconfiguration TYPE REF TO /AWS1/CL_KNVSINGLEMASTERCONF /AWS1/CL_KNVSINGLEMASTERCONF

The structure containing the configuration for the SINGLE_MASTER type of the signaling channel that you want to update.

RETURNING

oo_output TYPE REF TO /aws1/cl_knvupsignalingchann01 /AWS1/CL_KNVUPSIGNALINGCHANN01

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

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.

DATA(lo_result) = lo_client->updatesignalingchannel(
  io_singlemasterconfiguration = new /aws1/cl_knvsinglemasterconf( 123 )
  iv_channelarn = |string|
  iv_currentversion = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.