SendAutomationSignalRequest Class

Container for the parameters to the SendAutomationSignal operation. Sends a signal to an Automation execution to change the current behavior or status of the execution.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementRequest
      Amazon.SimpleSystemsManagement.Model.SendAutomationSignalRequest

Namespace: Amazon.SimpleSystemsManagement.Model
Assembly: AWSSDK.SimpleSystemsManagement.dll
Version: 3.x.y.z

Syntax

public class SendAutomationSignalRequest : AmazonSimpleSystemsManagementRequest
         IAmazonWebServiceRequest

The SendAutomationSignalRequest type exposes the following members

Constructors

	Name	Description
	SendAutomationSignalRequest()

Properties

Name Type Description

Name	Type	Description
AutomationExecutionId	System.String	Gets and sets the property AutomationExecutionId. The unique identifier for an existing Automation execution that you want to send the signal to.
Payload	System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.List<System.String>>	Gets and sets the property Payload. 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"`
SignalType	Amazon.SimpleSystemsManagement.SignalType	Gets and sets the property SignalType. The type of signal to send to an Automation execution.

AutomationExecutionId

System.String

Gets and sets the property AutomationExecutionId.

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

Payload

System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.List<System.String>>

Gets and sets the property Payload.

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"

SignalType

Amazon.SimpleSystemsManagement.SignalType

Gets and sets the property SignalType.

The type of signal to send to an Automation execution.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5