pub struct RespondActivityTaskCompleted { /* private fields */ }
Expand description
Fluent builder constructing a request to RespondActivityTaskCompleted
.
Used by workers to tell the service that the ActivityTask
identified by the taskToken
completed successfully with a result
(if provided). The result
appears in the ActivityTaskCompleted
event in the workflow history.
If the requested task doesn't complete successfully, use RespondActivityTaskFailed
instead. If the worker finds that the task is canceled through the canceled
flag returned by RecordActivityTaskHeartbeat
, it should cancel the task, clean up and then call RespondActivityTaskCanceled
.
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
sourceimpl RespondActivityTaskCompleted
impl RespondActivityTaskCompleted
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<RespondActivityTaskCompleted, AwsResponseRetryClassifier>, SdkError<RespondActivityTaskCompletedError>>
pub async fn customize(
self
) -> Result<CustomizableOperation<RespondActivityTaskCompleted, AwsResponseRetryClassifier>, SdkError<RespondActivityTaskCompletedError>>
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.
sourcepub async fn send(
self
) -> Result<RespondActivityTaskCompletedOutput, SdkError<RespondActivityTaskCompletedError>>
pub async fn send(
self
) -> Result<RespondActivityTaskCompletedOutput, SdkError<RespondActivityTaskCompletedError>>
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.
sourcepub fn task_token(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_task_token(self, input: Option<String>) -> Self
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.
sourcepub fn result(self, input: impl Into<String>) -> Self
pub fn result(self, input: impl Into<String>) -> Self
The result of the activity task. It is a free form string that is implementation specific.
sourcepub fn set_result(self, input: Option<String>) -> Self
pub fn set_result(self, input: Option<String>) -> Self
The result of the activity task. It is a free form string that is implementation specific.
Trait Implementations
sourceimpl Clone for RespondActivityTaskCompleted
impl Clone for RespondActivityTaskCompleted
sourcefn clone(&self) -> RespondActivityTaskCompleted
fn clone(&self) -> RespondActivityTaskCompleted
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more