aws-sdk-bedrockagentruntime 1.126.0

AWS SDK for Agents for Amazon Bedrock Runtime
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartFlowExecution`](crate::operation::start_flow_execution::builders::StartFlowExecutionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`flow_identifier(impl Into<String>)`](crate::operation::start_flow_execution::builders::StartFlowExecutionFluentBuilder::flow_identifier) / [`set_flow_identifier(Option<String>)`](crate::operation::start_flow_execution::builders::StartFlowExecutionFluentBuilder::set_flow_identifier):<br>required: **true**<br><p>The unique identifier of the flow to execute.</p><br>
    ///   - [`flow_alias_identifier(impl Into<String>)`](crate::operation::start_flow_execution::builders::StartFlowExecutionFluentBuilder::flow_alias_identifier) / [`set_flow_alias_identifier(Option<String>)`](crate::operation::start_flow_execution::builders::StartFlowExecutionFluentBuilder::set_flow_alias_identifier):<br>required: **true**<br><p>The unique identifier of the flow alias to use for the flow execution.</p><br>
    ///   - [`flow_execution_name(impl Into<String>)`](crate::operation::start_flow_execution::builders::StartFlowExecutionFluentBuilder::flow_execution_name) / [`set_flow_execution_name(Option<String>)`](crate::operation::start_flow_execution::builders::StartFlowExecutionFluentBuilder::set_flow_execution_name):<br>required: **false**<br><p>The unique name for the flow execution. If you don't provide one, a system-generated name is used.</p><br>
    ///   - [`inputs(FlowInput)`](crate::operation::start_flow_execution::builders::StartFlowExecutionFluentBuilder::inputs) / [`set_inputs(Option<Vec::<FlowInput>>)`](crate::operation::start_flow_execution::builders::StartFlowExecutionFluentBuilder::set_inputs):<br>required: **true**<br><p>The input data required for the flow execution. This must match the input schema defined in the flow.</p><br>
    ///   - [`model_performance_configuration(ModelPerformanceConfiguration)`](crate::operation::start_flow_execution::builders::StartFlowExecutionFluentBuilder::model_performance_configuration) / [`set_model_performance_configuration(Option<ModelPerformanceConfiguration>)`](crate::operation::start_flow_execution::builders::StartFlowExecutionFluentBuilder::set_model_performance_configuration):<br>required: **false**<br><p>The performance settings for the foundation model used in the flow execution.</p><br>
    /// - On success, responds with [`StartFlowExecutionOutput`](crate::operation::start_flow_execution::StartFlowExecutionOutput) with field(s):
    ///   - [`execution_arn(Option<String>)`](crate::operation::start_flow_execution::StartFlowExecutionOutput::execution_arn): <p>The Amazon Resource Name (ARN) that uniquely identifies the flow execution.</p>
    /// - On failure, responds with [`SdkError<StartFlowExecutionError>`](crate::operation::start_flow_execution::StartFlowExecutionError)
    pub fn start_flow_execution(&self) -> crate::operation::start_flow_execution::builders::StartFlowExecutionFluentBuilder {
        crate::operation::start_flow_execution::builders::StartFlowExecutionFluentBuilder::new(self.handle.clone())
    }
}