AWS Lambda

2026/11/17 - AWS Lambda - 3 new 3 updated api methods

Changes  AWS Lambda durable functions now supports pausing, resuming, and deleting durable executions with the new PauseDurableExecution, ResumeDurableExecution, and DeleteDurableExecution APIs.

ResumeDurableExecution (new) Link ¶

Resumes a paused durable execution. If the pause interrupted an invocation, or an operation completed while the execution was paused, Lambda invokes your function. Otherwise, the execution continues to wait for its pending operations.

If the execution status is PAUSING, this operation cancels the pause, and the in-progress invocation continues. This operation returns a successful response while the execution status is still PAUSED or PAUSING, and the status changes to RUNNING when Lambda processes the request. For more information about resuming executions, see Pausing and resuming durable executions.

See also: AWS API Documentation

Request Syntax

client.resume_durable_execution(
    DurableExecutionArn='string',
    ClientToken='string',
    Reason='string'
)
type DurableExecutionArn:

string

param DurableExecutionArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the durable execution.

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide so that the request completes no more than one time. If you repeat a request with the same client token and parameters within 15 minutes, Lambda doesn't resume the execution again and returns a successful response instead of an error.

This field is autopopulated if not provided.

type Reason:

string

param Reason:

A description of why you're resuming the execution. Lambda records the reason in the execution history.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

DeleteDurableExecution (new) Link ¶

Deletes a completed Lambda durable execution and its data. The execution must be in a terminal state ( SUCCEEDED, FAILED, STOPPED, or TIMED_OUT). Otherwise, this operation returns a ResourceConflictException.

The execution has DELETING status until the deletion finishes. For more information, see Deleting durable executions.

See also: AWS API Documentation

Request Syntax

client.delete_durable_execution(
    DurableExecutionArn='string'
)
type DurableExecutionArn:

string

param DurableExecutionArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the durable execution.

rtype:

dict

returns:

Response Syntax

