Struct aws_sdk_ssm::client::fluent_builders::SendAutomationSignal

pub struct SendAutomationSignal<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to SendAutomationSignal.

Sends a signal to an Automation execution to change the current behavior or status of the execution.

Implementations

impl<C, M, R> SendAutomationSignal<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<SendAutomationSignalOutput, SdkError<SendAutomationSignalError>> where
    R::Policy: SmithyRetryPolicy<SendAutomationSignalInputOperationOutputAlias, SendAutomationSignalOutput, SendAutomationSignalError, SendAutomationSignalInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

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.

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 signal_type(self, input: SignalType) -> Self

The type of signal to send to an Automation execution.

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

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"

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for SendAutomationSignal<C, M, R>

fn clone(&self) -> SendAutomationSignal<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for SendAutomationSignal<C, M, R>

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

Formats the value using the given formatter.