DESCRIBEFLOW()`¶

About DescribeFlow¶

Returns the full details of a flow for the latest version of the requested publish state.

Method Signature¶

METHODS /AWS1/IF_QST~DESCRIBEFLOW
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTACCOUNTID OPTIONAL
    !IV_FLOWID TYPE /AWS1/QSTFLOWID OPTIONAL
    !IV_PUBLISHSTATE TYPE /AWS1/QSTFLOWPUBLISHSTATE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstdescrflowresponse
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /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 describing.

`iv_flowid` `TYPE /AWS1/QSTFLOWID` `/AWS1/QSTFLOWID`¶

The unique identifier of the flow.

`iv_publishstate` `TYPE /AWS1/QSTFLOWPUBLISHSTATE` `/AWS1/QSTFLOWPUBLISHSTATE`¶

The publish state of the flow version to describe. Valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_qstdescrflowresponse` `/AWS1/CL_QSTDESCRFLOWRESPONSE`¶

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->describeflow(
  iv_awsaccountid = |string|
  iv_flowid = |string|
  iv_publishstate = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_flowdetail = lo_result->get_flow( ).
  IF lo_flowdetail IS NOT INITIAL.
    lv_string = lo_flowdetail->get_arn( ).
    lv_flowid = lo_flowdetail->get_flowid( ).
    lv_title = lo_flowdetail->get_name( ).
    lv_flowdescription = lo_flowdetail->get_description( ).
    lv_flowpublishstate = lo_flowdetail->get_publishstate( ).
    lv_timestamp = lo_flowdetail->get_createdtime( ).
    lv_string = lo_flowdetail->get_createdby( ).
    lv_timestamp = lo_flowdetail->get_lastupdatedtime( ).
    lv_string = lo_flowdetail->get_lastupdatedby( ).
    lo_/aws1/cl_rt_document = lo_flowdetail->get_flowdefinition( ).
    IF lo_/aws1/cl_rt_document IS NOT INITIAL.
    ENDIF.
    LOOP AT lo_flowdetail->get_stepaliases( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_stepid = lo_row_1->get_stepid( ).
        lv_string = lo_row_1->get_stepalias( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
  lv_string = lo_result->get_requestid( ).
  lv_statuscode = lo_result->get_status( ).
ENDIF.

/AWS1/IF_QST=>DESCRIBEFLOW()¶