GETCOMMANDINVOCATION()`¶

About GetCommandInvocation¶

Returns detailed information about command execution for an invocation or plugin. The Run Command API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your resources might not be immediately visible to all subsequent commands you run. You should keep this in mind when you carry out an API command that immediately follows a previous API command.

GetCommandInvocation only gives the execution status of a plugin in a document. To get the command execution status on a specific managed node, use ListCommandInvocations. To get the command execution status across managed nodes, use ListCommands.

Method Signature¶

METHODS /AWS1/IF_SSM~GETCOMMANDINVOCATION
  IMPORTING
    !IV_COMMANDID TYPE /AWS1/SSMCOMMANDID OPTIONAL
    !IV_INSTANCEID TYPE /AWS1/SSMINSTANCEID OPTIONAL
    !IV_PLUGINNAME TYPE /AWS1/SSMCOMMANDPLUGINNAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ssmgetcmdinvcresult
  RAISING
    /AWS1/CX_SSMINTERNALSERVERERR
    /AWS1/CX_SSMINVALIDCOMMANDID
    /AWS1/CX_SSMINVALIDINSTANCEID
    /AWS1/CX_SSMINVALIDPLUGINNAME
    /AWS1/CX_SSMINVCDOESNOTEXIST
    /AWS1/CX_SSMCLIENTEXC
    /AWS1/CX_SSMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_commandid` `TYPE /AWS1/SSMCOMMANDID` `/AWS1/SSMCOMMANDID`¶

(Required) The parent command ID of the invocation plugin.

`iv_instanceid` `TYPE /AWS1/SSMINSTANCEID` `/AWS1/SSMINSTANCEID`¶

(Required) The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, and on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.

Optional arguments:¶

`iv_pluginname` `TYPE /AWS1/SSMCOMMANDPLUGINNAME` `/AWS1/SSMCOMMANDPLUGINNAME`¶

The name of the step for which you want detailed results. If the document contains only one step, you can omit the name and details for that step. If the document contains more than one step, you must specify the name of the step for which you want to view details. Be sure to specify the name of the step, not the name of a plugin like aws:RunShellScript.

To find the PluginName, check the document content and find the name of the step you want details for. Alternatively, use ListCommandInvocations with the CommandId and Details parameters. The PluginName is the Name attribute of the CommandPlugin object in the CommandPlugins list.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ssmgetcmdinvcresult` `/AWS1/CL_SSMGETCMDINVCRESULT`¶

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->getcommandinvocation(
  iv_commandid = |string|
  iv_instanceid = |string|
  iv_pluginname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_commandid = lo_result->get_commandid( ).
  lv_instanceid = lo_result->get_instanceid( ).
  lv_comment = lo_result->get_comment( ).
  lv_documentname = lo_result->get_documentname( ).
  lv_documentversion = lo_result->get_documentversion( ).
  lv_commandpluginname = lo_result->get_pluginname( ).
  lv_responsecode = lo_result->get_responsecode( ).
  lv_stringdatetime = lo_result->get_executionstartdatetime( ).
  lv_stringdatetime = lo_result->get_executionelapsedtime( ).
  lv_stringdatetime = lo_result->get_executionenddatetime( ).
  lv_commandinvocationstatus = lo_result->get_status( ).
  lv_statusdetails = lo_result->get_statusdetails( ).
  lv_standardoutputcontent = lo_result->get_standardoutputcontent( ).
  lv_url = lo_result->get_standardoutputurl( ).
  lv_standarderrorcontent = lo_result->get_standarderrorcontent( ).
  lv_url = lo_result->get_standarderrorurl( ).
  lo_cloudwatchoutputconfig = lo_result->get_cloudwatchoutputconfig( ).
  IF lo_cloudwatchoutputconfig IS NOT INITIAL.
    lv_cloudwatchloggroupname = lo_cloudwatchoutputconfig->get_cloudwatchloggroupname( ).
    lv_cloudwatchoutputenabled = lo_cloudwatchoutputconfig->get_cloudwatchoutputenabled( ).
  ENDIF.
ENDIF.

/AWS1/IF_SSM=>GETCOMMANDINVOCATION()¶