aws_sdk_swf/operation/terminate_workflow_execution/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::terminate_workflow_execution::_terminate_workflow_execution_output::TerminateWorkflowExecutionOutputBuilder;
3
4pub use crate::operation::terminate_workflow_execution::_terminate_workflow_execution_input::TerminateWorkflowExecutionInputBuilder;
5
6impl crate::operation::terminate_workflow_execution::builders::TerminateWorkflowExecutionInputBuilder {
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::terminate_workflow_execution::TerminateWorkflowExecutionOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::terminate_workflow_execution::TerminateWorkflowExecutionError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.terminate_workflow_execution();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `TerminateWorkflowExecution`.
24///
25/// <p>Records a <code>WorkflowExecutionTerminated</code> event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.</p><important>
26/// <p>If the identified workflow execution was in progress, it is terminated immediately.</p>
27/// </important> <note>
28/// <p>If a runId isn't specified, then the <code>WorkflowExecutionTerminated</code> event is recorded in the history of the current open workflow with the matching workflowId in the domain.</p>
29/// </note> <note>
30/// <p>You should consider using <code>RequestCancelWorkflowExecution</code> action instead because it allows the workflow to gracefully close while <code>TerminateWorkflowExecution</code> doesn't.</p>
31/// </note>
32/// <p><b>Access Control</b></p>
33/// <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>
34/// <ul>
35/// <li>
36/// <p>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</p></li>
37/// <li>
38/// <p>Use an <code>Action</code> element to allow or deny permission to call this action.</p></li>
39/// <li>
40/// <p>You cannot use an IAM policy to constrain this action's parameters.</p></li>
41/// </ul>
42/// <p>If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>. For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
43#[derive(::std::clone::Clone, ::std::fmt::Debug)]
44pub struct TerminateWorkflowExecutionFluentBuilder {
45    handle: ::std::sync::Arc<crate::client::Handle>,
46    inner: crate::operation::terminate_workflow_execution::builders::TerminateWorkflowExecutionInputBuilder,
47    config_override: ::std::option::Option<crate::config::Builder>,
48}
49impl
50    crate::client::customize::internal::CustomizableSend<
51        crate::operation::terminate_workflow_execution::TerminateWorkflowExecutionOutput,
52        crate::operation::terminate_workflow_execution::TerminateWorkflowExecutionError,
53    > for TerminateWorkflowExecutionFluentBuilder
54{
55    fn send(
56        self,
57        config_override: crate::config::Builder,
58    ) -> crate::client::customize::internal::BoxFuture<
59        crate::client::customize::internal::SendResult<
60            crate::operation::terminate_workflow_execution::TerminateWorkflowExecutionOutput,
61            crate::operation::terminate_workflow_execution::TerminateWorkflowExecutionError,
62        >,
63    > {
64        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
65    }
66}
67impl TerminateWorkflowExecutionFluentBuilder {
68    /// Creates a new `TerminateWorkflowExecutionFluentBuilder`.
69    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
70        Self {
71            handle,
72            inner: ::std::default::Default::default(),
73            config_override: ::std::option::Option::None,
74        }
75    }
76    /// Access the TerminateWorkflowExecution as a reference.
77    pub fn as_input(&self) -> &crate::operation::terminate_workflow_execution::builders::TerminateWorkflowExecutionInputBuilder {
78        &self.inner
79    }
80    /// Sends the request and returns the response.
81    ///
82    /// If an error occurs, an `SdkError` will be returned with additional details that
83    /// can be matched against.
84    ///
85    /// By default, any retryable failures will be retried twice. Retry behavior
86    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
87    /// set when configuring the client.
88    pub async fn send(
89        self,
90    ) -> ::std::result::Result<
91        crate::operation::terminate_workflow_execution::TerminateWorkflowExecutionOutput,
92        ::aws_smithy_runtime_api::client::result::SdkError<
93            crate::operation::terminate_workflow_execution::TerminateWorkflowExecutionError,
94            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
95        >,
96    > {
97        let input = self
98            .inner
99            .build()
100            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
101        let runtime_plugins = crate::operation::terminate_workflow_execution::TerminateWorkflowExecution::operation_runtime_plugins(
102            self.handle.runtime_plugins.clone(),
103            &self.handle.conf,
104            self.config_override,
105        );
106        crate::operation::terminate_workflow_execution::TerminateWorkflowExecution::orchestrate(&runtime_plugins, input).await
107    }
108
109    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
110    pub fn customize(
111        self,
112    ) -> crate::client::customize::CustomizableOperation<
113        crate::operation::terminate_workflow_execution::TerminateWorkflowExecutionOutput,
114        crate::operation::terminate_workflow_execution::TerminateWorkflowExecutionError,
115        Self,
116    > {
117        crate::client::customize::CustomizableOperation::new(self)
118    }
119    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
120        self.set_config_override(::std::option::Option::Some(config_override.into()));
121        self
122    }
123
124    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
125        self.config_override = config_override;
126        self
127    }
128    /// <p>The domain of the workflow execution to terminate.</p>
129    pub fn domain(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
130        self.inner = self.inner.domain(input.into());
131        self
132    }
133    /// <p>The domain of the workflow execution to terminate.</p>
134    pub fn set_domain(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
135        self.inner = self.inner.set_domain(input);
136        self
137    }
138    /// <p>The domain of the workflow execution to terminate.</p>
139    pub fn get_domain(&self) -> &::std::option::Option<::std::string::String> {
140        self.inner.get_domain()
141    }
142    /// <p>The workflowId of the workflow execution to terminate.</p>
143    pub fn workflow_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
144        self.inner = self.inner.workflow_id(input.into());
145        self
146    }
147    /// <p>The workflowId of the workflow execution to terminate.</p>
148    pub fn set_workflow_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
149        self.inner = self.inner.set_workflow_id(input);
150        self
151    }
152    /// <p>The workflowId of the workflow execution to terminate.</p>
153    pub fn get_workflow_id(&self) -> &::std::option::Option<::std::string::String> {
154        self.inner.get_workflow_id()
155    }
156    /// <p>The runId of the workflow execution to terminate.</p>
157    pub fn run_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
158        self.inner = self.inner.run_id(input.into());
159        self
160    }
161    /// <p>The runId of the workflow execution to terminate.</p>
162    pub fn set_run_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
163        self.inner = self.inner.set_run_id(input);
164        self
165    }
166    /// <p>The runId of the workflow execution to terminate.</p>
167    pub fn get_run_id(&self) -> &::std::option::Option<::std::string::String> {
168        self.inner.get_run_id()
169    }
170    /// <p>A descriptive reason for terminating the workflow execution.</p>
171    pub fn reason(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
172        self.inner = self.inner.reason(input.into());
173        self
174    }
175    /// <p>A descriptive reason for terminating the workflow execution.</p>
176    pub fn set_reason(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
177        self.inner = self.inner.set_reason(input);
178        self
179    }
180    /// <p>A descriptive reason for terminating the workflow execution.</p>
181    pub fn get_reason(&self) -> &::std::option::Option<::std::string::String> {
182        self.inner.get_reason()
183    }
184    /// <p>Details for terminating the workflow execution.</p>
185    pub fn details(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
186        self.inner = self.inner.details(input.into());
187        self
188    }
189    /// <p>Details for terminating the workflow execution.</p>
190    pub fn set_details(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
191        self.inner = self.inner.set_details(input);
192        self
193    }
194    /// <p>Details for terminating the workflow execution.</p>
195    pub fn get_details(&self) -> &::std::option::Option<::std::string::String> {
196        self.inner.get_details()
197    }
198    /// <p>If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.</p>
199    /// <p>The supported child policies are:</p>
200    /// <ul>
201    /// <li>
202    /// <p><code>TERMINATE</code> – The child executions are terminated.</p></li>
203    /// <li>
204    /// <p><code>REQUEST_CANCEL</code> – A request to cancel is attempted for each child execution by recording a <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.</p></li>
205    /// <li>
206    /// <p><code>ABANDON</code> – No action is taken. The child executions continue to run.</p></li>
207    /// </ul><note>
208    /// <p>A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.</p>
209    /// </note>
210    pub fn child_policy(mut self, input: crate::types::ChildPolicy) -> Self {
211        self.inner = self.inner.child_policy(input);
212        self
213    }
214    /// <p>If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.</p>
215    /// <p>The supported child policies are:</p>
216    /// <ul>
217    /// <li>
218    /// <p><code>TERMINATE</code> – The child executions are terminated.</p></li>
219    /// <li>
220    /// <p><code>REQUEST_CANCEL</code> – A request to cancel is attempted for each child execution by recording a <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.</p></li>
221    /// <li>
222    /// <p><code>ABANDON</code> – No action is taken. The child executions continue to run.</p></li>
223    /// </ul><note>
224    /// <p>A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.</p>
225    /// </note>
226    pub fn set_child_policy(mut self, input: ::std::option::Option<crate::types::ChildPolicy>) -> Self {
227        self.inner = self.inner.set_child_policy(input);
228        self
229    }
230    /// <p>If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.</p>
231    /// <p>The supported child policies are:</p>
232    /// <ul>
233    /// <li>
234    /// <p><code>TERMINATE</code> – The child executions are terminated.</p></li>
235    /// <li>
236    /// <p><code>REQUEST_CANCEL</code> – A request to cancel is attempted for each child execution by recording a <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.</p></li>
237    /// <li>
238    /// <p><code>ABANDON</code> – No action is taken. The child executions continue to run.</p></li>
239    /// </ul><note>
240    /// <p>A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.</p>
241    /// </note>
242    pub fn get_child_policy(&self) -> &::std::option::Option<crate::types::ChildPolicy> {
243        self.inner.get_child_policy()
244    }
245}