get_durable_execution¶
Operation¶
get_durable_execution
¶
get_durable_execution(request: GetDurableExecutionInput | GetDurableExecutionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDurableExecutionInputDict]) -> 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 |
|---|---|---|---|
request
|
GetDurableExecutionInput | GetDurableExecutionInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetDurableExecutionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetDurableExecutionOutput
|
An instance of |
get_durable_execution
async
¶
get_durable_execution(request: GetDurableExecutionInput | GetDurableExecutionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDurableExecutionInputDict]) -> 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 |
|---|---|---|---|
request
|
GetDurableExecutionInput | GetDurableExecutionInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetDurableExecutionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetDurableExecutionOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetDurableExecutionInputDict
¶
Bases: TypedDict
Dictionary form of GetDurableExecutionInput.
Attributes¶
durable_execution_arn
instance-attribute
¶
The Amazon Resource Name (ARN) of the durable execution.
include_execution_data
instance-attribute
¶
include_execution_data: bool | None
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.
GetDurableExecutionInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetDurableExecutionInput structure.
Attributes¶
durable_execution_arn
class-attribute
instance-attribute
¶
durable_execution_arn: str | None = ...
The Amazon Resource Name (ARN) of the durable execution.
include_execution_data
class-attribute
instance-attribute
¶
include_execution_data: bool = ...
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¶
GetDurableExecutionOutput
dataclass
¶
Bases: _SerdeShape
The response from the GetDurableExecution operation, containing detailed information about the durable execution.
Attributes¶
durable_config
class-attribute
instance-attribute
¶
durable_config: DurableConfig | 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.
durable_execution_arn
instance-attribute
¶
durable_execution_arn: str
The Amazon Resource Name (ARN) of the durable execution.
durable_execution_name
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.
end_timestamp
class-attribute
instance-attribute
¶
end_timestamp: datetime | 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).
error
class-attribute
instance-attribute
¶
error: ErrorObject | 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 1 MB.
execution_data_included
class-attribute
instance-attribute
¶
execution_data_included: bool | None = ...
Indicates whether execution data is included in this response. Returns
false when IncludeExecutionData is set to false in the request.
function_arn
instance-attribute
¶
function_arn: str
The Amazon Resource Name (ARN) of the Lambda function that was invoked to start this durable execution.
input_payload
class-attribute
instance-attribute
¶
input_payload: str | None = ...
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.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
result
class-attribute
instance-attribute
¶
result: str | None = ...
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.
start_timestamp
instance-attribute
¶
start_timestamp: datetime
The date and time when the durable execution started, in Unix timestamp format.
status
instance-attribute
¶
status: str
The current status of the durable execution. Valid values are RUNNING,
SUCCEEDED, FAILED, TIMED_OUT, and STOPPED.
trace_header
class-attribute
instance-attribute
¶
trace_header: TraceHeader | None = ...
The trace headers associated with the durable execution.