Struct aws_sdk_swf::client::fluent_builders::RespondActivityTaskCanceled

pub struct RespondActivityTaskCanceled { /* private fields */ }

Fluent builder constructing a request to RespondActivityTaskCanceled.

Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be provided using the details argument.

These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history.

Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the activity can be safely undone or abandoned.

A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.

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 RespondActivityTaskCanceled

pub async fn customize(
    self
) -> Result<CustomizableOperation<RespondActivityTaskCanceled, AwsResponseRetryClassifier>, SdkError<RespondActivityTaskCanceledError>>

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<RespondActivityTaskCanceledOutput, SdkError<RespondActivityTaskCanceledError>>

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

The taskToken of the ActivityTask.

taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

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

The taskToken of the ActivityTask.

taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

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

Information about the cancellation.

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

Information about the cancellation.

Trait Implementations

impl Clone for RespondActivityTaskCanceled

fn clone(&self) -> RespondActivityTaskCanceled

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RespondActivityTaskCanceled

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

Formats the value using the given formatter.