aws_sdk_bedrockagentruntime/client/
list_flow_executions.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 [`ListFlowExecutions`](crate::operation::list_flow_executions::builders::ListFlowExecutionsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_flow_executions::builders::ListFlowExecutionsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`flow_identifier(impl Into<String>)`](crate::operation::list_flow_executions::builders::ListFlowExecutionsFluentBuilder::flow_identifier) / [`set_flow_identifier(Option<String>)`](crate::operation::list_flow_executions::builders::ListFlowExecutionsFluentBuilder::set_flow_identifier):<br>required: **true**<br><p>The unique identifier of the flow to list executions for.</p><br>
8    ///   - [`flow_alias_identifier(impl Into<String>)`](crate::operation::list_flow_executions::builders::ListFlowExecutionsFluentBuilder::flow_alias_identifier) / [`set_flow_alias_identifier(Option<String>)`](crate::operation::list_flow_executions::builders::ListFlowExecutionsFluentBuilder::set_flow_alias_identifier):<br>required: **false**<br><p>The unique identifier of the flow alias to list executions for.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_flow_executions::builders::ListFlowExecutionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_flow_executions::builders::ListFlowExecutionsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of flow executions to return in a single response. If more executions exist than the specified <code>maxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::list_flow_executions::builders::ListFlowExecutionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_flow_executions::builders::ListFlowExecutionsFluentBuilder::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>
11    /// - On success, responds with [`ListFlowExecutionsOutput`](crate::operation::list_flow_executions::ListFlowExecutionsOutput) with field(s):
12    ///   - [`flow_execution_summaries(Vec::<FlowExecutionSummary>)`](crate::operation::list_flow_executions::ListFlowExecutionsOutput::flow_execution_summaries): <p>A list of flow execution summaries. Each summary includes the execution ARN, flow identifier, flow alias identifier, flow version, status, and timestamps.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_flow_executions::ListFlowExecutionsOutput::next_token): <p>A token to retrieve the next set of results. This value is returned if more results are available.</p>
14    /// - On failure, responds with [`SdkError<ListFlowExecutionsError>`](crate::operation::list_flow_executions::ListFlowExecutionsError)
15    pub fn list_flow_executions(&self) -> crate::operation::list_flow_executions::builders::ListFlowExecutionsFluentBuilder {
16        crate::operation::list_flow_executions::builders::ListFlowExecutionsFluentBuilder::new(self.handle.clone())
17    }
18}