get_durable_execution¶
Operation¶
async
¶
get_durable_execution(input: GetDurableExecutionInput, plugins: list[Plugin] | None = None) -> GetDurableExecutionOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetDurableExecutionInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetDurableExecutionOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for GetDurableExecutionInput structure.
Attributes¶
class-attribute
instance-attribute
¶
durable_execution_arn: str | None = None
The Amazon Resource Name (ARN) of the durable execution.
class-attribute
instance-attribute
¶
include_execution_data: bool = True
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.
Output¶
dataclass
¶
The response from the GetDurableExecution operation, containing detailed information about the durable execution.
Attributes¶
class-attribute
instance-attribute
¶
durable_config: DurableConfig | None = None
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.
instance-attribute
¶
durable_execution_arn: str
The Amazon Resource Name (ARN) of the durable execution.
instance-attribute
¶
durable_execution_name: str
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.
class-attribute
instance-attribute
¶
end_timestamp: datetime | None = None
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).
class-attribute
instance-attribute
¶
error: ErrorObject | None = None
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.
class-attribute
instance-attribute
¶
execution_data_included: bool | None = None
Indicates whether execution data is included in this response. Returns
false when IncludeExecutionData is set to false in the request.
instance-attribute
¶
function_arn: str
The Amazon Resource Name (ARN) of the Lambda function that was invoked to start this durable execution.
class-attribute
instance-attribute
¶
input_payload: str | None = field(repr=False, default=None)
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.
class-attribute
instance-attribute
¶
result: str | None = field(repr=False, default=None)
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.
instance-attribute
¶
start_timestamp: datetime
The date and time when the durable execution started, in Unix timestamp format.
instance-attribute
¶
status: ExecutionStatus
The current status of the durable execution. Valid values are RUNNING,
SUCCEEDED, FAILED, TIMED_OUT, and STOPPED.
class-attribute
instance-attribute
¶
trace_header: TraceHeader | None = None
The trace headers associated with the durable execution.
class-attribute
instance-attribute
¶
version: str | None = None
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.