Skip to content

/AWS1/IF_SSM=>SENDAUTOMATIONSIGNAL()

About SendAutomationSignal

Sends a signal to an Automation execution to change the current behavior or status of the execution.

Method Signature

IMPORTING

Required arguments:

iv_automationexecutionid TYPE /AWS1/SSMAUTOMATIONEXECUTIONID /AWS1/SSMAUTOMATIONEXECUTIONID

The unique identifier for an existing Automation execution that you want to send the signal to.

iv_signaltype TYPE /AWS1/SSMSIGNALTYPE /AWS1/SSMSIGNALTYPE

The type of signal to send to an Automation execution.

Optional arguments:

it_payload TYPE /AWS1/CL_SSMAUTOMATIONPRMVAL00=>TT_AUTOMATIONPARAMETERMAP TT_AUTOMATIONPARAMETERMAP

The data sent with the signal. The data schema depends on the type of signal used in the request.

For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

Comment="Looks good"

For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

StepName="step1"

For the StopStep signal type, you must send the step execution ID as the payload. For example:

StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"

RETURNING

oo_output TYPE REF TO /aws1/cl_ssmsendautomationsi01 /AWS1/CL_SSMSENDAUTOMATIONSI01

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->/aws1/if_ssm~sendautomationsignal(
  it_payload = VALUE /aws1/cl_ssmautomationprmval00=>tt_automationparametermap(
    (
      VALUE /aws1/cl_ssmautomationprmval00=>ts_automationparammap_maprow(
        key = |string|
        value = VALUE /aws1/cl_ssmautomationprmval00=>tt_automationparamvaluelist(
          ( new /aws1/cl_ssmautomationprmval00( |string| ) )
        )
      )
    )
  )
  iv_automationexecutionid = |string|
  iv_signaltype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.