/AWS1/IF_SSM=>LISTCOMMANDINVOCATIONS()

About ListCommandInvocations

An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs SendCommand against three managed nodes, then a command invocation is created for each requested managed node ID. ListCommandInvocations provide status about command execution.

Method Signature

METHODS /AWS1/IF_SSM~LISTCOMMANDINVOCATIONS
  IMPORTING
    !IV_COMMANDID TYPE /AWS1/SSMCOMMANDID OPTIONAL
    !IV_INSTANCEID TYPE /AWS1/SSMINSTANCEID OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SSMCOMMANDMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SSMNEXTTOKEN OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_SSMCOMMANDFILTER=>TT_COMMANDFILTERLIST OPTIONAL
    !IV_DETAILS TYPE /AWS1/SSMBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ssmlistcmdinvcsresult
  RAISING
    /AWS1/CX_SSMINTERNALSERVERERR
    /AWS1/CX_SSMINVALIDCOMMANDID
    /AWS1/CX_SSMINVALIDFILTERKEY
    /AWS1/CX_SSMINVALIDINSTANCEID
    /AWS1/CX_SSMINVALIDNEXTTOKEN
    /AWS1/CX_SSMCLIENTEXC
    /AWS1/CX_SSMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_commandid TYPE /AWS1/SSMCOMMANDID /AWS1/SSMCOMMANDID

(Optional) The invocations for a specific command ID.

iv_instanceid TYPE /AWS1/SSMINSTANCEID /AWS1/SSMINSTANCEID

(Optional) The command execution details for a specific managed node ID.

iv_maxresults TYPE /AWS1/SSMCOMMANDMAXRESULTS /AWS1/SSMCOMMANDMAXRESULTS

(Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

iv_nexttoken TYPE /AWS1/SSMNEXTTOKEN /AWS1/SSMNEXTTOKEN

(Optional) The token for the next set of items to return. (You received this token from a previous call.)

it_filters TYPE /AWS1/CL_SSMCOMMANDFILTER=>TT_COMMANDFILTERLIST TT_COMMANDFILTERLIST

(Optional) One or more filters. Use a filter to return a more specific list of results.

iv_details TYPE /AWS1/SSMBOOLEAN /AWS1/SSMBOOLEAN

(Optional) If set this returns the response of the command executions and any command output. The default value is false.

RETURNING

oo_output TYPE REF TO /aws1/cl_ssmlistcmdinvcsresult /AWS1/CL_SSMLISTCMDINVCSRESULT

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->listcommandinvocations(
  it_filters = VALUE /aws1/cl_ssmcommandfilter=>tt_commandfilterlist(
    (
      new /aws1/cl_ssmcommandfilter(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_commandid = |string|
  iv_details = ABAP_TRUE
  iv_instanceid = |string|
  iv_maxresults = 123
  iv_nexttoken = |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_commandinvocations( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_commandid = lo_row_1->get_commandid( ).
      lv_instanceid = lo_row_1->get_instanceid( ).
      lv_instancetagname = lo_row_1->get_instancename( ).
      lv_comment = lo_row_1->get_comment( ).
      lv_documentname = lo_row_1->get_documentname( ).
      lv_documentversion = lo_row_1->get_documentversion( ).
      lv_datetime = lo_row_1->get_requesteddatetime( ).
      lv_commandinvocationstatus = lo_row_1->get_status( ).
      lv_statusdetails = lo_row_1->get_statusdetails( ).
      lv_invocationtraceoutput = lo_row_1->get_traceoutput( ).
      lv_url = lo_row_1->get_standardoutputurl( ).
      lv_url = lo_row_1->get_standarderrorurl( ).
      LOOP AT lo_row_1->get_commandplugins( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_commandpluginname = lo_row_3->get_name( ).
          lv_commandpluginstatus = lo_row_3->get_status( ).
          lv_statusdetails = lo_row_3->get_statusdetails( ).
          lv_responsecode = lo_row_3->get_responsecode( ).
          lv_datetime = lo_row_3->get_responsestartdatetime( ).
          lv_datetime = lo_row_3->get_responsefinishdatetime( ).
          lv_commandpluginoutput = lo_row_3->get_output( ).
          lv_url = lo_row_3->get_standardoutputurl( ).
          lv_url = lo_row_3->get_standarderrorurl( ).
          lv_s3region = lo_row_3->get_outputs3region( ).
          lv_s3bucketname = lo_row_3->get_outputs3bucketname( ).
          lv_s3keyprefix = lo_row_3->get_outputs3keyprefix( ).
        ENDIF.
      ENDLOOP.
      lv_servicerole = lo_row_1->get_servicerole( ).
      lo_notificationconfig = lo_row_1->get_notificationconfig( ).
      IF lo_notificationconfig IS NOT INITIAL.
        lv_notificationarn = lo_notificationconfig->get_notificationarn( ).
        LOOP AT lo_notificationconfig->get_notificationevents( ) into lo_row_4.
          lo_row_5 = lo_row_4.
          IF lo_row_5 IS NOT INITIAL.
            lv_notificationevent = lo_row_5->get_value( ).
          ENDIF.
        ENDLOOP.
        lv_notificationtype = lo_notificationconfig->get_notificationtype( ).
      ENDIF.
      lo_cloudwatchoutputconfig = lo_row_1->get_cloudwatchoutputconfig( ).
      IF lo_cloudwatchoutputconfig IS NOT INITIAL.
        lv_cloudwatchloggroupname = lo_cloudwatchoutputconfig->get_cloudwatchloggroupname( ).
        lv_cloudwatchoutputenabled = lo_cloudwatchoutputconfig->get_cloudwatchoutputenabled( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.