1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetWorkflowExecutionHistory`](crate::operation::get_workflow_execution_history::builders::GetWorkflowExecutionHistoryFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_workflow_execution_history::builders::GetWorkflowExecutionHistoryFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`domain(impl Into<String>)`](crate::operation::get_workflow_execution_history::builders::GetWorkflowExecutionHistoryFluentBuilder::domain) / [`set_domain(Option<String>)`](crate::operation::get_workflow_execution_history::builders::GetWorkflowExecutionHistoryFluentBuilder::set_domain):<br>required: **true**<br><p>The name of the domain containing the workflow execution.</p><br>
    ///   - [`execution(WorkflowExecution)`](crate::operation::get_workflow_execution_history::builders::GetWorkflowExecutionHistoryFluentBuilder::execution) / [`set_execution(Option<WorkflowExecution>)`](crate::operation::get_workflow_execution_history::builders::GetWorkflowExecutionHistoryFluentBuilder::set_execution):<br>required: **true**<br><p>Specifies the workflow execution for which to return the history.</p><br>
    ///   - [`next_page_token(impl Into<String>)`](crate::operation::get_workflow_execution_history::builders::GetWorkflowExecutionHistoryFluentBuilder::next_page_token) / [`set_next_page_token(Option<String>)`](crate::operation::get_workflow_execution_history::builders::GetWorkflowExecutionHistoryFluentBuilder::set_next_page_token):<br>required: **false**<br><p>If <code>NextPageToken</code> is returned there are more results available. The value of <code>NextPageToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a <code>400</code> error: "<code>Specified token has exceeded its maximum lifetime</code>".</p> <p>The configured <code>maximumPageSize</code> determines how many results can be returned in a single call.</p><br>
    ///   - [`maximum_page_size(i32)`](crate::operation::get_workflow_execution_history::builders::GetWorkflowExecutionHistoryFluentBuilder::maximum_page_size) / [`set_maximum_page_size(Option<i32>)`](crate::operation::get_workflow_execution_history::builders::GetWorkflowExecutionHistoryFluentBuilder::set_maximum_page_size):<br>required: **false**<br><p>The maximum number of results that are returned per call. Use <code>nextPageToken</code> to obtain further pages of results.</p><br>
    ///   - [`reverse_order(bool)`](crate::operation::get_workflow_execution_history::builders::GetWorkflowExecutionHistoryFluentBuilder::reverse_order) / [`set_reverse_order(Option<bool>)`](crate::operation::get_workflow_execution_history::builders::GetWorkflowExecutionHistoryFluentBuilder::set_reverse_order):<br>required: **false**<br><p>When set to <code>true</code>, returns the events in reverse order. By default the results are returned in ascending order of the <code>eventTimeStamp</code> of the events.</p><br>
    /// - On success, responds with [`GetWorkflowExecutionHistoryOutput`](crate::operation::get_workflow_execution_history::GetWorkflowExecutionHistoryOutput) with field(s):
    ///   - [`events(Vec::<HistoryEvent>)`](crate::operation::get_workflow_execution_history::GetWorkflowExecutionHistoryOutput::events): <p>The list of history events.</p>
    ///   - [`next_page_token(Option<String>)`](crate::operation::get_workflow_execution_history::GetWorkflowExecutionHistoryOutput::next_page_token): <p>If a <code>NextPageToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>nextPageToken</code>. Keep all other arguments unchanged.</p> <p>The configured <code>maximumPageSize</code> determines how many results can be returned in a single call.</p>
    /// - On failure, responds with [`SdkError<GetWorkflowExecutionHistoryError>`](crate::operation::get_workflow_execution_history::GetWorkflowExecutionHistoryError)
    pub fn get_workflow_execution_history(
        &self,
    ) -> crate::operation::get_workflow_execution_history::builders::GetWorkflowExecutionHistoryFluentBuilder {
        crate::operation::get_workflow_execution_history::builders::GetWorkflowExecutionHistoryFluentBuilder::new(self.handle.clone())
    }
}