Bedrock Agent  >  Operations  >  update_agent

update_agent

Operation

update_agent async

update_agent(input: UpdateAgentInput, plugins: list[Plugin] | None = None) -> UpdateAgentOutput

Updates the configuration of an agent.

Parameters:

Name	Type	Description	Default
input	UpdateAgentInput	An instance of UpdateAgentInput.	required
plugins	list[Plugin] | None	A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.	None

Returns:

Type	Description
UpdateAgentOutput	An instance of UpdateAgentOutput.

Input

UpdateAgentInput dataclass

Dataclass for UpdateAgentInput structure.

Attributes

agent_collaboration class-attribute instance-attribute

agent_collaboration: AgentCollaboration | None = None

The agent's collaboration role.

agent_id class-attribute instance-attribute

agent_id: str | None = None

The unique identifier of the agent.

agent_name class-attribute instance-attribute

agent_name: str | None = None

Specifies a new name for the agent.

agent_resource_role_arn class-attribute instance-attribute

agent_resource_role_arn: str | None = None

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

custom_orchestration class-attribute instance-attribute

custom_orchestration: CustomOrchestration | None = None

Contains details of the custom orchestration configured for the agent.

customer_encryption_key_arn class-attribute instance-attribute

customer_encryption_key_arn: str | None = None

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

description class-attribute instance-attribute

description: str | None = None

Specifies a new description of the agent.

foundation_model class-attribute instance-attribute

foundation_model: str | None = None

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.

guardrail_configuration class-attribute instance-attribute

guardrail_configuration: GuardrailConfiguration | None = None

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

idle_session_ttl_in_seconds class-attribute instance-attribute

idle_session_ttl_in_seconds: int | None = None

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.

instruction class-attribute instance-attribute

instruction: str | None = field(repr=False, default=None)

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

memory_configuration class-attribute instance-attribute

memory_configuration: MemoryConfiguration | None = None

Specifies the new memory configuration for the agent.

orchestration_type class-attribute instance-attribute

orchestration_type: OrchestrationType | None = None

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

prompt_override_configuration class-attribute instance-attribute

prompt_override_configuration: PromptOverrideConfiguration | None = field(repr=False, default=None)

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

Output

UpdateAgentOutput dataclass

Dataclass for UpdateAgentOutput structure.

Attributes

agent instance-attribute

agent: Agent

Contains details about the agent that was updated.