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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
// 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)]
pub struct CreateAgentInput {
/// <p>A name for the agent that you create.</p>
pub agent_name: ::std::option::Option<::std::string::String>,
/// <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
pub client_token: ::std::option::Option<::std::string::String>,
/// <p>Instructions that tell the agent what it should do and how it should interact with users.</p>
pub instruction: ::std::option::Option<::std::string::String>,
/// <p>The foundation model to be used for orchestration by the agent you create.</p>
pub foundation_model: ::std::option::Option<::std::string::String>,
/// <p>A description of the agent.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</p>
/// <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.</p>
pub idle_session_ttl_in_seconds: ::std::option::Option<i32>,
/// <p>The ARN of the IAM role with permissions to create the agent. The ARN must begin with <code>AmazonBedrockExecutionRoleForAgents_</code>.</p>
pub agent_resource_role_arn: ::std::option::Option<::std::string::String>,
/// <p>The ARN of the KMS key with which to encrypt the agent.</p>
pub customer_encryption_key_arn: ::std::option::Option<::std::string::String>,
/// <p>Any tags that you want to attach to the agent.</p>
pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
/// <p>Contains configurations to override prompts in different parts of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.</p>
pub prompt_override_configuration: ::std::option::Option<crate::types::PromptOverrideConfiguration>,
}
impl CreateAgentInput {
/// <p>A name for the agent that you create.</p>
pub fn agent_name(&self) -> ::std::option::Option<&str> {
self.agent_name.as_deref()
}
/// <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
pub fn client_token(&self) -> ::std::option::Option<&str> {
self.client_token.as_deref()
}
/// <p>Instructions that tell the agent what it should do and how it should interact with users.</p>
pub fn instruction(&self) -> ::std::option::Option<&str> {
self.instruction.as_deref()
}
/// <p>The foundation model to be used for orchestration by the agent you create.</p>
pub fn foundation_model(&self) -> ::std::option::Option<&str> {
self.foundation_model.as_deref()
}
/// <p>A description of the agent.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</p>
/// <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.</p>
pub fn idle_session_ttl_in_seconds(&self) -> ::std::option::Option<i32> {
self.idle_session_ttl_in_seconds
}
/// <p>The ARN of the IAM role with permissions to create the agent. The ARN must begin with <code>AmazonBedrockExecutionRoleForAgents_</code>.</p>
pub fn agent_resource_role_arn(&self) -> ::std::option::Option<&str> {
self.agent_resource_role_arn.as_deref()
}
/// <p>The ARN of the KMS key with which to encrypt the agent.</p>
pub fn customer_encryption_key_arn(&self) -> ::std::option::Option<&str> {
self.customer_encryption_key_arn.as_deref()
}
/// <p>Any tags that you want to attach to the agent.</p>
pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
self.tags.as_ref()
}
/// <p>Contains configurations to override prompts in different parts of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.</p>
pub fn prompt_override_configuration(&self) -> ::std::option::Option<&crate::types::PromptOverrideConfiguration> {
self.prompt_override_configuration.as_ref()
}
}
impl ::std::fmt::Debug for CreateAgentInput {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
let mut formatter = f.debug_struct("CreateAgentInput");
formatter.field("agent_name", &self.agent_name);
formatter.field("client_token", &self.client_token);
formatter.field("instruction", &"*** Sensitive Data Redacted ***");
formatter.field("foundation_model", &self.foundation_model);
formatter.field("description", &self.description);
formatter.field("idle_session_ttl_in_seconds", &self.idle_session_ttl_in_seconds);
formatter.field("agent_resource_role_arn", &self.agent_resource_role_arn);
formatter.field("customer_encryption_key_arn", &self.customer_encryption_key_arn);
formatter.field("tags", &self.tags);
formatter.field("prompt_override_configuration", &"*** Sensitive Data Redacted ***");
formatter.finish()
}
}
impl CreateAgentInput {
/// Creates a new builder-style object to manufacture [`CreateAgentInput`](crate::operation::create_agent::CreateAgentInput).
pub fn builder() -> crate::operation::create_agent::builders::CreateAgentInputBuilder {
crate::operation::create_agent::builders::CreateAgentInputBuilder::default()
}
}
/// A builder for [`CreateAgentInput`](crate::operation::create_agent::CreateAgentInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
pub struct CreateAgentInputBuilder {
pub(crate) agent_name: ::std::option::Option<::std::string::String>,
pub(crate) client_token: ::std::option::Option<::std::string::String>,
pub(crate) instruction: ::std::option::Option<::std::string::String>,
pub(crate) foundation_model: ::std::option::Option<::std::string::String>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) idle_session_ttl_in_seconds: ::std::option::Option<i32>,
pub(crate) agent_resource_role_arn: ::std::option::Option<::std::string::String>,
pub(crate) customer_encryption_key_arn: ::std::option::Option<::std::string::String>,
pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
pub(crate) prompt_override_configuration: ::std::option::Option<crate::types::PromptOverrideConfiguration>,
}
impl CreateAgentInputBuilder {
/// <p>A name for the agent that you create.</p>
/// This field is required.
pub fn agent_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.agent_name = ::std::option::Option::Some(input.into());
self
}
/// <p>A name for the agent that you create.</p>
pub fn set_agent_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.agent_name = input;
self
}
/// <p>A name for the agent that you create.</p>
pub fn get_agent_name(&self) -> &::std::option::Option<::std::string::String> {
&self.agent_name
}
/// <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.client_token = ::std::option::Option::Some(input.into());
self
}
/// <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.client_token = input;
self
}
/// <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
&self.client_token
}
/// <p>Instructions that tell the agent what it should do and how it should interact with users.</p>
pub fn instruction(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.instruction = ::std::option::Option::Some(input.into());
self
}
/// <p>Instructions that tell the agent what it should do and how it should interact with users.</p>
pub fn set_instruction(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.instruction = input;
self
}
/// <p>Instructions that tell the agent what it should do and how it should interact with users.</p>
pub fn get_instruction(&self) -> &::std::option::Option<::std::string::String> {
&self.instruction
}
/// <p>The foundation model to be used for orchestration by the agent you create.</p>
pub fn foundation_model(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.foundation_model = ::std::option::Option::Some(input.into());
self
}
/// <p>The foundation model to be used for orchestration by the agent you create.</p>
pub fn set_foundation_model(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.foundation_model = input;
self
}
/// <p>The foundation model to be used for orchestration by the agent you create.</p>
pub fn get_foundation_model(&self) -> &::std::option::Option<::std::string::String> {
&self.foundation_model
}
/// <p>A description of the agent.</p>
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.description = ::std::option::Option::Some(input.into());
self
}
/// <p>A description of the agent.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>A description of the agent.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</p>
/// <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.</p>
pub fn idle_session_ttl_in_seconds(mut self, input: i32) -> Self {
self.idle_session_ttl_in_seconds = ::std::option::Option::Some(input);
self
}
/// <p>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</p>
/// <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.</p>
pub fn set_idle_session_ttl_in_seconds(mut self, input: ::std::option::Option<i32>) -> Self {
self.idle_session_ttl_in_seconds = input;
self
}
/// <p>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</p>
/// <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.</p>
pub fn get_idle_session_ttl_in_seconds(&self) -> &::std::option::Option<i32> {
&self.idle_session_ttl_in_seconds
}
/// <p>The ARN of the IAM role with permissions to create the agent. The ARN must begin with <code>AmazonBedrockExecutionRoleForAgents_</code>.</p>
/// This field is required.
pub fn agent_resource_role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.agent_resource_role_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The ARN of the IAM role with permissions to create the agent. The ARN must begin with <code>AmazonBedrockExecutionRoleForAgents_</code>.</p>
pub fn set_agent_resource_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.agent_resource_role_arn = input;
self
}
/// <p>The ARN of the IAM role with permissions to create the agent. The ARN must begin with <code>AmazonBedrockExecutionRoleForAgents_</code>.</p>
pub fn get_agent_resource_role_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.agent_resource_role_arn
}
/// <p>The ARN of the KMS key with which to encrypt the agent.</p>
pub fn customer_encryption_key_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.customer_encryption_key_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The ARN of the KMS key with which to encrypt the agent.</p>
pub fn set_customer_encryption_key_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.customer_encryption_key_arn = input;
self
}
/// <p>The ARN of the KMS key with which to encrypt the agent.</p>
pub fn get_customer_encryption_key_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.customer_encryption_key_arn
}
/// Adds a key-value pair to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>Any tags that you want to attach to the agent.</p>
pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut hash_map = self.tags.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.tags = ::std::option::Option::Some(hash_map);
self
}
/// <p>Any tags that you want to attach to the agent.</p>
pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
self.tags = input;
self
}
/// <p>Any tags that you want to attach to the agent.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
&self.tags
}
/// <p>Contains configurations to override prompts in different parts of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.</p>
pub fn prompt_override_configuration(mut self, input: crate::types::PromptOverrideConfiguration) -> Self {
self.prompt_override_configuration = ::std::option::Option::Some(input);
self
}
/// <p>Contains configurations to override prompts in different parts of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.</p>
pub fn set_prompt_override_configuration(mut self, input: ::std::option::Option<crate::types::PromptOverrideConfiguration>) -> Self {
self.prompt_override_configuration = input;
self
}
/// <p>Contains configurations to override prompts in different parts of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.</p>
pub fn get_prompt_override_configuration(&self) -> &::std::option::Option<crate::types::PromptOverrideConfiguration> {
&self.prompt_override_configuration
}
/// Consumes the builder and constructs a [`CreateAgentInput`](crate::operation::create_agent::CreateAgentInput).
pub fn build(self) -> ::std::result::Result<crate::operation::create_agent::CreateAgentInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::create_agent::CreateAgentInput {
agent_name: self.agent_name,
client_token: self.client_token,
instruction: self.instruction,
foundation_model: self.foundation_model,
description: self.description,
idle_session_ttl_in_seconds: self.idle_session_ttl_in_seconds,
agent_resource_role_arn: self.agent_resource_role_arn,
customer_encryption_key_arn: self.customer_encryption_key_arn,
tags: self.tags,
prompt_override_configuration: self.prompt_override_configuration,
})
}
}
impl ::std::fmt::Debug for CreateAgentInputBuilder {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
let mut formatter = f.debug_struct("CreateAgentInputBuilder");
formatter.field("agent_name", &self.agent_name);
formatter.field("client_token", &self.client_token);
formatter.field("instruction", &"*** Sensitive Data Redacted ***");
formatter.field("foundation_model", &self.foundation_model);
formatter.field("description", &self.description);
formatter.field("idle_session_ttl_in_seconds", &self.idle_session_ttl_in_seconds);
formatter.field("agent_resource_role_arn", &self.agent_resource_role_arn);
formatter.field("customer_encryption_key_arn", &self.customer_encryption_key_arn);
formatter.field("tags", &self.tags);
formatter.field("prompt_override_configuration", &"*** Sensitive Data Redacted ***");
formatter.finish()
}
}