/AWS1/IF_SWF=>RESPONDACTIVITYTASKCANCELED()

About RespondActivityTaskCanceled

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.

Method Signature

METHODS /AWS1/IF_SWF~RESPONDACTIVITYTASKCANCELED
  IMPORTING
    !IV_TASKTOKEN TYPE /AWS1/SWFTASKTOKEN OPTIONAL
    !IV_DETAILS TYPE /AWS1/SWFDATA OPTIONAL
  RAISING
    /AWS1/CX_SWFOPNOTPERMITTEDFA00
    /AWS1/CX_SWFUNKNOWNRESRCFAULT
    /AWS1/CX_SWFCLIENTEXC
    /AWS1/CX_SWFSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_tasktoken TYPE /AWS1/SWFTASKTOKEN /AWS1/SWFTASKTOKEN

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.

Optional arguments:

iv_details TYPE /AWS1/SWFDATA /AWS1/SWFDATA

Information about the cancellation.

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

lo_client->respondactivitytaskcanceled(
  iv_details = |string|
  iv_tasktoken = |string|
).