{
    'DeletionRequestTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • DeletionRequestTimestamp (datetime) --

      The timestamp when Lambda accepted the deletion request (ISO 8601 format).

PauseDurableExecution (new) Link ¶

Pauses a running durable execution. While an execution is paused, Lambda doesn't invoke your function, but pending operations such as waits and callbacks continue to complete.

If an invocation is in progress, the execution status changes to PAUSING until the invocation reaches its next checkpoint, and then changes to PAUSED. This operation returns a successful response while the execution status is still RUNNING, and the status changes when Lambda processes the request. For more information about pausing executions, see Pausing and resuming durable executions.

See also: AWS API Documentation

Request Syntax

client.pause_durable_execution(
    DurableExecutionArn='string',
    ClientToken='string',
    Reason='string',
    ExecutionTimeoutPaused=True|False
)
type DurableExecutionArn:

string

param DurableExecutionArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the durable execution.

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide so that the request completes no more than one time. If you repeat a request with the same client token and parameters within 15 minutes, Lambda doesn't pause the execution again and returns a successful response instead of an error.

This field is autopopulated if not provided.

type Reason:

string

param Reason:

A description of why you're pausing the execution. Lambda records the reason in the execution history.

type ExecutionTimeoutPaused:

boolean

param ExecutionTimeoutPaused:

Specifies whether to pause the execution timeout while the execution is paused. If true, Lambda extends the execution timeout by the time the execution spends paused. An execution with a paused timeout still times out 366 days after it started. The default value is true.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

GetDurableExecution (updated) Link ¶
Changes (response)
{'ExpectedExecutionTimeoutTimestamp': 'timestamp',
 'PauseDetails': {'ExecutionTimeoutPaused': 'boolean',
                  'PauseRequestTimestamp': 'timestamp',
                  'Reason': 'string'},
 'Status': {'DELETING', 'PAUSING', 'PAUSED'}}

Retrieves detailed information about a specific durable execution, including its current status, input payload, result or error information, and execution metadata such as start time and usage statistics.

See also: AWS API Documentation

Request Syntax

client.get_durable_execution(
    DurableExecutionArn='string',
    IncludeExecutionData=True|False
)
type DurableExecutionArn:

string

param DurableExecutionArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the durable execution.

type IncludeExecutionData:

boolean

param IncludeExecutionData:

Specifies whether to include execution data such as input payload, result, and error information in the response. Set to false for a more compact response that includes only execution metadata. The default value is set to true.

rtype:

dict

returns:

Response Syntax

{
    'DurableExecutionArn': 'string',
    'DurableExecutionName': 'string',
    'FunctionArn': 'string',
    'InputPayload': 'string',
    'Result': 'string',
    'Error': {
        'ErrorMessage': 'string',
        'ErrorType': 'string',
        'ErrorData': 'string',
        'StackTrace': [
            'string',
        ]
    },
    'StartTimestamp': datetime(2015, 1, 1),
    'Status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'STOPPED'|'DELETING'|'PAUSING'|'PAUSED',
    'EndTimestamp': datetime(2015, 1, 1),
    'Version': 'string',
    'TraceHeader': {
        'XAmznTraceId': 'string'
    },
    'ExecutionDataIncluded': True|False,
    'DurableConfig': {
        'KMSKeyArn': 'string',
        'RetentionPeriodInDays': 123,
        'ExecutionTimeout': 123
    },
    'PauseDetails': {
        'PauseRequestTimestamp': datetime(2015, 1, 1),
        'Reason': 'string',
        'ExecutionTimeoutPaused': True|False
    },
    'ExpectedExecutionTimeoutTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    The response from the GetDurableExecution operation, containing detailed information about the durable execution.

    • DurableExecutionArn (string) --

      The Amazon Resource Name (ARN) of the durable execution.

    • DurableExecutionName (string) --

      The name of the durable execution. This is either the name you provided when invoking the function, or a system-generated unique identifier if no name was provided.

    • FunctionArn (string) --

      The Amazon Resource Name (ARN) of the Lambda function that was invoked to start this durable execution.

    • InputPayload (string) --

      The JSON input payload that you provided when you started the durable execution. Asynchronous invocations support up to 1 MB, and synchronous invocations support up to 6 MB.

    • Result (string) --

      The JSON result returned by the durable execution if it completed successfully. This field is only present when the execution status is SUCCEEDED. Asynchronous invocations support up to 1 MB, and synchronous invocations support up to 6 MB.

    • Error (dict) --

      Error information if the durable execution failed. This field is only present when the execution status is FAILED, TIMED_OUT, or STOPPED. The combined size of all error fields is limited to 1 MB.

      • ErrorMessage (string) --

        A human-readable error message.

      • ErrorType (string) --

        The error type.

      • ErrorData (string) --

        Machine-readable error data.

      • StackTrace (list) --

        Stack trace information for the error.

        • (string) --

    • StartTimestamp (datetime) --

      The date and time when the durable execution started, in Unix timestamp format.

    • Status (string) --

      The durable execution has one of the following statuses:

      • RUNNING – The execution is running or waiting for pending operations to complete.

      • PAUSING – The execution is waiting for an in-progress invocation to reach its next checkpoint before it pauses.

      • PAUSED – The execution is paused, and Lambda doesn't invoke your function.

      • SUCCEEDED – The execution completed successfully.

      • FAILED – The execution completed with an error.

      • TIMED_OUT – The execution exceeded its execution timeout.

      • STOPPED – A StopDurableExecution request stopped the execution.

      • DELETING – A DeleteDurableExecution request is deleting the execution and its data.

    • EndTimestamp (datetime) --

      The date and time when the durable execution ended, in Unix timestamp format. This field is only present if the execution has completed (status is SUCCEEDED, FAILED, TIMED_OUT, or STOPPED).

    • Version (string) --

      The version of the Lambda function that was invoked for this durable execution. This ensures that all replays during the execution use the same function version.

    • TraceHeader (dict) --

      The trace headers associated with the durable execution.

      • XAmznTraceId (string) --

        The X-Ray trace header associated with the durable execution.

    • ExecutionDataIncluded (boolean) --

      Indicates whether execution data is included in this response. Returns false when IncludeExecutionData is set to false in the request.

    • DurableConfig (dict) --

      Configuration settings for the durable execution, including execution timeout, retention period for execution history, and an optional ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads.

      • KMSKeyArn (string) --

        The ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads.

      • RetentionPeriodInDays (integer) --

        The number of days to retain execution history after a durable execution completes. After this period, execution history is no longer available through the GetDurableExecutionHistory API.

      • ExecutionTimeout (integer) --

        The maximum time (in seconds) that a durable execution can run before timing out. This timeout applies to the entire durable execution, not individual function invocations.

    • PauseDetails (dict) --

      The details of the pause, including when you requested it and whether it pauses the execution timeout. This field is only present when the execution status is PAUSING or PAUSED.

      • PauseRequestTimestamp (datetime) --

        The date and time when you requested the pause, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

      • Reason (string) --

        The reason that you provided when you paused the execution. This field is only present if you set IncludeExecutionData to true in the request.

      • ExecutionTimeoutPaused (boolean) --

        Specifies whether the pause also pauses the execution timeout.

    • ExpectedExecutionTimeoutTimestamp (datetime) --

      The date and time when the durable execution will time out, in Unix timestamp format. This value includes any extension from time the execution spent paused. While the execution is paused with its execution timeout paused, this value is 366 days after the start time. This field isn't present for completed executions.

GetDurableExecutionHistory (updated) Link ¶
Changes (response)
{'Events': {'EventType': {'ExecutionResumed', 'ExecutionPaused'},
            'ExecutionPausedDetails': {'ExecutionTimeoutPaused': 'boolean',
                                       'PauseRequestTimestamp': 'timestamp',
                                       'Reason': {'Payload': 'string',
                                                  'Truncated': 'boolean'}},
            'ExecutionResumedDetails': {'Reason': {'Payload': 'string',
                                                   'Truncated': 'boolean'},
                                        'ResumeRequestTimestamp': 'timestamp'}}}

Retrieves the execution history for a durable execution, showing all the steps, callbacks, and events that occurred during the execution. This provides a detailed audit trail of the execution's progress over time.

The history is available while the execution is running and for a retention period after it completes (1-90 days, default 30 days). You can control whether to include execution data such as step results and callback payloads.

See also: AWS API Documentation

Request Syntax

client.get_durable_execution_history(
    DurableExecutionArn='string',
    IncludeExecutionData=True|False,
    MaxItems=123,
    Marker='string',
    ReverseOrder=True|False
)
type DurableExecutionArn:

string

param DurableExecutionArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the durable execution.

type IncludeExecutionData:

boolean

param IncludeExecutionData:

Specifies whether to include execution data such as step results and callback payloads in the history events. Set to true to include data, or false to exclude it for a more compact response. The default is true.

type MaxItems:

integer

param MaxItems:

The maximum number of history events to return per call. You can use Marker to retrieve additional pages of results. The default is 100 and the maximum allowed is 1000. A value of 0 uses the default.

type Marker:

string

param Marker:

If NextMarker was returned from a previous request, use this value to retrieve the next page of results. Each pagination token expires after 24 hours.

type ReverseOrder:

boolean

param ReverseOrder:

When set to true, returns the history events in reverse chronological order (newest first). By default, events are returned in chronological order (oldest first).

rtype:

dict

returns:

Response Syntax

{
    'Events': [
        {
            'EventType': 'ExecutionStarted'|'ExecutionSucceeded'|'ExecutionFailed'|'ExecutionTimedOut'|'ExecutionStopped'|'ContextStarted'|'ContextSucceeded'|'ContextFailed'|'WaitStarted'|'WaitSucceeded'|'WaitCancelled'|'StepStarted'|'StepSucceeded'|'StepFailed'|'ChainedInvokeStarted'|'ChainedInvokeSucceeded'|'ChainedInvokeFailed'|'ChainedInvokeTimedOut'|'ChainedInvokeStopped'|'CallbackStarted'|'CallbackSucceeded'|'CallbackFailed'|'CallbackTimedOut'|'InvocationCompleted'|'ExecutionPaused'|'ExecutionResumed',
            'SubType': 'string',
            'EventId': 123,
            'Id': 'string',
            'Name': 'string',
            'EventTimestamp': datetime(2015, 1, 1),
            'ParentId': 'string',
            'ExecutionStartedDetails': {
                'Input': {
                    'Payload': 'string',
                    'Truncated': True|False
                },
                'ExecutionTimeout': 123
            },
            'ExecutionSucceededDetails': {
                'Result': {
                    'Payload': 'string',
                    'Truncated': True|False
                }
            },
            'ExecutionFailedDetails': {
                'Error': {
                    'Payload': {
                        'ErrorMessage': 'string',
                        'ErrorType': 'string',
                        'ErrorData': 'string',
                        'StackTrace': [
                            'string',
                        ]
                    },
                    'Truncated': True|False
                }
            },
            'ExecutionTimedOutDetails': {
                'Error': {
                    'Payload': {
                        'ErrorMessage': 'string',
                        'ErrorType': 'string',
                        'ErrorData': 'string',
                        'StackTrace': [
                            'string',
                        ]
                    },
                    'Truncated': True|False
                }
            },
            'ExecutionStoppedDetails': {
                'Error': {
                    'Payload': {
                        'ErrorMessage': 'string',
                        'ErrorType': 'string',
                        'ErrorData': 'string',
                        'StackTrace': [
                            'string',
                        ]
                    },
                    'Truncated': True|False
                }
            },
            'ContextStartedDetails': {},
            'ContextSucceededDetails': {
                'Result': {
                    'Payload': 'string',
                    'Truncated': True|False
                }
            },
            'ContextFailedDetails': {
                'Error': {
                    'Payload': {
                        'ErrorMessage': 'string',
                        'ErrorType': 'string',
                        'ErrorData': 'string',
                        'StackTrace': [
                            'string',
                        ]
                    },
                    'Truncated': True|False
                }
            },
            'WaitStartedDetails': {
                'Duration': 123,
                'ScheduledEndTimestamp': datetime(2015, 1, 1)
            },
            'WaitSucceededDetails': {
                'Duration': 123
            },
            'WaitCancelledDetails': {
                'Error': {
                    'Payload': {
                        'ErrorMessage': 'string',
                        'ErrorType': 'string',
                        'ErrorData': 'string',
                        'StackTrace': [
                            'string',
                        ]
                    },
                    'Truncated': True|False
                }
            },
            'StepStartedDetails': {},
            'StepSucceededDetails': {
                'Result': {
                    'Payload': 'string',
                    'Truncated': True|False
                },
                'RetryDetails': {
                    'CurrentAttempt': 123,
                    'NextAttemptDelaySeconds': 123
                }
            },
            'StepFailedDetails': {
                'Error': {
                    'Payload': {
                        'ErrorMessage': 'string',
                        'ErrorType': 'string',
                        'ErrorData': 'string',
                        'StackTrace': [
                            'string',
                        ]
                    },
                    'Truncated': True|False
                },
                'RetryDetails': {
                    'CurrentAttempt': 123,
                    'NextAttemptDelaySeconds': 123
                }
            },
            'ChainedInvokeStartedDetails': {
                'FunctionName': 'string',
                'TenantId': 'string',
                'Input': {
                    'Payload': 'string',
                    'Truncated': True|False
                },
                'ExecutedVersion': 'string',
                'DurableExecutionArn': 'string'
            },
            'ChainedInvokeSucceededDetails': {
                'Result': {
                    'Payload': 'string',
                    'Truncated': True|False
                }
            },
            'ChainedInvokeFailedDetails': {
                'Error': {
                    'Payload': {
                        'ErrorMessage': 'string',
                        'ErrorType': 'string',
                        'ErrorData': 'string',
                        'StackTrace': [
                            'string',
                        ]
                    },
                    'Truncated': True|False
                }
            },
            'ChainedInvokeTimedOutDetails': {
                'Error': {
                    'Payload': {
                        'ErrorMessage': 'string',
                        'ErrorType': 'string',
                        'ErrorData': 'string',
                        'StackTrace': [
                            'string',
                        ]
                    },
                    'Truncated': True|False
                }
            },
            'ChainedInvokeStoppedDetails': {
                'Error': {
                    'Payload': {
                        'ErrorMessage': 'string',
                        'ErrorType': 'string',
                        'ErrorData': 'string',
                        'StackTrace': [
                            'string',
                        ]
                    },
                    'Truncated': True|False
                }
            },
            'CallbackStartedDetails': {
                'CallbackId': 'string',
                'HeartbeatTimeout': 123,
                'Timeout': 123
            },
            'CallbackSucceededDetails': {
                'Result': {
                    'Payload': 'string',
                    'Truncated': True|False
                }
            },
            'CallbackFailedDetails': {
                'Error': {
                    'Payload': {
                        'ErrorMessage': 'string',
                        'ErrorType': 'string',
                        'ErrorData': 'string',
                        'StackTrace': [
                            'string',
                        ]
                    },
                    'Truncated': True|False
                }
            },
            'CallbackTimedOutDetails': {
                'Error': {
                    'Payload': {
                        'ErrorMessage': 'string',
                        'ErrorType': 'string',
                        'ErrorData': 'string',
                        'StackTrace': [
                            'string',
                        ]
                    },
                    'Truncated': True|False
                }
            },
            'InvocationCompletedDetails': {
                'StartTimestamp': datetime(2015, 1, 1),
                'EndTimestamp': datetime(2015, 1, 1),
                'RequestId': 'string',
                'Error': {
                    'Payload': {
                        'ErrorMessage': 'string',
                        'ErrorType': 'string',
                        'ErrorData': 'string',
                        'StackTrace': [
                            'string',
                        ]
                    },
                    'Truncated': True|False
                }
            },
            'ExecutionPausedDetails': {
                'PauseRequestTimestamp': datetime(2015, 1, 1),
                'Reason': {
                    'Payload': 'string',
                    'Truncated': True|False
                },
                'ExecutionTimeoutPaused': True|False
            },
            'ExecutionResumedDetails': {
                'ResumeRequestTimestamp': datetime(2015, 1, 1),
                'Reason': {
                    'Payload': 'string',
                    'Truncated': True|False
                }
            }
        },
    ],
    'NextMarker': 'string'
}

Response Structure

  • (dict) --

    The response from the GetDurableExecutionHistory operation, containing the execution history and events.

    • Events (list) --

      An array of execution history events, ordered chronologically unless ReverseOrder is set to true. Each event represents a significant occurrence during the execution, such as step completion or callback resolution.

      • (dict) --

        An event that occurred during the execution of a durable function.

        • EventType (string) --

          The type of event that occurred.

        • SubType (string) --

          The subtype of the event, providing additional categorization.

        • EventId (integer) --

          The unique identifier for this event. Event IDs increment sequentially.

        • Id (string) --

          The unique identifier for this operation.

        • Name (string) --

          The customer-provided name for this operation.

        • EventTimestamp (datetime) --

          The date and time when this event occurred, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

        • ParentId (string) --

          The unique identifier of the parent operation, if this operation is running within a child context.

        • ExecutionStartedDetails (dict) --

          Details about an execution that started.

          • Input (dict) --

            The input payload provided for the durable execution.

            • Payload (string) --

              The input payload.

            • Truncated (boolean) --

              Indicates if the error payload was truncated due to size limits.

          • ExecutionTimeout (integer) --

            The maximum amount of time that the durable execution is allowed to run, in seconds.

        • ExecutionSucceededDetails (dict) --

          Details about an execution that succeeded.

          • Result (dict) --

            The response payload from the successful operation.

            • Payload (string) --

              The result payload.

            • Truncated (boolean) --

              Indicates if the error payload was truncated due to size limits.

        • ExecutionFailedDetails (dict) --

          Details about an execution that failed.

          • Error (dict) --

            Details about the execution failure.

            • Payload (dict) --

              The error payload.

              • ErrorMessage (string) --

                A human-readable error message.

              • ErrorType (string) --

                The error type.

              • ErrorData (string) --

                Machine-readable error data.

              • StackTrace (list) --

                Stack trace information for the error.

                • (string) --

            • Truncated (boolean) --

              Indicates if the error payload was truncated due to size limits.

        • ExecutionTimedOutDetails (dict) --

          Details about an execution that timed out.

          • Error (dict) --

            Details about the execution timeout.

            • Payload (dict) --

              The error payload.

              • ErrorMessage (string) --

                A human-readable error message.

              • ErrorType (string) --

                The error type.

              • ErrorData (string) --

                Machine-readable error data.

              • StackTrace (list) --

                Stack trace information for the error.

                • (string) --

            • Truncated (boolean) --

              Indicates if the error payload was truncated due to size limits.

        • ExecutionStoppedDetails (dict) --

          Details about an execution that was stopped.

          • Error (dict) --

            Details about why the execution stopped.

            • Payload (dict) --

              The error payload.

              • ErrorMessage (string) --

                A human-readable error message.

              • ErrorType (string) --

                The error type.

              • ErrorData (string) --

                Machine-readable error data.

              • StackTrace (list) --

                Stack trace information for the error.

                • (string) --

            • Truncated (boolean) --

              Indicates if the error payload was truncated due to size limits.

        • ContextStartedDetails (dict) --

          Details about a context that started.

        • ContextSucceededDetails (dict) --

          Details about a context that succeeded.

          • Result (dict) --

            The JSON response payload from the successful context.

            • Payload (string) --

              The result payload.

            • Truncated (boolean) --

              Indicates if the error payload was truncated due to size limits.

        • ContextFailedDetails (dict) --

          Details about a context that failed.

          • Error (dict) --

            Details about the context failure.

            • Payload (dict) --

              The error payload.

              • ErrorMessage (string) --

                A human-readable error message.

              • ErrorType (string) --

                The error type.

              • ErrorData (string) --

                Machine-readable error data.

              • StackTrace (list) --

                Stack trace information for the error.

                • (string) --

            • Truncated (boolean) --

              Indicates if the error payload was truncated due to size limits.

        • WaitStartedDetails (dict) --

          Details about a wait operation that started.

          • Duration (integer) --

            The duration to wait, in seconds.

          • ScheduledEndTimestamp (datetime) --

            The date and time when the wait operation is scheduled to complete, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

        • WaitSucceededDetails (dict) --

          Details about a wait operation that succeeded.

          • Duration (integer) --

            The wait duration, in seconds.

        • WaitCancelledDetails (dict) --

          Details about a wait operation that was cancelled.

          • Error (dict) --

            Details about why the wait operation was cancelled.

            • Payload (dict) --

              The error payload.

              • ErrorMessage (string) --

                A human-readable error message.

              • ErrorType (string) --

                The error type.

              • ErrorData (string) --

                Machine-readable error data.

              • StackTrace (list) --

                Stack trace information for the error.

                • (string) --

            • Truncated (boolean) --

              Indicates if the error payload was truncated due to size limits.

        • StepStartedDetails (dict) --

          Details about a step that started.

        • StepSucceededDetails (dict) --

          Details about a step that succeeded.

          • Result (dict) --

            The response payload from the successful operation.

            • Payload (string) --

              The result payload.

            • Truncated (boolean) --

              Indicates if the error payload was truncated due to size limits.

          • RetryDetails (dict) --

            Information about retry attempts for this step operation.

            • CurrentAttempt (integer) --

              The current attempt number for this operation.

            • NextAttemptDelaySeconds (integer) --

              The delay before the next retry attempt, in seconds.

        • StepFailedDetails (dict) --

          Details about a step that failed.

          • Error (dict) --

            Details about the step failure.

            • Payload (dict) --

              The error payload.

              • ErrorMessage (string) --

                A human-readable error message.

              • ErrorType (string) --

                The error type.

              • ErrorData (string) --

                Machine-readable error data.

              • StackTrace (list) --

                Stack trace information for the error.

                • (string) --

            • Truncated (boolean) --

              Indicates if the error payload was truncated due to size limits.

          • RetryDetails (dict) --

            Information about retry attempts for this step operation.

            • CurrentAttempt (integer) --

              The current attempt number for this operation.

            • NextAttemptDelaySeconds (integer) --

              The delay before the next retry attempt, in seconds.

        • ChainedInvokeStartedDetails (dict) --

          Contains details about a chained function invocation that has started execution, including start time and execution context.

          • FunctionName (string) --

            The name or ARN of the Lambda function being invoked.

          • TenantId (string) --

            The tenant identifier for the chained invocation.

          • Input (dict) --

            The JSON input payload provided to the chained invocation.

            • Payload (string) --

              The input payload.

            • Truncated (boolean) --

              Indicates if the error payload was truncated due to size limits.

          • ExecutedVersion (string) --

            The version of the function that was executed.

          • DurableExecutionArn (string) --

            The Amazon Resource Name (ARN) that identifies the durable execution.

        • ChainedInvokeSucceededDetails (dict) --

          Details about a chained invocation that succeeded.

          • Result (dict) --

            The response payload from the successful operation.

            • Payload (string) --

              The result payload.

            • Truncated (boolean) --

              Indicates if the error payload was truncated due to size limits.

        • ChainedInvokeFailedDetails (dict) --

          Contains details about a failed chained function invocation, including error information and failure reason.

          • Error (dict) --

            Details about the chained invocation failure.

            • Payload (dict) --

              The error payload.

              • ErrorMessage (string) --

                A human-readable error message.

              • ErrorType (string) --

                The error type.

              • ErrorData (string) --

                Machine-readable error data.

              • StackTrace (list) --

                Stack trace information for the error.

                • (string) --

            • Truncated (boolean) --

              Indicates if the error payload was truncated due to size limits.

        • ChainedInvokeTimedOutDetails (dict) --

          Details about a chained invocation that timed out.

          • Error (dict) --

            Details about the chained invocation timeout.

            • Payload (dict) --

              The error payload.

              • ErrorMessage (string) --

                A human-readable error message.

              • ErrorType (string) --

                The error type.

              • ErrorData (string) --

                Machine-readable error data.

              • StackTrace (list) --

                Stack trace information for the error.

                • (string) --

            • Truncated (boolean) --

              Indicates if the error payload was truncated due to size limits.

        • ChainedInvokeStoppedDetails (dict) --

          Details about a chained invocation that was stopped.

          • Error (dict) --

            Details about why the chained invocation stopped.

            • Payload (dict) --

              The error payload.

              • ErrorMessage (string) --

                A human-readable error message.

              • ErrorType (string) --

                The error type.

              • ErrorData (string) --

                Machine-readable error data.

              • StackTrace (list) --

                Stack trace information for the error.

                • (string) --

            • Truncated (boolean) --

              Indicates if the error payload was truncated due to size limits.

        • CallbackStartedDetails (dict) --

          Contains details about a callback operation that has started, including timing information and callback metadata.

          • CallbackId (string) --

            The callback ID. Callback IDs are generated by the DurableContext when a durable function calls ctx.waitForCallback.

          • HeartbeatTimeout (integer) --

            The heartbeat timeout value, in seconds.

          • Timeout (integer) --

            The timeout value, in seconds.

        • CallbackSucceededDetails (dict) --

          Contains details about a successfully completed callback operation, including the result data and completion timestamp.

          • Result (dict) --

            The response payload from the successful operation.

            • Payload (string) --

              The result payload.

            • Truncated (boolean) --

              Indicates if the error payload was truncated due to size limits.

        • CallbackFailedDetails (dict) --

          Contains details about a failed callback operation, including error information and the reason for failure.

          • Error (dict) --

            An error object that contains details about the failure.

            • Payload (dict) --

              The error payload.

              • ErrorMessage (string) --

                A human-readable error message.

              • ErrorType (string) --

                The error type.

              • ErrorData (string) --

                Machine-readable error data.

              • StackTrace (list) --

                Stack trace information for the error.

                • (string) --

            • Truncated (boolean) --

              Indicates if the error payload was truncated due to size limits.

        • CallbackTimedOutDetails (dict) --

          Contains details about a callback operation that timed out, including timeout duration and any partial results.

          • Error (dict) --

            Details about the callback timeout.

            • Payload (dict) --

              The error payload.

              • ErrorMessage (string) --

                A human-readable error message.

              • ErrorType (string) --

                The error type.

              • ErrorData (string) --

                Machine-readable error data.

              • StackTrace (list) --

                Stack trace information for the error.

                • (string) --

            • Truncated (boolean) --

              Indicates if the error payload was truncated due to size limits.

        • InvocationCompletedDetails (dict) --

          Details about a function invocation that completed.

          • StartTimestamp (datetime) --

            The date and time when the invocation started, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

          • EndTimestamp (datetime) --

            The date and time when the invocation ended, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

          • RequestId (string) --

            The request ID for the invocation.

          • Error (dict) --

            Details about the invocation failure.

            • Payload (dict) --

              The error payload.

              • ErrorMessage (string) --

                A human-readable error message.

              • ErrorType (string) --

                The error type.

              • ErrorData (string) --

                Machine-readable error data.

              • StackTrace (list) --

                Stack trace information for the error.

                • (string) --

            • Truncated (boolean) --

              Indicates if the error payload was truncated due to size limits.

        • ExecutionPausedDetails (dict) --

          The details of an ExecutionPaused event.

          • PauseRequestTimestamp (datetime) --

            The date and time when you requested the pause, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

          • Reason (dict) --

            The reason that you provided when you paused the execution.

            • Payload (string) --

              The reason that you provided when you paused the execution. This field is only present if you set IncludeExecutionData to true in the request.

            • Truncated (boolean) --

              Specifies whether Lambda omitted the reason from the response because IncludeExecutionData is false.

          • ExecutionTimeoutPaused (boolean) --

            Specifies whether the pause also paused the execution timeout.

        • ExecutionResumedDetails (dict) --

          The details of an ExecutionResumed event.

          • ResumeRequestTimestamp (datetime) --

            The date and time when you requested the resume, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

          • Reason (dict) --

            The reason that you provided when you resumed the execution.

            • Payload (string) --

              The reason that you provided when you resumed the execution. This field is only present if you set IncludeExecutionData to true in the request.

            • Truncated (boolean) --

              Specifies whether Lambda omitted the reason from the response because IncludeExecutionData is false.

    • NextMarker (string) --

      If present, indicates that more history events are available. Use this value as the Marker parameter in a subsequent request to retrieve the next page of results.

ListDurableExecutionsByFunction (updated) Link ¶
Changes (request, response)
Request
{'Statuses': {'DELETING', 'PAUSING', 'PAUSED'}}
Response
{'DurableExecutions': {'Status': {'DELETING', 'PAUSING', 'PAUSED'}}}

Returns a list of durable executions for a specified Lambda function. You can filter the results by execution name, status, and start time range. This API supports pagination for large result sets.

See also: AWS API Documentation

Request Syntax

client.list_durable_executions_by_function(
    FunctionName='string',
    Qualifier='string',
    DurableExecutionName='string',
    Statuses=[
        'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'STOPPED'|'DELETING'|'PAUSING'|'PAUSED',
    ],
    StartedAfter=datetime(2015, 1, 1),
    StartedBefore=datetime(2015, 1, 1),
    ReverseOrder=True|False,
    Marker='string',
    MaxItems=123
)
type FunctionName:

string

param FunctionName:

[REQUIRED]

The name or ARN of the Lambda function. You can specify a function name, a partial ARN, or a full ARN.

type Qualifier:

string

param Qualifier:

The function version to filter executions by. If you don't specify a qualifier, this operation returns executions across all versions of the Lambda function.

type DurableExecutionName:

string

param DurableExecutionName:

Filter executions by name. Only executions with names that matches this string are returned.

type Statuses:

list

param Statuses:

Filters the executions by status. Specify one of the following values:

  • RUNNING – The execution is running or waiting for pending operations to complete.

  • PAUSING – The execution is waiting for an in-progress invocation to reach its next checkpoint before it pauses.

  • PAUSED – The execution is paused, and Lambda doesn't invoke your function.

  • SUCCEEDED – The execution completed successfully.

  • FAILED – The execution completed with an error.

  • TIMED_OUT – The execution exceeded its execution timeout.

  • STOPPED – A StopDurableExecution request stopped the execution.

  • DELETING – A DeleteDurableExecution request is deleting the execution and its data.

  • (string) --

type StartedAfter:

datetime

param StartedAfter:

Filter executions that started after this timestamp (ISO 8601 format).

type StartedBefore:

datetime

param StartedBefore:

Filter executions that started before this timestamp (ISO 8601 format).

type ReverseOrder:

boolean

param ReverseOrder:

Set to true to return results in chronological order (oldest first). Default is false.

type Marker:

string

param Marker:

Pagination token from a previous request to continue retrieving results.

type MaxItems:

integer

param MaxItems:

Maximum number of executions to return (1-1000). Default is 100.

rtype:

dict

returns:

Response Syntax

{
    'DurableExecutions': [
        {
            'DurableExecutionArn': 'string',
            'DurableExecutionName': 'string',
            'FunctionArn': 'string',
            'Status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'STOPPED'|'DELETING'|'PAUSING'|'PAUSED',
            'StartTimestamp': datetime(2015, 1, 1),
            'EndTimestamp': datetime(2015, 1, 1),
            'KMSKeyArn': 'string'
        },
    ],
    'NextMarker': 'string'
}

Response Structure

  • (dict) --

    The response from the ListDurableExecutionsByFunction operation, containing a list of durable executions and pagination information.

    • DurableExecutions (list) --

      List of durable execution summaries matching the filter criteria.

      • (dict) --

        Information about a durable execution.

        • DurableExecutionArn (string) --

          The Amazon Resource Name (ARN) of the durable execution, if this execution is a durable execution.

        • DurableExecutionName (string) --

          The unique name of the durable execution, if one was provided when the execution was started.

        • FunctionArn (string) --

          The Amazon Resource Name (ARN) of the Lambda function.

        • Status (string) --

          The current status of the durable execution.

        • StartTimestamp (datetime) --

          The date and time when the durable execution started, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

        • EndTimestamp (datetime) --

          The date and time when the durable execution ended, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

        • KMSKeyArn (string) --

          The ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads.

    • NextMarker (string) --

      Pagination token for retrieving additional results. Present only if there are more results available.