Struct aws_sdk_swf::client::fluent_builders::TerminateWorkflowExecution

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

Fluent builder constructing a request to TerminateWorkflowExecution.

Records a WorkflowExecutionTerminated 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.

If the identified workflow execution was in progress, it is terminated immediately.

If a runId isn't specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain.

You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution doesn't.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.

• Use an Action element to allow or deny permission to call this action.

• You cannot use an IAM policy to constrain this action's parameters.

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 cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Implementations

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

pub async fn send(
    self
) -> Result<TerminateWorkflowExecutionOutput, SdkError<TerminateWorkflowExecutionError>> where
    R::Policy: SmithyRetryPolicy<TerminateWorkflowExecutionInputOperationOutputAlias, TerminateWorkflowExecutionOutput, TerminateWorkflowExecutionError, TerminateWorkflowExecutionInputOperationRetryAlias>, 

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 domain(self, input: impl Into<String>) -> Self

The domain of the workflow execution to terminate.

pub fn set_domain(self, input: Option<String>) -> Self

The domain of the workflow execution to terminate.

pub fn workflow_id(self, input: impl Into<String>) -> Self

The workflowId of the workflow execution to terminate.

pub fn set_workflow_id(self, input: Option<String>) -> Self

The workflowId of the workflow execution to terminate.

pub fn run_id(self, input: impl Into<String>) -> Self

The runId of the workflow execution to terminate.

pub fn set_run_id(self, input: Option<String>) -> Self

The runId of the workflow execution to terminate.

pub fn reason(self, input: impl Into<String>) -> Self

A descriptive reason for terminating the workflow execution.

pub fn set_reason(self, input: Option<String>) -> Self

A descriptive reason for terminating the workflow execution.

pub fn details(self, input: impl Into<String>) -> Self

Details for terminating the workflow execution.

pub fn set_details(self, input: Option<String>) -> Self

Details for terminating the workflow execution.

pub fn child_policy(self, input: ChildPolicy) -> Self

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.

The supported child policies are:

• TERMINATE – The child executions are terminated.

• REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

• ABANDON – No action is taken. The child executions continue to run.

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.

pub fn set_child_policy(self, input: Option<ChildPolicy>) -> Self

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.

The supported child policies are:

• TERMINATE – The child executions are terminated.

• REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

• ABANDON – No action is taken. The child executions continue to run.

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.

Trait Implementations

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

fn clone(&self) -> TerminateWorkflowExecution<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 TerminateWorkflowExecution<C, M, R>

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

Formats the value using the given formatter.