New API Documentation - Developer Preview Available
We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.
Used by deciders to get a DecisionTask from the specified decision
taskList. A decision task may be returned for any open workflow execution that
is using the specified task list. The task includes a paginated view of the history of the
workflow execution. The decider should use the workflow type and the history to determine how
to properly handle the task.
This action initiates a long poll, where the service holds the HTTP connection open and
responds as soon a task becomes available. If no decision task is available in the specified
task list before the timeout of 60 seconds expires, an empty result is returned. An empty
result, in this context, means that a DecisionTask is returned, but that the value of
taskToken is an empty string.
Deciders should set their client side socket timeout to at least 70 seconds (10
seconds higher than the timeout).
Because the number of workflow history events for a single workflow execution might
be very large, the result returned might be split up across a number of pages. To retrieve
subsequent pages, make additional calls to PollForDecisionTask using the
nextPageToken returned by the initial call. Note that you do
not call GetWorkflowExecutionHistory with this
nextPageToken. Instead, call PollForDecisionTask
again.
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.
Constrain the taskList.name parameter by using a
Condition element with the swf:taskList.name key to allow the
action to access only certain task lists.
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.
Example
Use a bare-bones client and the command you need to make an API call.
Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.
Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
Used by deciders to get a DecisionTask from the specified decision
taskList. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task.This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.
Deciders should set their client side socket timeout to at least 70 seconds (10 seconds higher than the timeout).
Because the number of workflow history events for a single workflow execution might be very large, the result returned might be split up across a number of pages. To retrieve subsequent pages, make additional calls to
PollForDecisionTaskusing thenextPageTokenreturned by the initial call. Note that you do not callGetWorkflowExecutionHistorywith thisnextPageToken. Instead, callPollForDecisionTaskagain.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a
Resourceelement with the domain name to limit the action to only specified domains.Use an
Actionelement to allow or deny permission to call this action.Constrain the
taskList.nameparameter by using aConditionelement with theswf:taskList.namekey to allow the action to access only certain task lists.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
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.Example
Use a bare-bones client and the command you need to make an API call.
Param
PollForDecisionTaskCommandInput
Returns
PollForDecisionTaskCommandOutput
See
inputshape.responseshape.configshape.Throws
LimitExceededFault (client fault)
Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.
Throws
OperationNotPermittedFault (client fault)
Returned when the caller doesn't have sufficient permissions to invoke the action.
Throws
UnknownResourceFault (client fault)
Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
Throws
SWFServiceException
Base exception class for all service exceptions from SWF service.