Struct aws_sdk_sfn::operation::get_activity_task::builders::GetActivityTaskFluentBuilder

pub struct GetActivityTaskFluentBuilder { /* private fields */ }

Fluent builder constructing a request to GetActivityTask.

Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string.

This API action isn't logged in CloudTrail.

Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request).

Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide.

Implementations

impl GetActivityTaskFluentBuilder

pub fn as_input(&self) -> &GetActivityTaskInputBuilder

Access the GetActivityTask as a reference.

pub async fn send( self ) -> Result<GetActivityTaskOutput, SdkError<GetActivityTaskError, 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<GetActivityTaskOutput, GetActivityTaskError, Self>

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

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

The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity.)

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

The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity.)

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

The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity.)

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

You can provide an arbitrary name in order to identify the worker that the task is assigned to. This name is used when it is logged in the execution history.

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

You can provide an arbitrary name in order to identify the worker that the task is assigned to. This name is used when it is logged in the execution history.

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

You can provide an arbitrary name in order to identify the worker that the task is assigned to. This name is used when it is logged in the execution history.

Trait Implementations

impl Clone for GetActivityTaskFluentBuilder

fn clone(&self) -> GetActivityTaskFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetActivityTaskFluentBuilder

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

Formats the value using the given formatter.