Skip to content

GetDurableExecutionResponse

Source code in docs_src/capo_lambda/types/get_durable_execution_response.py
class GetDurableExecutionResponse(TypedDict, closed=True):
    durable_execution_arn: "capo_lambda.types.durable_execution_arn.DurableExecutionArn"
    """<p>The Amazon Resource Name (ARN) of the durable execution.</p>"""
    durable_execution_name: (
        "capo_lambda.types.durable_execution_name.DurableExecutionName"
    )
    """<p>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.</p>"""
    function_arn: "capo_lambda.types.name_spaced_function_arn.NameSpacedFunctionArn"
    """<p>The Amazon Resource Name (ARN) of the Lambda function that was invoked to start this durable execution.</p>"""
    input_payload: NotRequired["capo_lambda.types.input_payload.InputPayload"]
    """<p>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.</p>"""
    result: NotRequired["capo_lambda.types.output_payload.OutputPayload"]
    """<p>The JSON result returned by the durable execution if it completed successfully. This field is only present when the execution status is <code>SUCCEEDED</code>. The result is limited to 256 KB.</p>"""
    error: NotRequired["capo_lambda.types.error_object.ErrorObject"]
    """<p>Error information if the durable execution failed. This field is only present when the execution status is <code>FAILED</code>, <code>TIMED_OUT</code>, or <code>STOPPED</code>. The combined size of all error fields is limited to 256 KB.</p>"""
    start_timestamp: "capo_lambda.types.execution_timestamp.ExecutionTimestamp"
    """<p>The date and time when the durable execution started, in Unix timestamp format.</p>"""
    status: "capo_lambda.types.execution_status.ExecutionStatus"
    """<p>The current status of the durable execution. Valid values are <code>RUNNING</code>, <code>SUCCEEDED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, and <code>STOPPED</code>.</p>"""
    end_timestamp: NotRequired[
        "capo_lambda.types.execution_timestamp.ExecutionTimestamp"
    ]
    """<p>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 <code>SUCCEEDED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or <code>STOPPED</code>).</p>"""
    version: NotRequired[
        "capo_lambda.types.version_with_latest_published.VersionWithLatestPublished"
    ]
    """<p>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.</p>"""
    trace_header: NotRequired["capo_lambda.types.trace_header.TraceHeader"]
    """<p>The trace headers associated with the durable execution.</p>"""
    execution_data_included: NotRequired[
        "capo_lambda.types.execution_data_included.ExecutionDataIncluded"
    ]
    """<p>Indicates whether execution data is included in this response. Returns <code>false</code> when <code>IncludeExecutionData</code> is set to <code>false</code> in the request.</p>"""
    durable_config: NotRequired["capo_lambda.types.durable_config.DurableConfig"]
    """<p>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.</p>"""

durable_config instance-attribute

durable_config: NotRequired[DurableConfig]

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: DurableExecutionArn

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

durable_execution_name instance-attribute

durable_execution_name: DurableExecutionName

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 instance-attribute

end_timestamp: NotRequired[ExecutionTimestamp]

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 instance-attribute

error: NotRequired[ErrorObject]

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.

execution_data_included instance-attribute

execution_data_included: NotRequired[ExecutionDataIncluded]

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: NameSpacedFunctionArn

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

input_payload instance-attribute

input_payload: NotRequired[InputPayload]

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 instance-attribute

result: NotRequired[OutputPayload]

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.

start_timestamp instance-attribute

start_timestamp: ExecutionTimestamp

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

status instance-attribute

The current status of the durable execution. Valid values are RUNNING, SUCCEEDED, FAILED, TIMED_OUT, and STOPPED.

trace_header instance-attribute

trace_header: NotRequired[TraceHeader]

The trace headers associated with the durable execution.

version instance-attribute

version: NotRequired[VersionWithLatestPublished]

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.