Skip to content

Bedrock Agent  >  Operations  >  update_agent_collaborator

update_agent_collaborator

Operation

update_agent_collaborator async

update_agent_collaborator(input: UpdateAgentCollaboratorInput, plugins: list[Plugin] | None = None) -> UpdateAgentCollaboratorOutput

Updates an agent's collaborator.

Parameters:

Name Type Description Default
input UpdateAgentCollaboratorInput

An instance of UpdateAgentCollaboratorInput.

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
UpdateAgentCollaboratorOutput

An instance of UpdateAgentCollaboratorOutput.

Input

UpdateAgentCollaboratorInput dataclass

Dataclass for UpdateAgentCollaboratorInput structure.

Attributes

agent_descriptor class-attribute instance-attribute
agent_descriptor: AgentDescriptor | None = None

An agent descriptor for the agent collaborator.

agent_id class-attribute instance-attribute
agent_id: str | None = None

The agent's ID.

agent_version class-attribute instance-attribute
agent_version: str | None = None

The agent's version.

collaboration_instruction class-attribute instance-attribute
collaboration_instruction: str | None = field(repr=False, default=None)

Instruction for the collaborator.

collaborator_id class-attribute instance-attribute
collaborator_id: str | None = None

The collaborator's ID.

collaborator_name class-attribute instance-attribute
collaborator_name: str | None = None

The collaborator's name.

relay_conversation_history class-attribute instance-attribute
relay_conversation_history: RelayConversationHistory | None = None

A relay conversation history for the collaborator.

Output

UpdateAgentCollaboratorOutput dataclass

Dataclass for UpdateAgentCollaboratorOutput structure.

Attributes

agent_collaborator instance-attribute
agent_collaborator: AgentCollaborator

Details about the collaborator.