Struct aws_sdk_swf::client::fluent_builders::RequestCancelWorkflowExecution

pub struct RequestCancelWorkflowExecution { /* private fields */ }

Fluent builder constructing a request to RequestCancelWorkflowExecution.

Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.

If the runId isn't specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.

Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible.

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 RequestCancelWorkflowExecution

pub async fn customize(
    self
) -> Result<CustomizableOperation<RequestCancelWorkflowExecution, AwsResponseRetryClassifier>, SdkError<RequestCancelWorkflowExecutionError>>

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 send(
    self
) -> Result<RequestCancelWorkflowExecutionOutput, SdkError<RequestCancelWorkflowExecutionError>>

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 name of the domain containing the workflow execution to cancel.

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

The name of the domain containing the workflow execution to cancel.

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

The workflowId of the workflow execution to cancel.

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

The workflowId of the workflow execution to cancel.

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

The runId of the workflow execution to cancel.

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

The runId of the workflow execution to cancel.

Trait Implementations

impl Clone for RequestCancelWorkflowExecution

fn clone(&self) -> RequestCancelWorkflowExecution

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RequestCancelWorkflowExecution

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

Formats the value using the given formatter.