aws_sdk_lambda/client/

get_durable_execution_history.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetDurableExecutionHistory`](crate::operation::get_durable_execution_history::builders::GetDurableExecutionHistoryFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_durable_execution_history::builders::GetDurableExecutionHistoryFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`durable_execution_arn(impl Into<String>)`](crate::operation::get_durable_execution_history::builders::GetDurableExecutionHistoryFluentBuilder::durable_execution_arn) / [`set_durable_execution_arn(Option<String>)`](crate::operation::get_durable_execution_history::builders::GetDurableExecutionHistoryFluentBuilder::set_durable_execution_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the durable execution.</p><br>
    ///   - [`include_execution_data(bool)`](crate::operation::get_durable_execution_history::builders::GetDurableExecutionHistoryFluentBuilder::include_execution_data) / [`set_include_execution_data(Option<bool>)`](crate::operation::get_durable_execution_history::builders::GetDurableExecutionHistoryFluentBuilder::set_include_execution_data):<br>required: **false**<br><p>Specifies whether to include execution data such as step results and callback payloads in the history events. Set to <code>true</code> to include data, or <code>false</code> to exclude it for a more compact response. The default is <code>true</code>.</p><br>
    ///   - [`max_items(i32)`](crate::operation::get_durable_execution_history::builders::GetDurableExecutionHistoryFluentBuilder::max_items) / [`set_max_items(Option<i32>)`](crate::operation::get_durable_execution_history::builders::GetDurableExecutionHistoryFluentBuilder::set_max_items):<br>required: **false**<br><p>The maximum number of history events to return per call. You can use <code>Marker</code> to retrieve additional pages of results. The default is 100 and the maximum allowed is 1000. A value of 0 uses the default.</p><br>
    ///   - [`marker(impl Into<String>)`](crate::operation::get_durable_execution_history::builders::GetDurableExecutionHistoryFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::get_durable_execution_history::builders::GetDurableExecutionHistoryFluentBuilder::set_marker):<br>required: **false**<br><p>If <code>NextMarker</code> was returned from a previous request, use this value to retrieve the next page of results. Each pagination token expires after 24 hours.</p><br>
    ///   - [`reverse_order(bool)`](crate::operation::get_durable_execution_history::builders::GetDurableExecutionHistoryFluentBuilder::reverse_order) / [`set_reverse_order(Option<bool>)`](crate::operation::get_durable_execution_history::builders::GetDurableExecutionHistoryFluentBuilder::set_reverse_order):<br>required: **false**<br><p>When set to <code>true</code>, returns the history events in reverse chronological order (newest first). By default, events are returned in chronological order (oldest first).</p><br>
    /// - On success, responds with [`GetDurableExecutionHistoryOutput`](crate::operation::get_durable_execution_history::GetDurableExecutionHistoryOutput) with field(s):
    ///   - [`events(Vec::<Event>)`](crate::operation::get_durable_execution_history::GetDurableExecutionHistoryOutput::events): <p>An array of execution history events, ordered chronologically unless <code>ReverseOrder</code> is set to <code>true</code>. Each event represents a significant occurrence during the execution, such as step completion or callback resolution.</p>
    ///   - [`next_marker(Option<String>)`](crate::operation::get_durable_execution_history::GetDurableExecutionHistoryOutput::next_marker): <p>If present, indicates that more history events are available. Use this value as the <code>Marker</code> parameter in a subsequent request to retrieve the next page of results.</p>
    /// - On failure, responds with [`SdkError<GetDurableExecutionHistoryError>`](crate::operation::get_durable_execution_history::GetDurableExecutionHistoryError)
    pub fn get_durable_execution_history(
        &self,
    ) -> crate::operation::get_durable_execution_history::builders::GetDurableExecutionHistoryFluentBuilder {
        crate::operation::get_durable_execution_history::builders::GetDurableExecutionHistoryFluentBuilder::new(self.handle.clone())
    }
}