Bedrock Agent  >  Operations  >  associate_agent_collaborator

associate_agent_collaborator

Operation

associate_agent_collaborator async

associate_agent_collaborator(input: AssociateAgentCollaboratorInput, plugins: list[Plugin] | None = None) -> AssociateAgentCollaboratorOutput

Makes an agent a collaborator for another agent.

Parameters:

Name	Type	Description	Default
input	AssociateAgentCollaboratorInput	An instance of AssociateAgentCollaboratorInput.	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
AssociateAgentCollaboratorOutput	An instance of AssociateAgentCollaboratorOutput.

Input

AssociateAgentCollaboratorInput dataclass

Dataclass for AssociateAgentCollaboratorInput structure.

Attributes

agent_descriptor class-attribute instance-attribute

agent_descriptor: AgentDescriptor | None = None

The alias of the collaborator agent.

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

An agent version.

client_token class-attribute instance-attribute

client_token: str | None = None

A client token.

collaboration_instruction class-attribute instance-attribute

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

Instruction for the collaborator.

collaborator_name class-attribute instance-attribute

collaborator_name: str | None = None

A name for the collaborator.

relay_conversation_history class-attribute instance-attribute

relay_conversation_history: RelayConversationHistory | None = None

A relay conversation history for the collaborator.

Output

AssociateAgentCollaboratorOutput dataclass

Dataclass for AssociateAgentCollaboratorOutput structure.

Attributes

agent_collaborator instance-attribute

agent_collaborator: AgentCollaborator

Details about the collaborator.