/AWS1/IF_QST=>UPDATEFLOW()

About UpdateFlow

Updates an existing flow. Supply only the fields you want to change. Updates both DRAFT and PUBLISHED versions. When FlowDefinition is provided, all existing steps are replaced with the new definition.

Method Signature

METHODS /AWS1/IF_QST~UPDATEFLOW
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTACCOUNTID OPTIONAL
    !IV_FLOWID TYPE /AWS1/QSTFLOWID OPTIONAL
    !IV_NAME TYPE /AWS1/QSTTITLEINPUT OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/QSTFLOWDESCRIPTIONINPUT OPTIONAL
    !IO_FLOWDEFINITION TYPE REF TO /AWS1/CL_RT_DOCUMENT OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/QSTUPDFLOWREQCLITKNSTR OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstupdateflowresponse
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTCONFLICTEXCEPTION
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTLIMITEXCEEDEDEX
    /AWS1/CX_QSTRESOURCENOTFOUNDEX
    /AWS1/CX_QSTTHROTTLINGEX
    /AWS1/CX_QSTCLIENTEXC
    /AWS1/CX_QSTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_awsaccountid TYPE /AWS1/QSTACCOUNTID /AWS1/QSTACCOUNTID

The ID of the Amazon Web Services account that contains the flow that you are updating.

iv_flowid TYPE /AWS1/QSTFLOWID /AWS1/QSTFLOWID

The unique identifier of the flow to update.

Optional arguments:

iv_name TYPE /AWS1/QSTTITLEINPUT /AWS1/QSTTITLEINPUT

Updated display name for the flow. Omit to preserve the existing name.

iv_description TYPE /AWS1/QSTFLOWDESCRIPTIONINPUT /AWS1/QSTFLOWDESCRIPTIONINPUT

Updated description for the flow. Omit to preserve the existing description.

io_flowdefinition TYPE REF TO /AWS1/CL_RT_DOCUMENT /AWS1/CL_RT_DOCUMENT

The definition of the flow, specifying the steps and configurations. This is the flow definition in Quick Flow's internal format. The format is subject to change. When provided, all existing steps are replaced. Omit to preserve the existing definition.

Always derive or depend on the flow definition from the DescribeFlow operation to ensure you are working with the latest format.

iv_clienttoken TYPE /AWS1/QSTUPDFLOWREQCLITKNSTR /AWS1/QSTUPDFLOWREQCLITKNSTR

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

RETURNING

oo_output TYPE REF TO /aws1/cl_qstupdateflowresponse /AWS1/CL_QSTUPDATEFLOWRESPONSE

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->updateflow(
  io_flowdefinition = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
  iv_awsaccountid = |string|
  iv_clienttoken = |string|
  iv_description = |string|
  iv_flowid = |string|
  iv_name = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_arn( ).
  lv_flowid = lo_result->get_flowid( ).
  lv_string = lo_result->get_requestid( ).
  lv_statuscode = lo_result->get_status( ).
ENDIF.