STARTFLOW()`¶

About StartFlow¶

Activates an existing flow. For on-demand flows, this operation runs the flow immediately. For schedule and event-triggered flows, this operation activates the flow.

Method Signature¶

METHODS /AWS1/IF_APF~STARTFLOW
  IMPORTING
    !IV_FLOWNAME TYPE /AWS1/APFFLOWNAME OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/APFCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_apfstartflowresponse
  RAISING
    /AWS1/CX_APFCONFLICTEXCEPTION
    /AWS1/CX_APFINTERNALSERVEREX
    /AWS1/CX_APFRESOURCENOTFOUNDEX
    /AWS1/CX_APFSERVICEQUOTAEXCDEX
    /AWS1/CX_APFCLIENTEXC
    /AWS1/CX_APFSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_flowname` `TYPE /AWS1/APFFLOWNAME` `/AWS1/APFFLOWNAME`¶

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Optional arguments:¶

`iv_clienttoken` `TYPE /AWS1/APFCLIENTTOKEN` `/AWS1/APFCLIENTTOKEN`¶

The clientToken parameter is an idempotency token. It ensures that your StartFlow request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value.

If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

If you specify input parameters that differ from your first request, an error occurs for flows that run on a schedule or based on an event. However, the error doesn't occur for flows that run on demand. You set the conditions that initiate your flow for the triggerConfig parameter.

If you use a different value for clientToken, Amazon AppFlow considers it a new call to StartFlow. The token is active for 8 hours.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_apfstartflowresponse` `/AWS1/CL_APFSTARTFLOWRESPONSE`¶

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->startflow(
  iv_clienttoken = |string|
  iv_flowname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_flowarn = lo_result->get_flowarn( ).
  lv_flowstatus = lo_result->get_flowstatus( ).
  lv_executionid = lo_result->get_executionid( ).
ENDIF.

/AWS1/IF_APF=>STARTFLOW()¶