aws_sdk_ssm/client/

send_automation_signal.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`SendAutomationSignal`](crate::operation::send_automation_signal::builders::SendAutomationSignalFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`automation_execution_id(impl Into<String>)`](crate::operation::send_automation_signal::builders::SendAutomationSignalFluentBuilder::automation_execution_id) / [`set_automation_execution_id(Option<String>)`](crate::operation::send_automation_signal::builders::SendAutomationSignalFluentBuilder::set_automation_execution_id):<br>required: **true**<br><p>The unique identifier for an existing Automation execution that you want to send the signal to.</p><br>
    ///   - [`signal_type(SignalType)`](crate::operation::send_automation_signal::builders::SendAutomationSignalFluentBuilder::signal_type) / [`set_signal_type(Option<SignalType>)`](crate::operation::send_automation_signal::builders::SendAutomationSignalFluentBuilder::set_signal_type):<br>required: **true**<br><p>The type of signal to send to an Automation execution.</p><br>
    ///   - [`payload(impl Into<String>, Vec::<String>)`](crate::operation::send_automation_signal::builders::SendAutomationSignalFluentBuilder::payload) / [`set_payload(Option<HashMap::<String, Vec::<String>>>)`](crate::operation::send_automation_signal::builders::SendAutomationSignalFluentBuilder::set_payload):<br>required: **false**<br><p>The data sent with the signal. The data schema depends on the type of signal used in the request.</p> <p>For <code>Approve</code> and <code>Reject</code> signal types, the payload is an optional comment that you can send with the signal type. For example:</p> <p><code>Comment="Looks good"</code></p> <p>For <code>StartStep</code> and <code>Resume</code> signal types, you must send the name of the Automation step to start or resume as the payload. For example:</p> <p><code>StepName="step1"</code></p> <p>For the <code>StopStep</code> signal type, you must send the step execution ID as the payload. For example:</p> <p><code>StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"</code></p><br>
    /// - On success, responds with [`SendAutomationSignalOutput`](crate::operation::send_automation_signal::SendAutomationSignalOutput)
    /// - On failure, responds with [`SdkError<SendAutomationSignalError>`](crate::operation::send_automation_signal::SendAutomationSignalError)
    pub fn send_automation_signal(&self) -> crate::operation::send_automation_signal::builders::SendAutomationSignalFluentBuilder {
        crate::operation::send_automation_signal::builders::SendAutomationSignalFluentBuilder::new(self.handle.clone())
    }
}