Lambda / Client / get_durable_execution

get_durable_execution

Lambda.Client.get_durable_execution(**kwargs)

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

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

  • DurableExecutionArn (string) –

    [REQUIRED]

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

  • IncludeExecutionData (boolean) – 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.

Return type:

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',
    'EndTimestamp': datetime(2015, 1, 1),
    'Version': 'string',
    'TraceHeader': {
        'XAmznTraceId': 'string'
    },
    'ExecutionDataIncluded': True|False,
    'DurableConfig': {
        'KMSKeyArn': 'string',
        'RetentionPeriodInDays': 123,
        'ExecutionTimeout': 123
    }
}

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 was provided when the durable execution was started. For asynchronous invocations, this is limited to 256 KB. For synchronous invocations, this can be 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. The result is limited to 256 KB.

    • 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 256 KB.

      • 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 current status of the durable execution. Valid values are RUNNING, SUCCEEDED, FAILED, TIMED_OUT, and STOPPED.

    • 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.

Exceptions