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
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct StartFlowExecutionInput {
    /// <p>The unique identifier of the flow to execute.</p>
    pub flow_identifier: ::std::option::Option<::std::string::String>,
    /// <p>The unique identifier of the flow alias to use for the flow execution.</p>
    pub flow_alias_identifier: ::std::option::Option<::std::string::String>,
    /// <p>The unique name for the flow execution. If you don't provide one, a system-generated name is used.</p>
    pub flow_execution_name: ::std::option::Option<::std::string::String>,
    /// <p>The input data required for the flow execution. This must match the input schema defined in the flow.</p>
    pub inputs: ::std::option::Option<::std::vec::Vec<crate::types::FlowInput>>,
    /// <p>The performance settings for the foundation model used in the flow execution.</p>
    pub model_performance_configuration: ::std::option::Option<crate::types::ModelPerformanceConfiguration>,
}
impl StartFlowExecutionInput {
    /// <p>The unique identifier of the flow to execute.</p>
    pub fn flow_identifier(&self) -> ::std::option::Option<&str> {
        self.flow_identifier.as_deref()
    }
    /// <p>The unique identifier of the flow alias to use for the flow execution.</p>
    pub fn flow_alias_identifier(&self) -> ::std::option::Option<&str> {
        self.flow_alias_identifier.as_deref()
    }
    /// <p>The unique name for the flow execution. If you don't provide one, a system-generated name is used.</p>
    pub fn flow_execution_name(&self) -> ::std::option::Option<&str> {
        self.flow_execution_name.as_deref()
    }
    /// <p>The input data required for the flow execution. This must match the input schema defined in the flow.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.inputs.is_none()`.
    pub fn inputs(&self) -> &[crate::types::FlowInput] {
        self.inputs.as_deref().unwrap_or_default()
    }
    /// <p>The performance settings for the foundation model used in the flow execution.</p>
    pub fn model_performance_configuration(&self) -> ::std::option::Option<&crate::types::ModelPerformanceConfiguration> {
        self.model_performance_configuration.as_ref()
    }
}
impl StartFlowExecutionInput {
    /// Creates a new builder-style object to manufacture [`StartFlowExecutionInput`](crate::operation::start_flow_execution::StartFlowExecutionInput).
    pub fn builder() -> crate::operation::start_flow_execution::builders::StartFlowExecutionInputBuilder {
        crate::operation::start_flow_execution::builders::StartFlowExecutionInputBuilder::default()
    }
}

/// A builder for [`StartFlowExecutionInput`](crate::operation::start_flow_execution::StartFlowExecutionInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct StartFlowExecutionInputBuilder {
    pub(crate) flow_identifier: ::std::option::Option<::std::string::String>,
    pub(crate) flow_alias_identifier: ::std::option::Option<::std::string::String>,
    pub(crate) flow_execution_name: ::std::option::Option<::std::string::String>,
    pub(crate) inputs: ::std::option::Option<::std::vec::Vec<crate::types::FlowInput>>,
    pub(crate) model_performance_configuration: ::std::option::Option<crate::types::ModelPerformanceConfiguration>,
}
impl StartFlowExecutionInputBuilder {
    /// <p>The unique identifier of the flow to execute.</p>
    /// This field is required.
    pub fn flow_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.flow_identifier = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The unique identifier of the flow to execute.</p>
    pub fn set_flow_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.flow_identifier = input;
        self
    }
    /// <p>The unique identifier of the flow to execute.</p>
    pub fn get_flow_identifier(&self) -> &::std::option::Option<::std::string::String> {
        &self.flow_identifier
    }
    /// <p>The unique identifier of the flow alias to use for the flow execution.</p>
    /// This field is required.
    pub fn flow_alias_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.flow_alias_identifier = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The unique identifier of the flow alias to use for the flow execution.</p>
    pub fn set_flow_alias_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.flow_alias_identifier = input;
        self
    }
    /// <p>The unique identifier of the flow alias to use for the flow execution.</p>
    pub fn get_flow_alias_identifier(&self) -> &::std::option::Option<::std::string::String> {
        &self.flow_alias_identifier
    }
    /// <p>The unique name for the flow execution. If you don't provide one, a system-generated name is used.</p>
    pub fn flow_execution_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.flow_execution_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The unique name for the flow execution. If you don't provide one, a system-generated name is used.</p>
    pub fn set_flow_execution_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.flow_execution_name = input;
        self
    }
    /// <p>The unique name for the flow execution. If you don't provide one, a system-generated name is used.</p>
    pub fn get_flow_execution_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.flow_execution_name
    }
    /// Appends an item to `inputs`.
    ///
    /// To override the contents of this collection use [`set_inputs`](Self::set_inputs).
    ///
    /// <p>The input data required for the flow execution. This must match the input schema defined in the flow.</p>
    pub fn inputs(mut self, input: crate::types::FlowInput) -> Self {
        let mut v = self.inputs.unwrap_or_default();
        v.push(input);
        self.inputs = ::std::option::Option::Some(v);
        self
    }
    /// <p>The input data required for the flow execution. This must match the input schema defined in the flow.</p>
    pub fn set_inputs(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::FlowInput>>) -> Self {
        self.inputs = input;
        self
    }
    /// <p>The input data required for the flow execution. This must match the input schema defined in the flow.</p>
    pub fn get_inputs(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::FlowInput>> {
        &self.inputs
    }
    /// <p>The performance settings for the foundation model used in the flow execution.</p>
    pub fn model_performance_configuration(mut self, input: crate::types::ModelPerformanceConfiguration) -> Self {
        self.model_performance_configuration = ::std::option::Option::Some(input);
        self
    }
    /// <p>The performance settings for the foundation model used in the flow execution.</p>
    pub fn set_model_performance_configuration(mut self, input: ::std::option::Option<crate::types::ModelPerformanceConfiguration>) -> Self {
        self.model_performance_configuration = input;
        self
    }
    /// <p>The performance settings for the foundation model used in the flow execution.</p>
    pub fn get_model_performance_configuration(&self) -> &::std::option::Option<crate::types::ModelPerformanceConfiguration> {
        &self.model_performance_configuration
    }
    /// Consumes the builder and constructs a [`StartFlowExecutionInput`](crate::operation::start_flow_execution::StartFlowExecutionInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::start_flow_execution::StartFlowExecutionInput, ::aws_smithy_types::error::operation::BuildError>
    {
        ::std::result::Result::Ok(crate::operation::start_flow_execution::StartFlowExecutionInput {
            flow_identifier: self.flow_identifier,
            flow_alias_identifier: self.flow_alias_identifier,
            flow_execution_name: self.flow_execution_name,
            inputs: self.inputs,
            model_performance_configuration: self.model_performance_configuration,
        })
    }
}