Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SWF.PollForActivityTask

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll 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.
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.

Synopsis

Creating a Request

data PollForActivityTask Source #

See: newPollForActivityTask smart constructor.

Constructors

PollForActivityTask'

Fields

identity :: Maybe Text
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.
domain :: Text
The name of the domain that contains the task lists being polled.
taskList :: TaskList
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 (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

Instances

Instances details

Eq PollForActivityTask Source #
Instance details Defined in Amazonka.SWF.PollForActivityTask Methods (==) :: PollForActivityTask -> PollForActivityTask -> Bool # (/=) :: PollForActivityTask -> PollForActivityTask -> Bool #
Read PollForActivityTask Source #
Instance details Defined in Amazonka.SWF.PollForActivityTask Methods readsPrec :: Int -> ReadS PollForActivityTask # readList :: ReadS [PollForActivityTask] # readPrec :: ReadPrec PollForActivityTask # readListPrec :: ReadPrec [PollForActivityTask] #
Show PollForActivityTask Source #
Instance details Defined in Amazonka.SWF.PollForActivityTask Methods showsPrec :: Int -> PollForActivityTask -> ShowS # show :: PollForActivityTask -> String # showList :: [PollForActivityTask] -> ShowS #
Generic PollForActivityTask Source #
Instance details Defined in Amazonka.SWF.PollForActivityTask Associated Types type Rep PollForActivityTask :: Type -> Type # Methods from :: PollForActivityTask -> Rep PollForActivityTask x # to :: Rep PollForActivityTask x -> PollForActivityTask #
NFData PollForActivityTask Source #
Instance details Defined in Amazonka.SWF.PollForActivityTask Methods rnf :: PollForActivityTask -> () #
Hashable PollForActivityTask Source #
Instance details Defined in Amazonka.SWF.PollForActivityTask Methods hashWithSalt :: Int -> PollForActivityTask -> Int # hash :: PollForActivityTask -> Int #
ToJSON PollForActivityTask Source #
Instance details Defined in Amazonka.SWF.PollForActivityTask Methods toJSON :: PollForActivityTask -> Value # toEncoding :: PollForActivityTask -> Encoding # toJSONList :: [PollForActivityTask] -> Value # toEncodingList :: [PollForActivityTask] -> Encoding #
AWSRequest PollForActivityTask Source #
Instance details Defined in Amazonka.SWF.PollForActivityTask Associated Types type AWSResponse PollForActivityTask # Methods request :: PollForActivityTask -> Request PollForActivityTask # response :: MonadResource m => Logger -> Service -> Proxy PollForActivityTask -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PollForActivityTask))) #
ToHeaders PollForActivityTask Source #
Instance details Defined in Amazonka.SWF.PollForActivityTask Methods toHeaders :: PollForActivityTask -> [Header] #
ToPath PollForActivityTask Source #
Instance details Defined in Amazonka.SWF.PollForActivityTask Methods toPath :: PollForActivityTask -> ByteString #
ToQuery PollForActivityTask Source #
Instance details Defined in Amazonka.SWF.PollForActivityTask Methods toQuery :: PollForActivityTask -> QueryString #
type Rep PollForActivityTask Source #
Instance details Defined in Amazonka.SWF.PollForActivityTask type Rep PollForActivityTask = D1 ('MetaData "PollForActivityTask" "Amazonka.SWF.PollForActivityTask" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "PollForActivityTask'" 'PrefixI 'True) (S1 ('MetaSel ('Just "identity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "taskList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TaskList))))
type AWSResponse PollForActivityTask Source #
Instance details Defined in Amazonka.SWF.PollForActivityTask type AWSResponse PollForActivityTask = PollForActivityTaskResponse

newPollForActivityTask Source #

Arguments

:: Text	`$sel:domain:PollForActivityTask'`
-> TaskList	`$sel:taskList:PollForActivityTask'`
-> PollForActivityTask

Create a value of PollForActivityTask with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:identity:PollForActivityTask', pollForActivityTask_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.

$sel:domain:PollForActivityTask', pollForActivityTask_domain - The name of the domain that contains the task lists being polled.

$sel:taskList:PollForActivityTask', pollForActivityTask_taskList - 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 (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

Request Lenses

pollForActivityTask_identity :: Lens' PollForActivityTask (Maybe Text) Source #

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.

pollForActivityTask_domain :: Lens' PollForActivityTask Text Source #

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

pollForActivityTask_taskList :: Lens' PollForActivityTask TaskList Source #

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 (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

Destructuring the Response

data PollForActivityTaskResponse Source #

Unit of work sent to an activity worker.

See: newPollForActivityTaskResponse smart constructor.

Constructors

PollForActivityTaskResponse'

Fields

activityType :: Maybe ActivityType
The type of this activity task.
activityId :: Maybe Text
The unique ID of the task.
input :: Maybe Text
The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation.
taskToken :: Maybe Text
The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.
workflowExecution :: Maybe WorkflowExecution
The workflow execution that started this activity task.
httpStatus :: Int
The response's http status code.
startedEventId :: Integer
The ID of the ActivityTaskStarted event recorded in the history.

Instances

Instances details

Eq PollForActivityTaskResponse Source #
Instance details Defined in Amazonka.SWF.PollForActivityTask Methods (==) :: PollForActivityTaskResponse -> PollForActivityTaskResponse -> Bool # (/=) :: PollForActivityTaskResponse -> PollForActivityTaskResponse -> Bool #
Read PollForActivityTaskResponse Source #
Instance details Defined in Amazonka.SWF.PollForActivityTask Methods readsPrec :: Int -> ReadS PollForActivityTaskResponse # readList :: ReadS [PollForActivityTaskResponse] # readPrec :: ReadPrec PollForActivityTaskResponse # readListPrec :: ReadPrec [PollForActivityTaskResponse] #
Show PollForActivityTaskResponse Source #
Instance details Defined in Amazonka.SWF.PollForActivityTask Methods showsPrec :: Int -> PollForActivityTaskResponse -> ShowS # show :: PollForActivityTaskResponse -> String # showList :: [PollForActivityTaskResponse] -> ShowS #
Generic PollForActivityTaskResponse Source #
Instance details Defined in Amazonka.SWF.PollForActivityTask Associated Types type Rep PollForActivityTaskResponse :: Type -> Type # Methods from :: PollForActivityTaskResponse -> Rep PollForActivityTaskResponse x # to :: Rep PollForActivityTaskResponse x -> PollForActivityTaskResponse #
NFData PollForActivityTaskResponse Source #
Instance details Defined in Amazonka.SWF.PollForActivityTask Methods rnf :: PollForActivityTaskResponse -> () #
type Rep PollForActivityTaskResponse Source #
Instance details Defined in Amazonka.SWF.PollForActivityTask type Rep PollForActivityTaskResponse = D1 ('MetaData "PollForActivityTaskResponse" "Amazonka.SWF.PollForActivityTask" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "PollForActivityTaskResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "activityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActivityType)) :: (S1 ('MetaSel ('Just "activityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "taskToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "workflowExecution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowExecution))) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "startedEventId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer)))))

newPollForActivityTaskResponse Source #

Arguments

:: Int	`$sel:httpStatus:PollForActivityTaskResponse'`
-> Integer	`$sel:startedEventId:PollForActivityTaskResponse'`
-> PollForActivityTaskResponse

Create a value of PollForActivityTaskResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:activityType:PollForActivityTaskResponse', pollForActivityTaskResponse_activityType - The type of this activity task.

$sel:activityId:PollForActivityTaskResponse', pollForActivityTaskResponse_activityId - The unique ID of the task.

$sel:input:PollForActivityTaskResponse', pollForActivityTaskResponse_input - The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation.

$sel:taskToken:PollForActivityTaskResponse', pollForActivityTaskResponse_taskToken - The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

$sel:workflowExecution:PollForActivityTaskResponse', pollForActivityTaskResponse_workflowExecution - The workflow execution that started this activity task.

$sel:httpStatus:PollForActivityTaskResponse', pollForActivityTaskResponse_httpStatus - The response's http status code.

$sel:startedEventId:PollForActivityTaskResponse', pollForActivityTaskResponse_startedEventId - The ID of the ActivityTaskStarted event recorded in the history.

Response Lenses

pollForActivityTaskResponse_activityType :: Lens' PollForActivityTaskResponse (Maybe ActivityType) Source #

The type of this activity task.

pollForActivityTaskResponse_activityId :: Lens' PollForActivityTaskResponse (Maybe Text) Source #

The unique ID of the task.

pollForActivityTaskResponse_input :: Lens' PollForActivityTaskResponse (Maybe Text) Source #

The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation.

pollForActivityTaskResponse_taskToken :: Lens' PollForActivityTaskResponse (Maybe Text) Source #

The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

pollForActivityTaskResponse_workflowExecution :: Lens' PollForActivityTaskResponse (Maybe WorkflowExecution) Source #

The workflow execution that started this activity task.

pollForActivityTaskResponse_httpStatus :: Lens' PollForActivityTaskResponse Int Source #

The response's http status code.

pollForActivityTaskResponse_startedEventId :: Lens' PollForActivityTaskResponse Integer Source #

The ID of the ActivityTaskStarted event recorded in the history.