AmazonLambdaClient.CheckpointDurableExecutionAsync Method (CheckpointDurableExecutionRequest, CancellationToken)

Saves the progress of a durable function execution during runtime. This API is used by the Lambda durable functions SDK to checkpoint completed steps and schedule asynchronous operations. You typically don't need to call this API directly as the SDK handles checkpointing automatically.

Each checkpoint operation consumes the current checkpoint token and returns a new one for the next checkpoint. This ensures that checkpoints are applied in the correct order and prevents duplicate or out-of-order state updates.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.7.2 or higher.

Namespace: Amazon.Lambda
Assembly: AWSSDK.Lambda.dll
Version: 3.x.y.z

Syntax

public virtual Task<CheckpointDurableExecutionResponse> CheckpointDurableExecutionAsync(
         CheckpointDurableExecutionRequest request,
         CancellationToken cancellationToken
)

Parameters

request: Type: Amazon.Lambda.Model.CheckpointDurableExecutionRequest

Container for the necessary parameters to execute the CheckpointDurableExecution service method.

cancellationToken: Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value

Type: Task<CheckpointDurableExecutionResponse>

The response from the CheckpointDurableExecution service method, as returned by Lambda.

Exceptions

Exception	Condition
InvalidParameterValueException	One of the parameters in the request is not valid.
KMSAccessDeniedException	Lambda couldn't decrypt the environment variables because KMS access was denied. Check the Lambda function's KMS permissions.
KMSDisabledException	Lambda couldn't decrypt the environment variables because the KMS key used is disabled. Check the Lambda function's KMS key settings.
KMSInvalidStateException	Lambda couldn't decrypt the environment variables because the state of the KMS key used is not valid for Decrypt. Check the function's KMS key settings.
KMSNotFoundException	Lambda couldn't decrypt the environment variables because the KMS key was not found. Check the function's KMS key settings.
ServiceException	The Lambda service encountered an internal error.
TooManyRequestsException	The request throughput limit was exceeded. For more information, see Lambda quotas.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer

AmazonLambdaClient.CheckpointDurableExecutionAsync (CheckpointDurableExecutionRequest, CancellationToken)

Method

Syntax

Parameters

Return Value

Exceptions

Version Information

See Also