libZSservicesZSamazonka-swfZSamazonka-swf
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SWF.RespondActivityTaskCanceled

Description

Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be provided using the details argument.

These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history.

Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the activity can be safely undone or abandoned.

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.

Synopsis

Creating a Request

data RespondActivityTaskCanceled Source #

See: newRespondActivityTaskCanceled smart constructor.

Constructors

RespondActivityTaskCanceled' 

Fields

  • details :: Maybe Text

    Information about the cancellation.

  • 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

Instances details
Eq RespondActivityTaskCanceled Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskCanceled

Read RespondActivityTaskCanceled Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskCanceled

Show RespondActivityTaskCanceled Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskCanceled

Generic RespondActivityTaskCanceled Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskCanceled

Associated Types

type Rep RespondActivityTaskCanceled :: Type -> Type #

NFData RespondActivityTaskCanceled Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskCanceled

Hashable RespondActivityTaskCanceled Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskCanceled

ToJSON RespondActivityTaskCanceled Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskCanceled

AWSRequest RespondActivityTaskCanceled Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskCanceled

ToHeaders RespondActivityTaskCanceled Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskCanceled

ToPath RespondActivityTaskCanceled Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskCanceled

ToQuery RespondActivityTaskCanceled Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskCanceled

type Rep RespondActivityTaskCanceled Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskCanceled

type Rep RespondActivityTaskCanceled = D1 ('MetaData "RespondActivityTaskCanceled" "Amazonka.SWF.RespondActivityTaskCanceled" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "RespondActivityTaskCanceled'" 'PrefixI 'True) (S1 ('MetaSel ('Just "details") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "taskToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse RespondActivityTaskCanceled Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskCanceled

newRespondActivityTaskCanceled Source #

Create a value of RespondActivityTaskCanceled 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:details:RespondActivityTaskCanceled', respondActivityTaskCanceled_details - Information about the cancellation.

$sel:taskToken:RespondActivityTaskCanceled', respondActivityTaskCanceled_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

respondActivityTaskCanceled_taskToken :: Lens' RespondActivityTaskCanceled Text Source #

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 RespondActivityTaskCanceledResponse Source #

Instances

Instances details
Eq RespondActivityTaskCanceledResponse Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskCanceled

Read RespondActivityTaskCanceledResponse Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskCanceled

Show RespondActivityTaskCanceledResponse Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskCanceled

Generic RespondActivityTaskCanceledResponse Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskCanceled

NFData RespondActivityTaskCanceledResponse Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskCanceled

type Rep RespondActivityTaskCanceledResponse Source # 
Instance details

Defined in Amazonka.SWF.RespondActivityTaskCanceled

type Rep RespondActivityTaskCanceledResponse = D1 ('MetaData "RespondActivityTaskCanceledResponse" "Amazonka.SWF.RespondActivityTaskCanceled" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "RespondActivityTaskCanceledResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newRespondActivityTaskCanceledResponse :: RespondActivityTaskCanceledResponse Source #

Create a value of RespondActivityTaskCanceledResponse with all optional fields omitted.

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