aws_sdk_bedrockagent/operation/create_agent/_create_agent_input.rs
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 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
// 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 identifier for the model that you want to be used for orchestration by the agent you create.</p>
/// <p>The <code>modelId</code> to provide depends on the type of model or throughput that you use:</p>
/// <ul>
/// <li>
/// <p>If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">Amazon Bedrock base model IDs (on-demand throughput)</a> in the Amazon Bedrock User Guide.</p></li>
/// <li>
/// <p>If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html">Supported Regions and models for cross-region inference</a> in the Amazon Bedrock User Guide.</p></li>
/// <li>
/// <p>If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html">Run inference using a Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p></li>
/// <li>
/// <p>If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html">Use a custom model in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p></li>
/// <li>
/// <p>If you use an <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html">imported model</a>, specify the ARN of the imported model. You can get the model ARN from a successful call to <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html">CreateModelImportJob</a> or from the Imported models page in the Amazon Bedrock console.</p></li>
/// </ul>
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>Specifies the type of orchestration strategy for the agent. This is set to <code>DEFAULT</code> orchestration type, by default.</p>
pub orchestration_type: ::std::option::Option<crate::types::OrchestrationType>,
/// <p>Contains details of the custom orchestration configured for the agent.</p>
pub custom_orchestration: ::std::option::Option<crate::types::CustomOrchestration>,
/// <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 Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.</p>
pub agent_resource_role_arn: ::std::option::Option<::std::string::String>,
/// <p>The Amazon Resource Name (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>,
/// <p>The unique Guardrail configuration assigned to the agent when it is created.</p>
pub guardrail_configuration: ::std::option::Option<crate::types::GuardrailConfiguration>,
/// <p>Contains the details of the memory configured for the agent.</p>
pub memory_configuration: ::std::option::Option<crate::types::MemoryConfiguration>,
/// <p>The agent's collaboration role.</p>
pub agent_collaboration: ::std::option::Option<crate::types::AgentCollaboration>,
}
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 identifier for the model that you want to be used for orchestration by the agent you create.</p>
/// <p>The <code>modelId</code> to provide depends on the type of model or throughput that you use:</p>
/// <ul>
/// <li>
/// <p>If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">Amazon Bedrock base model IDs (on-demand throughput)</a> in the Amazon Bedrock User Guide.</p></li>
/// <li>
/// <p>If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html">Supported Regions and models for cross-region inference</a> in the Amazon Bedrock User Guide.</p></li>
/// <li>
/// <p>If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html">Run inference using a Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p></li>
/// <li>
/// <p>If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html">Use a custom model in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p></li>
/// <li>
/// <p>If you use an <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html">imported model</a>, specify the ARN of the imported model. You can get the model ARN from a successful call to <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html">CreateModelImportJob</a> or from the Imported models page in the Amazon Bedrock console.</p></li>
/// </ul>
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>Specifies the type of orchestration strategy for the agent. This is set to <code>DEFAULT</code> orchestration type, by default.</p>
pub fn orchestration_type(&self) -> ::std::option::Option<&crate::types::OrchestrationType> {
self.orchestration_type.as_ref()
}
/// <p>Contains details of the custom orchestration configured for the agent.</p>
pub fn custom_orchestration(&self) -> ::std::option::Option<&crate::types::CustomOrchestration> {
self.custom_orchestration.as_ref()
}
/// <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 Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.</p>
pub fn agent_resource_role_arn(&self) -> ::std::option::Option<&str> {
self.agent_resource_role_arn.as_deref()
}
/// <p>The Amazon Resource Name (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()
}
/// <p>The unique Guardrail configuration assigned to the agent when it is created.</p>
pub fn guardrail_configuration(&self) -> ::std::option::Option<&crate::types::GuardrailConfiguration> {
self.guardrail_configuration.as_ref()
}
/// <p>Contains the details of the memory configured for the agent.</p>
pub fn memory_configuration(&self) -> ::std::option::Option<&crate::types::MemoryConfiguration> {
self.memory_configuration.as_ref()
}
/// <p>The agent's collaboration role.</p>
pub fn agent_collaboration(&self) -> ::std::option::Option<&crate::types::AgentCollaboration> {
self.agent_collaboration.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("orchestration_type", &self.orchestration_type);
formatter.field("custom_orchestration", &self.custom_orchestration);
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.field("guardrail_configuration", &self.guardrail_configuration);
formatter.field("memory_configuration", &self.memory_configuration);
formatter.field("agent_collaboration", &self.agent_collaboration);
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).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
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) orchestration_type: ::std::option::Option<crate::types::OrchestrationType>,
pub(crate) custom_orchestration: ::std::option::Option<crate::types::CustomOrchestration>,
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>,
pub(crate) guardrail_configuration: ::std::option::Option<crate::types::GuardrailConfiguration>,
pub(crate) memory_configuration: ::std::option::Option<crate::types::MemoryConfiguration>,
pub(crate) agent_collaboration: ::std::option::Option<crate::types::AgentCollaboration>,
}
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 identifier for the model that you want to be used for orchestration by the agent you create.</p>
/// <p>The <code>modelId</code> to provide depends on the type of model or throughput that you use:</p>
/// <ul>
/// <li>
/// <p>If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">Amazon Bedrock base model IDs (on-demand throughput)</a> in the Amazon Bedrock User Guide.</p></li>
/// <li>
/// <p>If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html">Supported Regions and models for cross-region inference</a> in the Amazon Bedrock User Guide.</p></li>
/// <li>
/// <p>If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html">Run inference using a Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p></li>
/// <li>
/// <p>If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html">Use a custom model in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p></li>
/// <li>
/// <p>If you use an <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html">imported model</a>, specify the ARN of the imported model. You can get the model ARN from a successful call to <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html">CreateModelImportJob</a> or from the Imported models page in the Amazon Bedrock console.</p></li>
/// </ul>
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 identifier for the model that you want to be used for orchestration by the agent you create.</p>
/// <p>The <code>modelId</code> to provide depends on the type of model or throughput that you use:</p>
/// <ul>
/// <li>
/// <p>If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">Amazon Bedrock base model IDs (on-demand throughput)</a> in the Amazon Bedrock User Guide.</p></li>
/// <li>
/// <p>If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html">Supported Regions and models for cross-region inference</a> in the Amazon Bedrock User Guide.</p></li>
/// <li>
/// <p>If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html">Run inference using a Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p></li>
/// <li>
/// <p>If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html">Use a custom model in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p></li>
/// <li>
/// <p>If you use an <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html">imported model</a>, specify the ARN of the imported model. You can get the model ARN from a successful call to <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html">CreateModelImportJob</a> or from the Imported models page in the Amazon Bedrock console.</p></li>
/// </ul>
pub fn set_foundation_model(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.foundation_model = input;
self
}
/// <p>The identifier for the model that you want to be used for orchestration by the agent you create.</p>
/// <p>The <code>modelId</code> to provide depends on the type of model or throughput that you use:</p>
/// <ul>
/// <li>
/// <p>If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">Amazon Bedrock base model IDs (on-demand throughput)</a> in the Amazon Bedrock User Guide.</p></li>
/// <li>
/// <p>If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html">Supported Regions and models for cross-region inference</a> in the Amazon Bedrock User Guide.</p></li>
/// <li>
/// <p>If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html">Run inference using a Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p></li>
/// <li>
/// <p>If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html">Use a custom model in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p></li>
/// <li>
/// <p>If you use an <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html">imported model</a>, specify the ARN of the imported model. You can get the model ARN from a successful call to <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html">CreateModelImportJob</a> or from the Imported models page in the Amazon Bedrock console.</p></li>
/// </ul>
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>Specifies the type of orchestration strategy for the agent. This is set to <code>DEFAULT</code> orchestration type, by default.</p>
pub fn orchestration_type(mut self, input: crate::types::OrchestrationType) -> Self {
self.orchestration_type = ::std::option::Option::Some(input);
self
}
/// <p>Specifies the type of orchestration strategy for the agent. This is set to <code>DEFAULT</code> orchestration type, by default.</p>
pub fn set_orchestration_type(mut self, input: ::std::option::Option<crate::types::OrchestrationType>) -> Self {
self.orchestration_type = input;
self
}
/// <p>Specifies the type of orchestration strategy for the agent. This is set to <code>DEFAULT</code> orchestration type, by default.</p>
pub fn get_orchestration_type(&self) -> &::std::option::Option<crate::types::OrchestrationType> {
&self.orchestration_type
}
/// <p>Contains details of the custom orchestration configured for the agent.</p>
pub fn custom_orchestration(mut self, input: crate::types::CustomOrchestration) -> Self {
self.custom_orchestration = ::std::option::Option::Some(input);
self
}
/// <p>Contains details of the custom orchestration configured for the agent.</p>
pub fn set_custom_orchestration(mut self, input: ::std::option::Option<crate::types::CustomOrchestration>) -> Self {
self.custom_orchestration = input;
self
}
/// <p>Contains details of the custom orchestration configured for the agent.</p>
pub fn get_custom_orchestration(&self) -> &::std::option::Option<crate::types::CustomOrchestration> {
&self.custom_orchestration
}
/// <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 Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.</p>
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 Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.</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 Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.</p>
pub fn get_agent_resource_role_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.agent_resource_role_arn
}
/// <p>The Amazon Resource Name (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 Amazon Resource Name (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 Amazon Resource Name (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
}
/// <p>The unique Guardrail configuration assigned to the agent when it is created.</p>
pub fn guardrail_configuration(mut self, input: crate::types::GuardrailConfiguration) -> Self {
self.guardrail_configuration = ::std::option::Option::Some(input);
self
}
/// <p>The unique Guardrail configuration assigned to the agent when it is created.</p>
pub fn set_guardrail_configuration(mut self, input: ::std::option::Option<crate::types::GuardrailConfiguration>) -> Self {
self.guardrail_configuration = input;
self
}
/// <p>The unique Guardrail configuration assigned to the agent when it is created.</p>
pub fn get_guardrail_configuration(&self) -> &::std::option::Option<crate::types::GuardrailConfiguration> {
&self.guardrail_configuration
}
/// <p>Contains the details of the memory configured for the agent.</p>
pub fn memory_configuration(mut self, input: crate::types::MemoryConfiguration) -> Self {
self.memory_configuration = ::std::option::Option::Some(input);
self
}
/// <p>Contains the details of the memory configured for the agent.</p>
pub fn set_memory_configuration(mut self, input: ::std::option::Option<crate::types::MemoryConfiguration>) -> Self {
self.memory_configuration = input;
self
}
/// <p>Contains the details of the memory configured for the agent.</p>
pub fn get_memory_configuration(&self) -> &::std::option::Option<crate::types::MemoryConfiguration> {
&self.memory_configuration
}
/// <p>The agent's collaboration role.</p>
pub fn agent_collaboration(mut self, input: crate::types::AgentCollaboration) -> Self {
self.agent_collaboration = ::std::option::Option::Some(input);
self
}
/// <p>The agent's collaboration role.</p>
pub fn set_agent_collaboration(mut self, input: ::std::option::Option<crate::types::AgentCollaboration>) -> Self {
self.agent_collaboration = input;
self
}
/// <p>The agent's collaboration role.</p>
pub fn get_agent_collaboration(&self) -> &::std::option::Option<crate::types::AgentCollaboration> {
&self.agent_collaboration
}
/// 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,
orchestration_type: self.orchestration_type,
custom_orchestration: self.custom_orchestration,
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,
guardrail_configuration: self.guardrail_configuration,
memory_configuration: self.memory_configuration,
agent_collaboration: self.agent_collaboration,
})
}
}
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("orchestration_type", &self.orchestration_type);
formatter.field("custom_orchestration", &self.custom_orchestration);
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.field("guardrail_configuration", &self.guardrail_configuration);
formatter.field("memory_configuration", &self.memory_configuration);
formatter.field("agent_collaboration", &self.agent_collaboration);
formatter.finish()
}
}