You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SSM::Types::SendAutomationSignalRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::SendAutomationSignalRequest
- Defined in:
- (unknown)
Overview
When passing SendAutomationSignalRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
automation_execution_id: "AutomationExecutionId", # required
signal_type: "Approve", # required, accepts Approve, Reject, StartStep, StopStep, Resume
payload: {
"AutomationParameterKey" => ["AutomationParameterValue"],
},
}
Instance Attribute Summary collapse
-
#automation_execution_id ⇒ String
The unique identifier for an existing Automation execution that you want to send the signal to.
-
#payload ⇒ Hash<String,Array<String>>
The data sent with the signal.
-
#signal_type ⇒ String
The type of signal to send to an Automation execution.
Instance Attribute Details
#automation_execution_id ⇒ String
The unique identifier for an existing Automation execution that you want to send the signal to.
#payload ⇒ Hash<String,Array<String>>
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"
#signal_type ⇒ String
The type of signal to send to an Automation execution.
Possible values:
- Approve
- Reject
- StartStep
- StopStep
- Resume