aws_sdk_lambda/client/
get_durable_execution.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetDurableExecution`](crate::operation::get_durable_execution::builders::GetDurableExecutionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`durable_execution_arn(impl Into<String>)`](crate::operation::get_durable_execution::builders::GetDurableExecutionFluentBuilder::durable_execution_arn) / [`set_durable_execution_arn(Option<String>)`](crate::operation::get_durable_execution::builders::GetDurableExecutionFluentBuilder::set_durable_execution_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the durable execution.</p><br>
7    ///   - [`include_execution_data(bool)`](crate::operation::get_durable_execution::builders::GetDurableExecutionFluentBuilder::include_execution_data) / [`set_include_execution_data(Option<bool>)`](crate::operation::get_durable_execution::builders::GetDurableExecutionFluentBuilder::set_include_execution_data):<br>required: **false**<br><p>Specifies whether to include execution data such as input payload, result, and error information in the response. Set to <code>false</code> for a more compact response that includes only execution metadata. The default value is set to <code>true</code>.</p><br>
8    /// - On success, responds with [`GetDurableExecutionOutput`](crate::operation::get_durable_execution::GetDurableExecutionOutput) with field(s):
9    ///   - [`durable_execution_arn(String)`](crate::operation::get_durable_execution::GetDurableExecutionOutput::durable_execution_arn): <p>The Amazon Resource Name (ARN) of the durable execution.</p>
10    ///   - [`durable_execution_name(String)`](crate::operation::get_durable_execution::GetDurableExecutionOutput::durable_execution_name): <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>
11    ///   - [`function_arn(String)`](crate::operation::get_durable_execution::GetDurableExecutionOutput::function_arn): <p>The Amazon Resource Name (ARN) of the Lambda function that was invoked to start this durable execution.</p>
12    ///   - [`input_payload(Option<String>)`](crate::operation::get_durable_execution::GetDurableExecutionOutput::input_payload): <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>
13    ///   - [`result(Option<String>)`](crate::operation::get_durable_execution::GetDurableExecutionOutput::result): <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>
14    ///   - [`error(Option<ErrorObject>)`](crate::operation::get_durable_execution::GetDurableExecutionOutput::error): <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>
15    ///   - [`start_timestamp(DateTime)`](crate::operation::get_durable_execution::GetDurableExecutionOutput::start_timestamp): <p>The date and time when the durable execution started, in Unix timestamp format.</p>
16    ///   - [`status(ExecutionStatus)`](crate::operation::get_durable_execution::GetDurableExecutionOutput::status): <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>
17    ///   - [`end_timestamp(Option<DateTime>)`](crate::operation::get_durable_execution::GetDurableExecutionOutput::end_timestamp): <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>
18    ///   - [`version(Option<String>)`](crate::operation::get_durable_execution::GetDurableExecutionOutput::version): <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>
19    ///   - [`trace_header(Option<TraceHeader>)`](crate::operation::get_durable_execution::GetDurableExecutionOutput::trace_header): <p>The trace headers associated with the durable execution.</p>
20    ///   - [`execution_data_included(Option<bool>)`](crate::operation::get_durable_execution::GetDurableExecutionOutput::execution_data_included): <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>
21    ///   - [`durable_config(Option<DurableConfig>)`](crate::operation::get_durable_execution::GetDurableExecutionOutput::durable_config): <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>
22    /// - On failure, responds with [`SdkError<GetDurableExecutionError>`](crate::operation::get_durable_execution::GetDurableExecutionError)
23    pub fn get_durable_execution(&self) -> crate::operation::get_durable_execution::builders::GetDurableExecutionFluentBuilder {
24        crate::operation::get_durable_execution::builders::GetDurableExecutionFluentBuilder::new(self.handle.clone())
25    }
26}
aws_sdk_lambda/client/get_durable_execution.rs

aws_sdk_lambda/client/
get_durable_execution.rs
