aws_sdk_ssm/operation/send_automation_signal/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::send_automation_signal::_send_automation_signal_output::SendAutomationSignalOutputBuilder;
3
4pub use crate::operation::send_automation_signal::_send_automation_signal_input::SendAutomationSignalInputBuilder;
5
6impl crate::operation::send_automation_signal::builders::SendAutomationSignalInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::send_automation_signal::SendAutomationSignalOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::send_automation_signal::SendAutomationSignalError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.send_automation_signal();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `SendAutomationSignal`.
24///
25/// <p>Sends a signal to an Automation execution to change the current behavior or status of the execution.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct SendAutomationSignalFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::send_automation_signal::builders::SendAutomationSignalInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::send_automation_signal::SendAutomationSignalOutput,
35        crate::operation::send_automation_signal::SendAutomationSignalError,
36    > for SendAutomationSignalFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::send_automation_signal::SendAutomationSignalOutput,
44            crate::operation::send_automation_signal::SendAutomationSignalError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl SendAutomationSignalFluentBuilder {
51    /// Creates a new `SendAutomationSignalFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the SendAutomationSignal as a reference.
60    pub fn as_input(&self) -> &crate::operation::send_automation_signal::builders::SendAutomationSignalInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::send_automation_signal::SendAutomationSignalOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::send_automation_signal::SendAutomationSignalError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::send_automation_signal::SendAutomationSignal::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::send_automation_signal::SendAutomationSignal::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::send_automation_signal::SendAutomationSignalOutput,
97        crate::operation::send_automation_signal::SendAutomationSignalError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <p>The unique identifier for an existing Automation execution that you want to send the signal to.</p>
112    pub fn automation_execution_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.automation_execution_id(input.into());
114        self
115    }
116    /// <p>The unique identifier for an existing Automation execution that you want to send the signal to.</p>
117    pub fn set_automation_execution_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_automation_execution_id(input);
119        self
120    }
121    /// <p>The unique identifier for an existing Automation execution that you want to send the signal to.</p>
122    pub fn get_automation_execution_id(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_automation_execution_id()
124    }
125    /// <p>The type of signal to send to an Automation execution.</p>
126    pub fn signal_type(mut self, input: crate::types::SignalType) -> Self {
127        self.inner = self.inner.signal_type(input);
128        self
129    }
130    /// <p>The type of signal to send to an Automation execution.</p>
131    pub fn set_signal_type(mut self, input: ::std::option::Option<crate::types::SignalType>) -> Self {
132        self.inner = self.inner.set_signal_type(input);
133        self
134    }
135    /// <p>The type of signal to send to an Automation execution.</p>
136    pub fn get_signal_type(&self) -> &::std::option::Option<crate::types::SignalType> {
137        self.inner.get_signal_type()
138    }
139    ///
140    /// Adds a key-value pair to `Payload`.
141    ///
142    /// To override the contents of this collection use [`set_payload`](Self::set_payload).
143    ///
144    /// <p>The data sent with the signal. The data schema depends on the type of signal used in the request.</p>
145    /// <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>
146    /// <p><code>Comment="Looks good"</code></p>
147    /// <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>
148    /// <p><code>StepName="step1"</code></p>
149    /// <p>For the <code>StopStep</code> signal type, you must send the step execution ID as the payload. For example:</p>
150    /// <p><code>StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"</code></p>
151    pub fn payload(mut self, k: impl ::std::convert::Into<::std::string::String>, v: ::std::vec::Vec<::std::string::String>) -> Self {
152        self.inner = self.inner.payload(k.into(), v);
153        self
154    }
155    /// <p>The data sent with the signal. The data schema depends on the type of signal used in the request.</p>
156    /// <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>
157    /// <p><code>Comment="Looks good"</code></p>
158    /// <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>
159    /// <p><code>StepName="step1"</code></p>
160    /// <p>For the <code>StopStep</code> signal type, you must send the step execution ID as the payload. For example:</p>
161    /// <p><code>StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"</code></p>
162    pub fn set_payload(
163        mut self,
164        input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>>,
165    ) -> Self {
166        self.inner = self.inner.set_payload(input);
167        self
168    }
169    /// <p>The data sent with the signal. The data schema depends on the type of signal used in the request.</p>
170    /// <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>
171    /// <p><code>Comment="Looks good"</code></p>
172    /// <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>
173    /// <p><code>StepName="step1"</code></p>
174    /// <p>For the <code>StopStep</code> signal type, you must send the step execution ID as the payload. For example:</p>
175    /// <p><code>StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"</code></p>
176    pub fn get_payload(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>> {
177        self.inner.get_payload()
178    }
179}
aws_sdk_ssm/operation/send_automation_signal/builders.rs

aws_sdk_ssm/operation/send_automation_signal/
builders.rs
