aws_sdk_bedrockagentruntime/client/stop_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 [`StopFlowExecution`](crate::operation::stop_flow_execution::builders::StopFlowExecutionFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`flow_identifier(impl Into<String>)`](crate::operation::stop_flow_execution::builders::StopFlowExecutionFluentBuilder::flow_identifier) / [`set_flow_identifier(Option<String>)`](crate::operation::stop_flow_execution::builders::StopFlowExecutionFluentBuilder::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::stop_flow_execution::builders::StopFlowExecutionFluentBuilder::flow_alias_identifier) / [`set_flow_alias_identifier(Option<String>)`](crate::operation::stop_flow_execution::builders::StopFlowExecutionFluentBuilder::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::stop_flow_execution::builders::StopFlowExecutionFluentBuilder::execution_identifier) / [`set_execution_identifier(Option<String>)`](crate::operation::stop_flow_execution::builders::StopFlowExecutionFluentBuilder::set_execution_identifier):<br>required: **true**<br><p>The unique identifier of the flow execution to stop.</p><br>
9 /// - On success, responds with [`StopFlowExecutionOutput`](crate::operation::stop_flow_execution::StopFlowExecutionOutput) with field(s):
10 /// - [`execution_arn(Option<String>)`](crate::operation::stop_flow_execution::StopFlowExecutionOutput::execution_arn): <p>The Amazon Resource Name (ARN) that uniquely identifies the flow execution that was stopped.</p>
11 /// - [`status(FlowExecutionStatus)`](crate::operation::stop_flow_execution::StopFlowExecutionOutput::status): <p>The updated status of the flow execution after the stop request. This will typically be ABORTED if the execution was successfully stopped.</p>
12 /// - On failure, responds with [`SdkError<StopFlowExecutionError>`](crate::operation::stop_flow_execution::StopFlowExecutionError)
13 pub fn stop_flow_execution(&self) -> crate::operation::stop_flow_execution::builders::StopFlowExecutionFluentBuilder {
14 crate::operation::stop_flow_execution::builders::StopFlowExecutionFluentBuilder::new(self.handle.clone())
15 }
16}