Amazonka.SWF.RespondActivityTaskCompleted

Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). The result appears in the ActivityTaskCompleted event in the workflow history.

If the requested task doesn't complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled.

A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.

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.
• You cannot use an IAM policy to constrain this action's parameters.

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.

Creating a Request

data RespondActivityTaskCompleted

See: newRespondActivityTaskCompleted smart constructor.

Constructors

RespondActivityTaskCompleted'

Fields

• result :: Maybe Text

  The result of the activity task. It is a free form string that is implementation specific.

• taskToken :: Text

  The taskToken of the ActivityTask.

  taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

Instances

ToJSON RespondActivityTaskCompleted

Defined in Amazonka.SWF.RespondActivityTaskCompleted

Methods

toJSON :: RespondActivityTaskCompleted -> Value

toEncoding :: RespondActivityTaskCompleted -> Encoding

toJSONList :: [RespondActivityTaskCompleted] -> Value

toEncodingList :: [RespondActivityTaskCompleted] -> Encoding

ToHeaders RespondActivityTaskCompleted

Defined in Amazonka.SWF.RespondActivityTaskCompleted

Methods

toHeaders :: RespondActivityTaskCompleted -> [Header]

ToPath RespondActivityTaskCompleted

Defined in Amazonka.SWF.RespondActivityTaskCompleted

Methods

toPath :: RespondActivityTaskCompleted -> ByteString

ToQuery RespondActivityTaskCompleted

Defined in Amazonka.SWF.RespondActivityTaskCompleted

Methods

toQuery :: RespondActivityTaskCompleted -> QueryString

AWSRequest RespondActivityTaskCompleted

Defined in Amazonka.SWF.RespondActivityTaskCompleted

Associated Types

type AWSResponse RespondActivityTaskCompleted

Methods

request :: (Service -> Service) -> RespondActivityTaskCompleted -> Request RespondActivityTaskCompleted

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RespondActivityTaskCompleted -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RespondActivityTaskCompleted)))

Generic RespondActivityTaskCompleted

Defined in Amazonka.SWF.RespondActivityTaskCompleted

Associated Types

type Rep RespondActivityTaskCompleted :: Type -> Type

Methods

from :: RespondActivityTaskCompleted -> Rep RespondActivityTaskCompleted x

to :: Rep RespondActivityTaskCompleted x -> RespondActivityTaskCompleted

Read RespondActivityTaskCompleted

Defined in Amazonka.SWF.RespondActivityTaskCompleted

Methods

readsPrec :: Int -> ReadS RespondActivityTaskCompleted

readList :: ReadS [RespondActivityTaskCompleted]

readPrec :: ReadPrec RespondActivityTaskCompleted

readListPrec :: ReadPrec [RespondActivityTaskCompleted]

Show RespondActivityTaskCompleted

Defined in Amazonka.SWF.RespondActivityTaskCompleted

Methods

showsPrec :: Int -> RespondActivityTaskCompleted -> ShowS

show :: RespondActivityTaskCompleted -> String

showList :: [RespondActivityTaskCompleted] -> ShowS

NFData RespondActivityTaskCompleted

Defined in Amazonka.SWF.RespondActivityTaskCompleted

Methods

rnf :: RespondActivityTaskCompleted -> ()

Eq RespondActivityTaskCompleted

Defined in Amazonka.SWF.RespondActivityTaskCompleted

Methods

(==) :: RespondActivityTaskCompleted -> RespondActivityTaskCompleted -> Bool

(/=) :: RespondActivityTaskCompleted -> RespondActivityTaskCompleted -> Bool

Hashable RespondActivityTaskCompleted

Defined in Amazonka.SWF.RespondActivityTaskCompleted

Methods

hashWithSalt :: Int -> RespondActivityTaskCompleted -> Int

hash :: RespondActivityTaskCompleted -> Int

type AWSResponse RespondActivityTaskCompleted

Defined in Amazonka.SWF.RespondActivityTaskCompleted

type AWSResponse RespondActivityTaskCompleted = RespondActivityTaskCompletedResponse

