aws_sdk_bedrockagentruntime/client/get_flow_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 [`GetFlowExecution`](crate::operation::get_flow_execution::builders::GetFlowExecutionFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`flow_identifier(impl Into<String>)`](crate::operation::get_flow_execution::builders::GetFlowExecutionFluentBuilder::flow_identifier) / [`set_flow_identifier(Option<String>)`](crate::operation::get_flow_execution::builders::GetFlowExecutionFluentBuilder::set_flow_identifier):<br>required: **true**<br><p>The unique identifier of the flow.</p><br>
7 /// - [`flow_alias_identifier(impl Into<String>)`](crate::operation::get_flow_execution::builders::GetFlowExecutionFluentBuilder::flow_alias_identifier) / [`set_flow_alias_identifier(Option<String>)`](crate::operation::get_flow_execution::builders::GetFlowExecutionFluentBuilder::set_flow_alias_identifier):<br>required: **true**<br><p>The unique identifier of the flow alias used for the execution.</p><br>
8 /// - [`execution_identifier(impl Into<String>)`](crate::operation::get_flow_execution::builders::GetFlowExecutionFluentBuilder::execution_identifier) / [`set_execution_identifier(Option<String>)`](crate::operation::get_flow_execution::builders::GetFlowExecutionFluentBuilder::set_execution_identifier):<br>required: **true**<br><p>The unique identifier of the flow execution to retrieve.</p><br>
9 /// - On success, responds with [`GetFlowExecutionOutput`](crate::operation::get_flow_execution::GetFlowExecutionOutput) with field(s):
10 /// - [`execution_arn(String)`](crate::operation::get_flow_execution::GetFlowExecutionOutput::execution_arn): <p>The Amazon Resource Name (ARN) that uniquely identifies the flow execution.</p>
11 /// - [`status(FlowExecutionStatus)`](crate::operation::get_flow_execution::GetFlowExecutionOutput::status): <p>The current status of the flow execution.</p> <p>Flow executions time out after 24 hours.</p>
12 /// - [`started_at(DateTime)`](crate::operation::get_flow_execution::GetFlowExecutionOutput::started_at): <p>The timestamp when the flow execution started.</p>
13 /// - [`ended_at(Option<DateTime>)`](crate::operation::get_flow_execution::GetFlowExecutionOutput::ended_at): <p>The timestamp when the flow execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.</p>
14 /// - [`errors(Option<Vec::<FlowExecutionError>>)`](crate::operation::get_flow_execution::GetFlowExecutionOutput::errors): <p>A list of errors that occurred during the flow execution. Each error includes an error code, message, and the node where the error occurred, if applicable.</p>
15 /// - [`flow_alias_identifier(String)`](crate::operation::get_flow_execution::GetFlowExecutionOutput::flow_alias_identifier): <p>The unique identifier of the flow alias used for the execution.</p>
16 /// - [`flow_identifier(String)`](crate::operation::get_flow_execution::GetFlowExecutionOutput::flow_identifier): <p>The unique identifier of the flow.</p>
17 /// - [`flow_version(String)`](crate::operation::get_flow_execution::GetFlowExecutionOutput::flow_version): <p>The version of the flow used for the execution.</p>
18 /// - On failure, responds with [`SdkError<GetFlowExecutionError>`](crate::operation::get_flow_execution::GetFlowExecutionError)
19 pub fn get_flow_execution(&self) -> crate::operation::get_flow_execution::builders::GetFlowExecutionFluentBuilder {
20 crate::operation::get_flow_execution::builders::GetFlowExecutionFluentBuilder::new(self.handle.clone())
21 }
22}