Amazonka.StepFunctions.SendTaskHeartbeat

Used by activity workers and task states using the callback pattern to report to Step Functions that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition (HeartbeatSeconds). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for for tasks using the job run or callback pattern.

The Timeout of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval for heartbeats.

Creating a Request

data SendTaskHeartbeat

See: newSendTaskHeartbeat smart constructor.

Constructors

SendTaskHeartbeat'

Fields

• taskToken :: Text

  The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.

Instances

ToJSON SendTaskHeartbeat

Defined in Amazonka.StepFunctions.SendTaskHeartbeat

Methods

toJSON :: SendTaskHeartbeat -> Value

toEncoding :: SendTaskHeartbeat -> Encoding

toJSONList :: [SendTaskHeartbeat] -> Value

toEncodingList :: [SendTaskHeartbeat] -> Encoding

ToHeaders SendTaskHeartbeat

Defined in Amazonka.StepFunctions.SendTaskHeartbeat

Methods

toHeaders :: SendTaskHeartbeat -> [Header]

ToPath SendTaskHeartbeat

Defined in Amazonka.StepFunctions.SendTaskHeartbeat

Methods

toPath :: SendTaskHeartbeat -> ByteString

ToQuery SendTaskHeartbeat

Defined in Amazonka.StepFunctions.SendTaskHeartbeat

Methods

toQuery :: SendTaskHeartbeat -> QueryString

AWSRequest SendTaskHeartbeat

Defined in Amazonka.StepFunctions.SendTaskHeartbeat

Associated Types

type AWSResponse SendTaskHeartbeat

Methods

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

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

Generic SendTaskHeartbeat

Defined in Amazonka.StepFunctions.SendTaskHeartbeat

Associated Types

type Rep SendTaskHeartbeat :: Type -> Type

Methods

from :: SendTaskHeartbeat -> Rep SendTaskHeartbeat x

to :: Rep SendTaskHeartbeat x -> SendTaskHeartbeat

Read SendTaskHeartbeat

Defined in Amazonka.StepFunctions.SendTaskHeartbeat

Methods

readsPrec :: Int -> ReadS SendTaskHeartbeat

readList :: ReadS [SendTaskHeartbeat]

readPrec :: ReadPrec SendTaskHeartbeat

readListPrec :: ReadPrec [SendTaskHeartbeat]

Show SendTaskHeartbeat

Defined in Amazonka.StepFunctions.SendTaskHeartbeat

Methods

showsPrec :: Int -> SendTaskHeartbeat -> ShowS

show :: SendTaskHeartbeat -> String

showList :: [SendTaskHeartbeat] -> ShowS

NFData SendTaskHeartbeat

Defined in Amazonka.StepFunctions.SendTaskHeartbeat

Methods

rnf :: SendTaskHeartbeat -> ()

Eq SendTaskHeartbeat

Defined in Amazonka.StepFunctions.SendTaskHeartbeat

Methods

(==) :: SendTaskHeartbeat -> SendTaskHeartbeat -> Bool

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

Hashable SendTaskHeartbeat

Defined in Amazonka.StepFunctions.SendTaskHeartbeat

Methods

hashWithSalt :: Int -> SendTaskHeartbeat -> Int

hash :: SendTaskHeartbeat -> Int

type AWSResponse SendTaskHeartbeat

Defined in Amazonka.StepFunctions.SendTaskHeartbeat

type AWSResponse SendTaskHeartbeat = SendTaskHeartbeatResponse

type Rep SendTaskHeartbeat

Defined in Amazonka.StepFunctions.SendTaskHeartbeat

type Rep SendTaskHeartbeat = D1 ('MetaData "SendTaskHeartbeat" "Amazonka.StepFunctions.SendTaskHeartbeat" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "SendTaskHeartbeat'" 'PrefixI 'True) (S1 ('MetaSel ('Just "taskToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newSendTaskHeartbeat

Arguments

:: Text

$sel:taskToken:SendTaskHeartbeat'

-> SendTaskHeartbeat

Create a value of SendTaskHeartbeat 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:taskToken:SendTaskHeartbeat', sendTaskHeartbeat_taskToken - The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.

Request Lenses

sendTaskHeartbeat_taskToken :: Lens' SendTaskHeartbeat Text

The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.

Destructuring the Response

data SendTaskHeartbeatResponse

See: newSendTaskHeartbeatResponse smart constructor.

Constructors

SendTaskHeartbeatResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic SendTaskHeartbeatResponse

Defined in Amazonka.StepFunctions.SendTaskHeartbeat

Associated Types

type Rep SendTaskHeartbeatResponse :: Type -> Type

Methods

from :: SendTaskHeartbeatResponse -> Rep SendTaskHeartbeatResponse x

to :: Rep SendTaskHeartbeatResponse x -> SendTaskHeartbeatResponse

Read SendTaskHeartbeatResponse

Defined in Amazonka.StepFunctions.SendTaskHeartbeat

Methods

readsPrec :: Int -> ReadS SendTaskHeartbeatResponse

readList :: ReadS [SendTaskHeartbeatResponse]

readPrec :: ReadPrec SendTaskHeartbeatResponse

readListPrec :: ReadPrec [SendTaskHeartbeatResponse]

Show SendTaskHeartbeatResponse

Defined in Amazonka.StepFunctions.SendTaskHeartbeat

Methods

showsPrec :: Int -> SendTaskHeartbeatResponse -> ShowS

show :: SendTaskHeartbeatResponse -> String

showList :: [SendTaskHeartbeatResponse] -> ShowS

NFData SendTaskHeartbeatResponse

Defined in Amazonka.StepFunctions.SendTaskHeartbeat

Methods

rnf :: SendTaskHeartbeatResponse -> ()

Eq SendTaskHeartbeatResponse

Defined in Amazonka.StepFunctions.SendTaskHeartbeat

Methods

(==) :: SendTaskHeartbeatResponse -> SendTaskHeartbeatResponse -> Bool

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

type Rep SendTaskHeartbeatResponse

Defined in Amazonka.StepFunctions.SendTaskHeartbeat

type Rep SendTaskHeartbeatResponse = D1 ('MetaData "SendTaskHeartbeatResponse" "Amazonka.StepFunctions.SendTaskHeartbeat" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "SendTaskHeartbeatResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newSendTaskHeartbeatResponse

Arguments

:: Int

$sel:httpStatus:SendTaskHeartbeatResponse'

-> SendTaskHeartbeatResponse

Create a value of SendTaskHeartbeatResponse 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:httpStatus:SendTaskHeartbeatResponse', sendTaskHeartbeatResponse_httpStatus - The response's http status code.

Response Lenses

sendTaskHeartbeatResponse_httpStatus :: Lens' SendTaskHeartbeatResponse Int

The response's http status code.