Struct aws_sdk_sfn::operation::send_task_heartbeat::builders::SendTaskHeartbeatFluentBuilder

pub struct SendTaskHeartbeatFluentBuilder { /* private fields */ }

Fluent builder constructing a request to SendTaskHeartbeat.

Used by activity workers and Task states using the callback pattern, and optionally Task states using the job run pattern to report to Step Functions that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition (HeartbeatSeconds). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for tasks using the job run or callback pattern.

The Timeout of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval for heartbeats.

Implementations

impl SendTaskHeartbeatFluentBuilder

pub fn as_input(&self) -> &SendTaskHeartbeatInputBuilder

Access the SendTaskHeartbeat as a reference.

pub async fn send( self ) -> Result<SendTaskHeartbeatOutput, SdkError<SendTaskHeartbeatError, HttpResponse>>

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 customize( self ) -> CustomizableOperation<SendTaskHeartbeatOutput, SendTaskHeartbeatError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.

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

The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.

pub fn get_task_token(&self) -> &Option<String>

The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.

Trait Implementations

impl Clone for SendTaskHeartbeatFluentBuilder

fn clone(&self) -> SendTaskHeartbeatFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SendTaskHeartbeatFluentBuilder

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

Formats the value using the given formatter.