Struct UpdateAgentInput 

#[non_exhaustive]
pub struct UpdateAgentInput {

    pub agent_id: Option<String>,
    pub agent_name: Option<String>,
    pub instruction: Option<String>,
    pub foundation_model: Option<String>,
    pub description: Option<String>,
    pub orchestration_type: Option<OrchestrationType>,
    pub custom_orchestration: Option<CustomOrchestration>,
    pub idle_session_ttl_in_seconds: Option<i32>,
    pub agent_resource_role_arn: Option<String>,
    pub customer_encryption_key_arn: Option<String>,
    pub prompt_override_configuration: Option<PromptOverrideConfiguration>,
    pub guardrail_configuration: Option<GuardrailConfiguration>,
    pub memory_configuration: Option<MemoryConfiguration>,
    pub agent_collaboration: Option<AgentCollaboration>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

agent_id: Option<String>

The unique identifier of the agent.

agent_name: Option<String>

Specifies a new name for the agent.

instruction: Option<String>

Specifies new instructions that tell the agent what it should do and how it should interact with users.

foundation_model: Option<String>

The identifier for the model that you want to be used for orchestration by the agent you create.

The modelId to provide depends on the type of model or throughput that you use:

• If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.

• If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.

• If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.

• 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 Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.

• If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.

description: Option<String>

Specifies a new description of the agent.

orchestration_type: Option<OrchestrationType>

Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.

custom_orchestration: Option<CustomOrchestration>

Contains details of the custom orchestration configured for the agent.

idle_session_ttl_in_seconds: Option<i32>

The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

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.

agent_resource_role_arn: Option<String>

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

customer_encryption_key_arn: Option<String>

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

prompt_override_configuration: Option<PromptOverrideConfiguration>

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

guardrail_configuration: Option<GuardrailConfiguration>

The unique Guardrail configuration assigned to the agent when it is updated.

memory_configuration: Option<MemoryConfiguration>

Specifies the new memory configuration for the agent.

agent_collaboration: Option<AgentCollaboration>

The agent's collaboration role.

Implementations

impl UpdateAgentInput

pub fn agent_id(&self) -> Option<&str>

The unique identifier of the agent.

pub fn agent_name(&self) -> Option<&str>

Specifies a new name for the agent.

pub fn instruction(&self) -> Option<&str>

Specifies new instructions that tell the agent what it should do and how it should interact with users.

pub fn foundation_model(&self) -> Option<&str>

The identifier for the model that you want to be used for orchestration by the agent you create.

The modelId to provide depends on the type of model or throughput that you use:

• If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.

• If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.

• If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.

• 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 Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.

• If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.

pub fn description(&self) -> Option<&str>

Specifies a new description of the agent.

pub fn orchestration_type(&self) -> Option<&OrchestrationType>

Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.

pub fn custom_orchestration(&self) -> Option<&CustomOrchestration>

Contains details of the custom orchestration configured for the agent.

pub fn idle_session_ttl_in_seconds(&self) -> Option<i32>

The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

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.

pub fn agent_resource_role_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

pub fn customer_encryption_key_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

pub fn prompt_override_configuration( &self, ) -> Option<&PromptOverrideConfiguration>

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

pub fn guardrail_configuration(&self) -> Option<&GuardrailConfiguration>

The unique Guardrail configuration assigned to the agent when it is updated.

pub fn memory_configuration(&self) -> Option<&MemoryConfiguration>

Specifies the new memory configuration for the agent.

pub fn agent_collaboration(&self) -> Option<&AgentCollaboration>

The agent's collaboration role.

impl UpdateAgentInput

pub fn builder() -> UpdateAgentInputBuilder

Creates a new builder-style object to manufacture UpdateAgentInput.

Trait Implementations

impl Clone for UpdateAgentInput

fn clone(&self) -> UpdateAgentInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateAgentInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for UpdateAgentInput

fn eq(&self, other: &UpdateAgentInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateAgentInput