LISTEXECUTIONS()`¶

About ListExecutions¶

Lists all in-progress executions for the specified workflow.

If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound exception.

Method Signature¶

METHODS /AWS1/IF_TRN~LISTEXECUTIONS
  IMPORTING
    !IV_MAXRESULTS TYPE /AWS1/TRNMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/TRNNEXTTOKEN OPTIONAL
    !IV_WORKFLOWID TYPE /AWS1/TRNWORKFLOWID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_trnlistexecsresponse
  RAISING
    /AWS1/CX_TRNINTERNALSVCERROR
    /AWS1/CX_TRNINVALIDNEXTTOKENEX
    /AWS1/CX_TRNINVALIDREQUESTEX
    /AWS1/CX_TRNRESOURCENOTFOUNDEX
    /AWS1/CX_TRNSERVICEUNAVAILEX
    /AWS1/CX_TRNCLIENTEXC
    /AWS1/CX_TRNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_workflowid` `TYPE /AWS1/TRNWORKFLOWID` `/AWS1/TRNWORKFLOWID`¶

A unique identifier for the workflow.

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/TRNMAXRESULTS` `/AWS1/TRNMAXRESULTS`¶

The maximum number of items to return.

`iv_nexttoken` `TYPE /AWS1/TRNNEXTTOKEN` `/AWS1/TRNNEXTTOKEN`¶

ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, call the API by specifying the max-results:

aws transfer list-executions --max-results 10

This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can now call the API again, supplying the NextToken value you received:

aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult

This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_trnlistexecsresponse` `/AWS1/CL_TRNLISTEXECSRESPONSE`¶

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->listexecutions(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_workflowid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_nexttoken = lo_result->get_nexttoken( ).
  lv_workflowid = lo_result->get_workflowid( ).
  LOOP AT lo_result->get_executions( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_executionid = lo_row_1->get_executionid( ).
      lo_filelocation = lo_row_1->get_initialfilelocation( ).
      IF lo_filelocation IS NOT INITIAL.
        lo_s3filelocation = lo_filelocation->get_s3filelocation( ).
        IF lo_s3filelocation IS NOT INITIAL.
          lv_s3bucket = lo_s3filelocation->get_bucket( ).
          lv_s3key = lo_s3filelocation->get_key( ).
          lv_s3versionid = lo_s3filelocation->get_versionid( ).
          lv_s3etag = lo_s3filelocation->get_etag( ).
        ENDIF.
        lo_efsfilelocation = lo_filelocation->get_efsfilelocation( ).
        IF lo_efsfilelocation IS NOT INITIAL.
          lv_efsfilesystemid = lo_efsfilelocation->get_filesystemid( ).
          lv_efspath = lo_efsfilelocation->get_path( ).
        ENDIF.
      ENDIF.
      lo_servicemetadata = lo_row_1->get_servicemetadata( ).
      IF lo_servicemetadata IS NOT INITIAL.
        lo_userdetails = lo_servicemetadata->get_userdetails( ).
        IF lo_userdetails IS NOT INITIAL.
          lv_username = lo_userdetails->get_username( ).
          lv_serverid = lo_userdetails->get_serverid( ).
          lv_sessionid = lo_userdetails->get_sessionid( ).
        ENDIF.
      ENDIF.
      lv_executionstatus = lo_row_1->get_status( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_TRN=>LISTEXECUTIONS()¶