1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::terminate_workflow_execution::_terminate_workflow_execution_output::TerminateWorkflowExecutionOutputBuilder;
pub use crate::operation::terminate_workflow_execution::_terminate_workflow_execution_input::TerminateWorkflowExecutionInputBuilder;
/// Fluent builder constructing a request to `TerminateWorkflowExecution`.
///
/// <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>
/// <p>If the identified workflow execution was in progress, it is terminated immediately.</p>
/// </important> <note>
/// <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>
/// </note> <note>
/// <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>
/// </note>
/// <p> <b>Access Control</b> </p>
/// <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>
/// <ul>
/// <li> <p>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</p> </li>
/// <li> <p>Use an <code>Action</code> element to allow or deny permission to call this action.</p> </li>
/// <li> <p>You cannot use an IAM policy to constrain this action's parameters.</p> </li>
/// </ul>
/// <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>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct TerminateWorkflowExecutionFluentBuilder {
handle: std::sync::Arc<crate::client::Handle>,
inner: crate::operation::terminate_workflow_execution::builders::TerminateWorkflowExecutionInputBuilder
}
impl TerminateWorkflowExecutionFluentBuilder {
/// Creates a new `TerminateWorkflowExecution`.
pub(crate) fn new(handle: std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::terminate_workflow_execution::TerminateWorkflowExecution,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<
crate::operation::terminate_workflow_execution::TerminateWorkflowExecutionError,
>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::client::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::operation::terminate_workflow_execution::TerminateWorkflowExecutionOutput,
aws_smithy_http::result::SdkError<
crate::operation::terminate_workflow_execution::TerminateWorkflowExecutionError,
>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The domain of the workflow execution to terminate.</p>
pub fn domain(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.domain(input.into());
self
}
/// <p>The domain of the workflow execution to terminate.</p>
pub fn set_domain(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_domain(input);
self
}
/// <p>The workflowId of the workflow execution to terminate.</p>
pub fn workflow_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.workflow_id(input.into());
self
}
/// <p>The workflowId of the workflow execution to terminate.</p>
pub fn set_workflow_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_workflow_id(input);
self
}
/// <p>The runId of the workflow execution to terminate.</p>
pub fn run_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.run_id(input.into());
self
}
/// <p>The runId of the workflow execution to terminate.</p>
pub fn set_run_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_run_id(input);
self
}
/// <p> A descriptive reason for terminating the workflow execution.</p>
pub fn reason(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.reason(input.into());
self
}
/// <p> A descriptive reason for terminating the workflow execution.</p>
pub fn set_reason(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_reason(input);
self
}
/// <p> Details for terminating the workflow execution.</p>
pub fn details(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.details(input.into());
self
}
/// <p> Details for terminating the workflow execution.</p>
pub fn set_details(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_details(input);
self
}
/// <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>
/// <p>The supported child policies are:</p>
/// <ul>
/// <li> <p> <code>TERMINATE</code> – The child executions are terminated.</p> </li>
/// <li> <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>
/// <li> <p> <code>ABANDON</code> – No action is taken. The child executions continue to run.</p> </li>
/// </ul> <note>
/// <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>
/// </note>
pub fn child_policy(mut self, input: crate::types::ChildPolicy) -> Self {
self.inner = self.inner.child_policy(input);
self
}
/// <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>
/// <p>The supported child policies are:</p>
/// <ul>
/// <li> <p> <code>TERMINATE</code> – The child executions are terminated.</p> </li>
/// <li> <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>
/// <li> <p> <code>ABANDON</code> – No action is taken. The child executions continue to run.</p> </li>
/// </ul> <note>
/// <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>
/// </note>
pub fn set_child_policy(
mut self,
input: std::option::Option<crate::types::ChildPolicy>,
) -> Self {
self.inner = self.inner.set_child_policy(input);
self
}
}