Struct aws_sdk_swf::client::fluent_builders::RecordActivityTaskHeartbeat

pub struct RecordActivityTaskHeartbeat { /* private fields */ }

Fluent builder constructing a request to RecordActivityTaskHeartbeat.

Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker can also specify details of the progress, for example percent complete, using the details parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag returned by the service is set to true.

This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in RegisterActivityType.

This action doesn't in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history contains a ActivityTaskTimedOut event that contains the information from the last heartbeat generated by the activity worker.

The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType.

This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted.

If the cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request.

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 RecordActivityTaskHeartbeat

pub async fn customize(
    self
) -> Result<CustomizableOperation<RecordActivityTaskHeartbeat, AwsResponseRetryClassifier>, SdkError<RecordActivityTaskHeartbeatError>>

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<RecordActivityTaskHeartbeatOutput, SdkError<RecordActivityTaskHeartbeatError>>

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

If specified, contains details about the progress of the task.

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

If specified, contains details about the progress of the task.

Trait Implementations

impl Clone for RecordActivityTaskHeartbeat

fn clone(&self) -> RecordActivityTaskHeartbeat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RecordActivityTaskHeartbeat

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

Formats the value using the given formatter.