Struct aws_sdk_ssm::operation::send_automation_signal::SendAutomationSignalInput

#[non_exhaustive]
pub struct SendAutomationSignalInput {
    pub automation_execution_id: Option<String>,
    pub signal_type: Option<SignalType>,
    pub payload: Option<HashMap<String, Vec<String>>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

automation_execution_id: Option<String>

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

signal_type: Option<SignalType>

The type of signal to send to an Automation execution.

payload: Option<HashMap<String, Vec<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"

Implementations

impl SendAutomationSignalInput

pub fn automation_execution_id(&self) -> Option<&str>

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

pub fn signal_type(&self) -> Option<&SignalType>

The type of signal to send to an Automation execution.

pub fn payload(&self) -> Option<&HashMap<String, Vec<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"

impl SendAutomationSignalInput

pub fn builder() -> SendAutomationSignalInputBuilder

Creates a new builder-style object to manufacture SendAutomationSignalInput.

Trait Implementations

impl Clone for SendAutomationSignalInput

fn clone(&self) -> SendAutomationSignalInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SendAutomationSignalInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for SendAutomationSignalInput

fn eq(&self, other: &SendAutomationSignalInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SendAutomationSignalInput