type Rep RespondActivityTaskCompleted

Defined in Amazonka.SWF.RespondActivityTaskCompleted

type Rep RespondActivityTaskCompleted = D1 ('MetaData "RespondActivityTaskCompleted" "Amazonka.SWF.RespondActivityTaskCompleted" "amazonka-swf-2.0-DdTBZQl9wbxDbv1sov8BbM" 'False) (C1 ('MetaCons "RespondActivityTaskCompleted'" 'PrefixI 'True) (S1 ('MetaSel ('Just "result") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "taskToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newRespondActivityTaskCompleted

Arguments

:: Text

$sel:taskToken:RespondActivityTaskCompleted'

-> RespondActivityTaskCompleted

Create a value of RespondActivityTaskCompleted 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:

RespondActivityTaskCompleted, respondActivityTaskCompleted_result - The result of the activity task. It is a free form string that is implementation specific.

$sel:taskToken:RespondActivityTaskCompleted', respondActivityTaskCompleted_taskToken - The taskToken of the ActivityTask.

taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

Request Lenses

respondActivityTaskCompleted_result :: Lens' RespondActivityTaskCompleted (Maybe Text)

The result of the activity task. It is a free form string that is implementation specific.

respondActivityTaskCompleted_taskToken :: Lens' RespondActivityTaskCompleted Text

The taskToken of the ActivityTask.

taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

Destructuring the Response

data RespondActivityTaskCompletedResponse

See: newRespondActivityTaskCompletedResponse smart constructor.

Constructors

RespondActivityTaskCompletedResponse'

Instances

Generic RespondActivityTaskCompletedResponse

Defined in Amazonka.SWF.RespondActivityTaskCompleted

Associated Types

type Rep RespondActivityTaskCompletedResponse :: Type -> Type

Methods

from :: RespondActivityTaskCompletedResponse -> Rep RespondActivityTaskCompletedResponse x

to :: Rep RespondActivityTaskCompletedResponse x -> RespondActivityTaskCompletedResponse

Read RespondActivityTaskCompletedResponse

Defined in Amazonka.SWF.RespondActivityTaskCompleted

Methods

readsPrec :: Int -> ReadS RespondActivityTaskCompletedResponse

readList :: ReadS [RespondActivityTaskCompletedResponse]

readPrec :: ReadPrec RespondActivityTaskCompletedResponse

readListPrec :: ReadPrec [RespondActivityTaskCompletedResponse]

Show RespondActivityTaskCompletedResponse

Defined in Amazonka.SWF.RespondActivityTaskCompleted

Methods

showsPrec :: Int -> RespondActivityTaskCompletedResponse -> ShowS

show :: RespondActivityTaskCompletedResponse -> String

showList :: [RespondActivityTaskCompletedResponse] -> ShowS

NFData RespondActivityTaskCompletedResponse

Defined in Amazonka.SWF.RespondActivityTaskCompleted

Methods

rnf :: RespondActivityTaskCompletedResponse -> ()

Eq RespondActivityTaskCompletedResponse

Defined in Amazonka.SWF.RespondActivityTaskCompleted

Methods

(==) :: RespondActivityTaskCompletedResponse -> RespondActivityTaskCompletedResponse -> Bool

(/=) :: RespondActivityTaskCompletedResponse -> RespondActivityTaskCompletedResponse -> Bool

type Rep RespondActivityTaskCompletedResponse

Defined in Amazonka.SWF.RespondActivityTaskCompleted

type Rep RespondActivityTaskCompletedResponse = D1 ('MetaData "RespondActivityTaskCompletedResponse" "Amazonka.SWF.RespondActivityTaskCompleted" "amazonka-swf-2.0-DdTBZQl9wbxDbv1sov8BbM" 'False) (C1 ('MetaCons "RespondActivityTaskCompletedResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newRespondActivityTaskCompletedResponse :: RespondActivityTaskCompletedResponse

Create a value of RespondActivityTaskCompletedResponse with all optional fields omitted.

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