swf_poll_for_activity_task: Used by workers to get an ActivityTask from the specified...

View source: R/swf_operations.R

swf_poll_for_activity_taskR Documentation

Used by workers to get an ActivityTask from the specified activity taskList

Description

Used by workers to get an ActivityTask from the specified activity taskList. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. 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 an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly.

See https://www.paws-r-sdk.com/docs/swf_poll_for_activity_task/ for full documentation.

Usage

swf_poll_for_activity_task(domain, taskList, identity = NULL)

Arguments

domain

[required] The name of the domain that contains the task lists being polled.

taskList

[required] Specifies the task list to poll for activity tasks.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (⁠U+0000`-`U+001f⁠ | ⁠U+007f`-`U+009f⁠). Also, it must not be the literal string arn.

identity

Identity of the worker making the request, recorded in the ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.


paws.application.integration documentation built on Sept. 12, 2023, 1:18 a.m.