/AWS1/IF_IOT=>LISTCOMMANDEXECUTIONS()

About ListCommandExecutions

List all command executions.

• You must provide only the startedTimeFilter or the completedTimeFilter information. If you provide both time filters, the API will generate an error. You can use this information to retrieve a list of command executions within a specific timeframe.

• You must provide only the commandArn or the thingArn information depending on whether you want to list executions for a specific command or an IoT thing. If you provide both fields, the API will generate an error.

For more information about considerations for using this API, see List command executions in your account (CLI).

Method Signature

METHODS /AWS1/IF_IOT~LISTCOMMANDEXECUTIONS
  IMPORTING
    !IV_MAXRESULTS TYPE /AWS1/IOTCOMMANDMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/IOTNEXTTOKEN OPTIONAL
    !IV_NAMESPACE TYPE /AWS1/IOTCOMMANDNAMESPACE OPTIONAL
    !IV_STATUS TYPE /AWS1/IOTCOMMANDEXECSTATUS OPTIONAL
    !IV_SORTORDER TYPE /AWS1/IOTSORTORDER OPTIONAL
    !IO_STARTEDTIMEFILTER TYPE REF TO /AWS1/CL_IOTTIMEFILTER OPTIONAL
    !IO_COMPLETEDTIMEFILTER TYPE REF TO /AWS1/CL_IOTTIMEFILTER OPTIONAL
    !IV_TARGETARN TYPE /AWS1/IOTTARGETARN OPTIONAL
    !IV_COMMANDARN TYPE /AWS1/IOTCOMMANDARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iotlistcmdexecsrsp
  RAISING
    /AWS1/CX_IOTINTERNALSERVEREX
    /AWS1/CX_IOTRESOURCENOTFOUNDEX
    /AWS1/CX_IOTTHROTTLINGEX
    /AWS1/CX_IOTVALIDATIONEX
    /AWS1/CX_IOTCLIENTEXC
    /AWS1/CX_IOTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_maxresults TYPE /AWS1/IOTCOMMANDMAXRESULTS /AWS1/IOTCOMMANDMAXRESULTS

The maximum number of results to return in this operation.

iv_nexttoken TYPE /AWS1/IOTNEXTTOKEN /AWS1/IOTNEXTTOKEN

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

iv_namespace TYPE /AWS1/IOTCOMMANDNAMESPACE /AWS1/IOTCOMMANDNAMESPACE

The namespace of the command.

iv_status TYPE /AWS1/IOTCOMMANDEXECSTATUS /AWS1/IOTCOMMANDEXECSTATUS

List all command executions for the device that have a particular status. For example, you can filter the list to display only command executions that have failed or timed out.

iv_sortorder TYPE /AWS1/IOTSORTORDER /AWS1/IOTSORTORDER

Specify whether to list the command executions that were created in the ascending or descending order. By default, the API returns all commands in the descending order based on the start time or completion time of the executions, that are determined by the startTimeFilter and completeTimeFilter parameters.

io_startedtimefilter TYPE REF TO /AWS1/CL_IOTTIMEFILTER /AWS1/CL_IOTTIMEFILTER

List all command executions that started any time before or after the date and time that you specify. The date and time uses the format yyyy-MM-dd'T'HH:mm.

io_completedtimefilter TYPE REF TO /AWS1/CL_IOTTIMEFILTER /AWS1/CL_IOTTIMEFILTER

List all command executions that completed any time before or after the date and time that you specify. The date and time uses the format yyyy-MM-dd'T'HH:mm.

iv_targetarn TYPE /AWS1/IOTTARGETARN /AWS1/IOTTARGETARN

The Amazon Resource Number (ARN) of the target device. You can use this information to list all command executions for a particular device.

iv_commandarn TYPE /AWS1/IOTCOMMANDARN /AWS1/IOTCOMMANDARN

The Amazon Resource Number (ARN) of the command. You can use this information to list all command executions for a particular command.

RETURNING

oo_output TYPE REF TO /aws1/cl_iotlistcmdexecsrsp /AWS1/CL_IOTLISTCMDEXECSRSP

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->listcommandexecutions(
  io_completedtimefilter = new /aws1/cl_iottimefilter(
    iv_after = |string|
    iv_before = |string|
  )
  io_startedtimefilter = new /aws1/cl_iottimefilter(
    iv_after = |string|
    iv_before = |string|
  )
  iv_commandarn = |string|
  iv_maxresults = 123
  iv_namespace = |string|
  iv_nexttoken = |string|
  iv_sortorder = |string|
  iv_status = |string|
  iv_targetarn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_commandexecutions( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_commandarn = lo_row_1->get_commandarn( ).
      lv_commandexecutionid = lo_row_1->get_executionid( ).
      lv_targetarn = lo_row_1->get_targetarn( ).
      lv_commandexecutionstatus = lo_row_1->get_status( ).
      lv_datetype = lo_row_1->get_createdat( ).
      lv_datetype = lo_row_1->get_startedat( ).
      lv_datetype = lo_row_1->get_completedat( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.