Struct aws_sdk_ssm::operation::send_automation_signal::builders::SendAutomationSignalInputBuilder

#[non_exhaustive]
pub struct SendAutomationSignalInputBuilder { /* private fields */ }

A builder for SendAutomationSignalInput.

Implementations

impl SendAutomationSignalInputBuilder

pub fn automation_execution_id(self, input: impl Into<String>) -> Self

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

This field is required.

pub fn set_automation_execution_id(self, input: Option<String>) -> Self

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

pub fn get_automation_execution_id(&self) -> &Option<String>

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

pub fn signal_type(self, input: SignalType) -> Self

The type of signal to send to an Automation execution.

This field is required.

pub fn set_signal_type(self, input: Option<SignalType>) -> Self

The type of signal to send to an Automation execution.

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

The type of signal to send to an Automation execution.

pub fn payload(self, k: impl Into<String>, v: Vec<String>) -> Self

Adds a key-value pair to payload.

To override the contents of this collection use set_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"

pub fn set_payload(self, input: Option<HashMap<String, Vec<String>>>) -> Self

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"

pub fn get_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"

pub fn build(self) -> Result<SendAutomationSignalInput, BuildError>

Consumes the builder and constructs a SendAutomationSignalInput.

impl SendAutomationSignalInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<SendAutomationSignalOutput, SdkError<SendAutomationSignalError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for SendAutomationSignalInputBuilder

fn clone(&self) -> SendAutomationSignalInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SendAutomationSignalInputBuilder

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

Formats the value using the given formatter.

impl Default for SendAutomationSignalInputBuilder

fn default() -> SendAutomationSignalInputBuilder

Returns the “default value” for a type.

impl PartialEq for SendAutomationSignalInputBuilder

fn eq(&self, other: &SendAutomationSignalInputBuilder) -> 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 SendAutomationSignalInputBuilder