AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCheckpointDurableExecution and EndCheckpointDurableExecution.

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

Syntax

C#
public abstract 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


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

Exceptions

ExceptionCondition
InvalidParameterValueException One of the parameters in the request is not valid.
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.5 and newer

See Also