SendDurableExecutionCallbackHeartbeat
Sends a heartbeat signal for a long-running callback operation to prevent timeout. Use this API to extend the callback timeout period while the external operation is still in progress.
Request Syntax
POST /2025-12-01/durable-execution-callbacks/CallbackId/heartbeat HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- CallbackId
-
The unique identifier for the callback operation.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[A-Za-z0-9+/]+={0,2}Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- CallbackTimeoutException
-
The callback ID token has either expired or the callback associated with the token has already been closed.
- Type
-
The exception type.
HTTP Status Code: 400
- InvalidParameterValueException
-
One of the parameters in the request is not valid.
- message
-
The exception message.
- Type
-
The exception type.
HTTP Status Code: 400
- ServiceException
-
The AWS Lambda service encountered an internal error.
HTTP Status Code: 500
- TooManyRequestsException
-
The request throughput limit was exceeded. For more information, see Lambda quotas.
- retryAfterSeconds
-
The number of seconds the caller should wait before retrying.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
