Class: Aws::SSM::Types::SendAutomationSignalRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass SendAutomationSignalRequest data as a hash:

{
  automation_execution_id: "AutomationExecutionId", # required
  signal_type: "Approve", # required, accepts Approve, Reject, StartStep, StopStep, Resume
  payload: {
    "AutomationParameterKey" => ["AutomationParameterValue"],
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#automation_execution_id ⇒ String

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

Returns:

  • (String) 


11842
11843
11844
11845
11846
11847
 
# File 'lib/aws-sdk-ssm/types.rb', line 11842

class SendAutomationSignalRequest < Struct.new(
  :automation_execution_id,
  :signal_type,
  :payload)
  include Aws::Structure
end

#payload ⇒ Hash<String,Array<String>>

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

Returns:

  • (Hash<String,Array<String>>) 


11842
11843
11844
11845
11846
11847
 
# File 'lib/aws-sdk-ssm/types.rb', line 11842

class SendAutomationSignalRequest < Struct.new(
  :automation_execution_id,
  :signal_type,
  :payload)
  include Aws::Structure
end

#signal_type ⇒ String

The type of signal. Valid signal types include the following: Approve and Reject

Returns:

  • (String) 


11842
11843
11844
11845
11846
11847
 
# File 'lib/aws-sdk-ssm/types.rb', line 11842

class SendAutomationSignalRequest < Struct.new(
  :automation_execution_id,
  :signal_type,
  :payload)
  include Aws::Structure
end