Network.AWS.SWF.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.

Important: 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 .

Creating a Request

respondActivityTaskCanceled

Arguments

:: Text

rTaskToken

-> RespondActivityTaskCanceled

Creates a value of RespondActivityTaskCanceled with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rDetails - Information about the cancellation.
• rTaskToken - The taskToken of the ActivityTask . Important: 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.

data RespondActivityTaskCanceled

See: respondActivityTaskCanceled smart constructor.

Instances

Eq RespondActivityTaskCanceled

Methods

(==) :: RespondActivityTaskCanceled -> RespondActivityTaskCanceled -> Bool

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

Data RespondActivityTaskCanceled

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RespondActivityTaskCanceled -> c RespondActivityTaskCanceled

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RespondActivityTaskCanceled

toConstr :: RespondActivityTaskCanceled -> Constr

dataTypeOf :: RespondActivityTaskCanceled -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RespondActivityTaskCanceled)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RespondActivityTaskCanceled)

gmapT :: (forall b. Data b => b -> b) -> RespondActivityTaskCanceled -> RespondActivityTaskCanceled

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RespondActivityTaskCanceled -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RespondActivityTaskCanceled -> r

gmapQ :: (forall d. Data d => d -> u) -> RespondActivityTaskCanceled -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RespondActivityTaskCanceled -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RespondActivityTaskCanceled -> m RespondActivityTaskCanceled

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RespondActivityTaskCanceled -> m RespondActivityTaskCanceled

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RespondActivityTaskCanceled -> m RespondActivityTaskCanceled

Read RespondActivityTaskCanceled

Methods

readsPrec :: Int -> ReadS RespondActivityTaskCanceled

readList :: ReadS [RespondActivityTaskCanceled]

readPrec :: ReadPrec RespondActivityTaskCanceled

readListPrec :: ReadPrec [RespondActivityTaskCanceled]

Show RespondActivityTaskCanceled

Methods

showsPrec :: Int -> RespondActivityTaskCanceled -> ShowS

show :: RespondActivityTaskCanceled -> String

showList :: [RespondActivityTaskCanceled] -> ShowS

Generic RespondActivityTaskCanceled

Associated Types

type Rep RespondActivityTaskCanceled :: * -> *

Methods

from :: RespondActivityTaskCanceled -> Rep RespondActivityTaskCanceled x

to :: Rep RespondActivityTaskCanceled x -> RespondActivityTaskCanceled

Hashable RespondActivityTaskCanceled

Methods

hashWithSalt :: Int -> RespondActivityTaskCanceled -> Int

hash :: RespondActivityTaskCanceled -> Int

ToJSON RespondActivityTaskCanceled

Methods

toJSON :: RespondActivityTaskCanceled -> Value

toEncoding :: RespondActivityTaskCanceled -> Encoding

toJSONList :: [RespondActivityTaskCanceled] -> Value

toEncodingList :: [RespondActivityTaskCanceled] -> Encoding

NFData RespondActivityTaskCanceled

Methods

rnf :: RespondActivityTaskCanceled -> ()

AWSRequest RespondActivityTaskCanceled

Associated Types

type Rs RespondActivityTaskCanceled :: *

Methods

request :: RespondActivityTaskCanceled -> Request RespondActivityTaskCanceled

response :: MonadResource m => Logger -> Service -> Proxy * RespondActivityTaskCanceled -> ClientResponse -> m (Response RespondActivityTaskCanceled)

ToQuery RespondActivityTaskCanceled

Methods

toQuery :: RespondActivityTaskCanceled -> QueryString

ToPath RespondActivityTaskCanceled

Methods

toPath :: RespondActivityTaskCanceled -> ByteString

ToHeaders RespondActivityTaskCanceled

Methods

toHeaders :: RespondActivityTaskCanceled -> [Header]

type Rep RespondActivityTaskCanceled

type Rep RespondActivityTaskCanceled = D1 (MetaData "RespondActivityTaskCanceled" "Network.AWS.SWF.RespondActivityTaskCanceled" "amazonka-swf-1.5.0-Iq58jBNwXOICscXZ8Q27Im" False) (C1 (MetaCons "RespondActivityTaskCanceled'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_rDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_rTaskToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs RespondActivityTaskCanceled

type Rs RespondActivityTaskCanceled = RespondActivityTaskCanceledResponse

Request Lenses

rDetails :: Lens' RespondActivityTaskCanceled (Maybe Text)

Information about the cancellation.

rTaskToken :: Lens' RespondActivityTaskCanceled Text

The taskToken of the ActivityTask . Important: 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

respondActivityTaskCanceledResponse :: RespondActivityTaskCanceledResponse

Creates a value of RespondActivityTaskCanceledResponse with the minimum fields required to make a request.

data RespondActivityTaskCanceledResponse

See: respondActivityTaskCanceledResponse smart constructor.

Instances

Eq RespondActivityTaskCanceledResponse

Methods

(==) :: RespondActivityTaskCanceledResponse -> RespondActivityTaskCanceledResponse -> Bool

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

Data RespondActivityTaskCanceledResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RespondActivityTaskCanceledResponse -> c RespondActivityTaskCanceledResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RespondActivityTaskCanceledResponse

toConstr :: RespondActivityTaskCanceledResponse -> Constr

dataTypeOf :: RespondActivityTaskCanceledResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RespondActivityTaskCanceledResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RespondActivityTaskCanceledResponse)

gmapT :: (forall b. Data b => b -> b) -> RespondActivityTaskCanceledResponse -> RespondActivityTaskCanceledResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RespondActivityTaskCanceledResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RespondActivityTaskCanceledResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> RespondActivityTaskCanceledResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RespondActivityTaskCanceledResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RespondActivityTaskCanceledResponse -> m RespondActivityTaskCanceledResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RespondActivityTaskCanceledResponse -> m RespondActivityTaskCanceledResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RespondActivityTaskCanceledResponse -> m RespondActivityTaskCanceledResponse

Read RespondActivityTaskCanceledResponse

Methods

readsPrec :: Int -> ReadS RespondActivityTaskCanceledResponse

readList :: ReadS [RespondActivityTaskCanceledResponse]

readPrec :: ReadPrec RespondActivityTaskCanceledResponse

readListPrec :: ReadPrec [RespondActivityTaskCanceledResponse]

Show RespondActivityTaskCanceledResponse

Methods

showsPrec :: Int -> RespondActivityTaskCanceledResponse -> ShowS

show :: RespondActivityTaskCanceledResponse -> String

showList :: [RespondActivityTaskCanceledResponse] -> ShowS

Generic RespondActivityTaskCanceledResponse

Associated Types

type Rep RespondActivityTaskCanceledResponse :: * -> *

Methods

from :: RespondActivityTaskCanceledResponse -> Rep RespondActivityTaskCanceledResponse x

to :: Rep RespondActivityTaskCanceledResponse x -> RespondActivityTaskCanceledResponse

NFData RespondActivityTaskCanceledResponse

Methods

rnf :: RespondActivityTaskCanceledResponse -> ()

type Rep RespondActivityTaskCanceledResponse

type Rep RespondActivityTaskCanceledResponse = D1 (MetaData "RespondActivityTaskCanceledResponse" "Network.AWS.SWF.RespondActivityTaskCanceled" "amazonka-swf-1.5.0-Iq58jBNwXOICscXZ8Q27Im" False) (C1 (MetaCons "RespondActivityTaskCanceledResponse'" PrefixI False) U1)