aws_sdk_lambda/client/

checkpoint_durable_execution.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CheckpointDurableExecution`](crate::operation::checkpoint_durable_execution::builders::CheckpointDurableExecutionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`durable_execution_arn(impl Into<String>)`](crate::operation::checkpoint_durable_execution::builders::CheckpointDurableExecutionFluentBuilder::durable_execution_arn) / [`set_durable_execution_arn(Option<String>)`](crate::operation::checkpoint_durable_execution::builders::CheckpointDurableExecutionFluentBuilder::set_durable_execution_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the durable execution.</p><br>
    ///   - [`checkpoint_token(impl Into<String>)`](crate::operation::checkpoint_durable_execution::builders::CheckpointDurableExecutionFluentBuilder::checkpoint_token) / [`set_checkpoint_token(Option<String>)`](crate::operation::checkpoint_durable_execution::builders::CheckpointDurableExecutionFluentBuilder::set_checkpoint_token):<br>required: **true**<br><p>A unique token that identifies the current checkpoint state. This token is provided by the Lambda runtime and must be used to ensure checkpoints are applied in the correct order. Each checkpoint operation consumes this token and returns a new one.</p><br>
    ///   - [`updates(OperationUpdate)`](crate::operation::checkpoint_durable_execution::builders::CheckpointDurableExecutionFluentBuilder::updates) / [`set_updates(Option<Vec::<OperationUpdate>>)`](crate::operation::checkpoint_durable_execution::builders::CheckpointDurableExecutionFluentBuilder::set_updates):<br>required: **false**<br><p>An array of state updates to apply during this checkpoint. Each update represents a change to the execution state, such as completing a step, starting a callback, or scheduling a timer. Updates are applied atomically as part of the checkpoint operation.</p><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::checkpoint_durable_execution::builders::CheckpointDurableExecutionFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::checkpoint_durable_execution::builders::CheckpointDurableExecutionFluentBuilder::set_client_token):<br>required: **false**<br><p>An optional idempotency token to ensure that duplicate checkpoint requests are handled correctly. If provided, Lambda uses this token to detect and handle duplicate requests within a 15-minute window.</p><br>
    /// - On success, responds with [`CheckpointDurableExecutionOutput`](crate::operation::checkpoint_durable_execution::CheckpointDurableExecutionOutput) with field(s):
    ///   - [`checkpoint_token(Option<String>)`](crate::operation::checkpoint_durable_execution::CheckpointDurableExecutionOutput::checkpoint_token): <p>A new checkpoint token to use for the next checkpoint operation. This token replaces the one provided in the request and must be used for subsequent checkpoints to maintain proper ordering.</p>
    ///   - [`new_execution_state(Option<CheckpointUpdatedExecutionState>)`](crate::operation::checkpoint_durable_execution::CheckpointDurableExecutionOutput::new_execution_state): <p>Updated execution state information that includes any changes that occurred since the last checkpoint, such as completed callbacks or expired timers. This allows the SDK to update its internal state during replay.</p>
    /// - On failure, responds with [`SdkError<CheckpointDurableExecutionError>`](crate::operation::checkpoint_durable_execution::CheckpointDurableExecutionError)
    pub fn checkpoint_durable_execution(&self) -> crate::operation::checkpoint_durable_execution::builders::CheckpointDurableExecutionFluentBuilder {
        crate::operation::checkpoint_durable_execution::builders::CheckpointDurableExecutionFluentBuilder::new(self.handle.clone())
    }
}