aws_sdk_bedrockagentruntime/client/
list_flow_execution_events.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 [`ListFlowExecutionEvents`](crate::operation::list_flow_execution_events::builders::ListFlowExecutionEventsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_flow_execution_events::builders::ListFlowExecutionEventsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`flow_identifier(impl Into<String>)`](crate::operation::list_flow_execution_events::builders::ListFlowExecutionEventsFluentBuilder::flow_identifier) / [`set_flow_identifier(Option<String>)`](crate::operation::list_flow_execution_events::builders::ListFlowExecutionEventsFluentBuilder::set_flow_identifier):<br>required: **true**<br><p>The unique identifier of the flow.</p><br>
8    ///   - [`flow_alias_identifier(impl Into<String>)`](crate::operation::list_flow_execution_events::builders::ListFlowExecutionEventsFluentBuilder::flow_alias_identifier) / [`set_flow_alias_identifier(Option<String>)`](crate::operation::list_flow_execution_events::builders::ListFlowExecutionEventsFluentBuilder::set_flow_alias_identifier):<br>required: **true**<br><p>The unique identifier of the flow alias used for the execution.</p><br>
9    ///   - [`execution_identifier(impl Into<String>)`](crate::operation::list_flow_execution_events::builders::ListFlowExecutionEventsFluentBuilder::execution_identifier) / [`set_execution_identifier(Option<String>)`](crate::operation::list_flow_execution_events::builders::ListFlowExecutionEventsFluentBuilder::set_execution_identifier):<br>required: **true**<br><p>The unique identifier of the flow execution.</p><br>
10    ///   - [`max_results(i32)`](crate::operation::list_flow_execution_events::builders::ListFlowExecutionEventsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_flow_execution_events::builders::ListFlowExecutionEventsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of events to return in a single response. If more events exist than the specified maxResults value, a token is included in the response so that the remaining results can be retrieved.</p><br>
11    ///   - [`next_token(impl Into<String>)`](crate::operation::list_flow_execution_events::builders::ListFlowExecutionEventsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_flow_execution_events::builders::ListFlowExecutionEventsFluentBuilder::set_next_token):<br>required: **false**<br><p>A token to retrieve the next set of results. This value is returned in the response if more results are available.</p><br>
12    ///   - [`event_type(FlowExecutionEventType)`](crate::operation::list_flow_execution_events::builders::ListFlowExecutionEventsFluentBuilder::event_type) / [`set_event_type(Option<FlowExecutionEventType>)`](crate::operation::list_flow_execution_events::builders::ListFlowExecutionEventsFluentBuilder::set_event_type):<br>required: **true**<br><p>The type of events to retrieve. Specify <code>Node</code> for node-level events or <code>Flow</code> for flow-level events.</p><br>
13    /// - On success, responds with [`ListFlowExecutionEventsOutput`](crate::operation::list_flow_execution_events::ListFlowExecutionEventsOutput) with field(s):
14    ///   - [`flow_execution_events(Vec::<FlowExecutionEvent>)`](crate::operation::list_flow_execution_events::ListFlowExecutionEventsOutput::flow_execution_events): <p>A list of events that occurred during the flow execution. Events can include node inputs and outputs, flow inputs and outputs, condition results, and failure events.</p>
15    ///   - [`next_token(Option<String>)`](crate::operation::list_flow_execution_events::ListFlowExecutionEventsOutput::next_token): <p>A token to retrieve the next set of results. This value is returned if more results are available.</p>
16    /// - On failure, responds with [`SdkError<ListFlowExecutionEventsError>`](crate::operation::list_flow_execution_events::ListFlowExecutionEventsError)
17    pub fn list_flow_execution_events(&self) -> crate::operation::list_flow_execution_events::builders::ListFlowExecutionEventsFluentBuilder {
18        crate::operation::list_flow_execution_events::builders::ListFlowExecutionEventsFluentBuilder::new(self.handle.clone())
19    }
20}