agent_collaborators

Creates, updates, deletes, gets or lists an agent_collaborators resource.

Overview

Name	agent_collaborators
Type	Resource
Id	aws.bedrock_agent.agent_collaborators

Fields

The following fields are returned by SELECT queries:

get_agent_collaborator

Name	Datatype	Description
agent_descriptor	object	An agent descriptor.
agent_id	string	The collaborator's agent ID. (pattern: <code>[0-9a-zA-Z]{10}</code>)
agent_version	string	The collaborator's agent version. (pattern: <code>(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})</code>)
client_token	string	The collaborator's client token. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}</code>)
collaboration_instruction	string	The collaborator's instructions.
collaborator_id	string	The collaborator's collaborator ID. (pattern: <code>[0-9a-zA-Z]{10}</code>)
collaborator_name	string	The collaborator's collaborator name. (pattern: <code>([0-9a-zA-Z][_-]?){1,100}</code>)
created_at	string (date-time)	When the collaborator was created.
last_updated_at	string (date-time)	When the collaborator was updated.
relay_conversation_history	string	The collaborator's relay conversation history. (TO_COLLABORATOR, DISABLED)

list_agent_collaborators

Name	Datatype	Description
agent_descriptor	object	An agent descriptor.
agent_id	string	The collaborator's agent ID. (pattern: <code>[0-9a-zA-Z]{10}</code>)
agent_version	string	The collaborator's agent version. (pattern: <code>(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})</code>)
collaboration_instruction	string	The collaborator's collaboration instruction.
collaborator_id	string	The collaborator's ID. (pattern: <code>[0-9a-zA-Z]{10}</code>)
collaborator_name	string	The collaborator's name. (pattern: <code>([0-9a-zA-Z][_-]?){1,100}</code>)
created_at	string (date-time)	When the collaborator was created.
last_updated_at	string (date-time)	When the collaborator was last updated.
relay_conversation_history	string	The collaborator's relay conversation history. (TO_COLLABORATOR, DISABLED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_agent_collaborator	select	agent_id, agent_version, collaborator_id, region		Retrieves information about an agent's collaborator.
list_agent_collaborators	select	agent_id, agent_version, region		Retrieve a list of an agent's collaborators.
update_agent_collaborator	update	agent_id, agent_version, collaborator_id, region, agentDescriptor, collaboratorName, collaborationInstruction		Updates an agent's collaborator.
associate_agent_collaborator	update	agent_id, agent_version, region, agentDescriptor, collaboratorName, collaborationInstruction		Makes an agent a collaborator for another agent.
disassociate_agent_collaborator	update	agent_id, agent_version, collaborator_id, region		Disassociates an agent collaborator.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
agent_id	string	An agent ID.
agent_version	string	The agent's version.
collaborator_id	string	The collaborator's ID.
region	string	AWS region (default: us-east-1)

SELECT examples

get_agent_collaborator

Retrieves information about an agent's collaborator.

SELECT
agent_descriptor,
agent_id,
agent_version,
client_token,
collaboration_instruction,
collaborator_id,
collaborator_name,
created_at,
last_updated_at,
relay_conversation_history
FROM aws.bedrock_agent.agent_collaborators
WHERE agent_id = '{{ agent_id }}' -- required
AND agent_version = '{{ agent_version }}' -- required
AND collaborator_id = '{{ collaborator_id }}' -- required
AND region = '{{ region }}' -- required
;

list_agent_collaborators

Retrieve a list of an agent's collaborators.

SELECT
agent_descriptor,
agent_id,
agent_version,
collaboration_instruction,
collaborator_id,
collaborator_name,
created_at,
last_updated_at,
relay_conversation_history
FROM aws.bedrock_agent.agent_collaborators
WHERE agent_id = '{{ agent_id }}' -- required
AND agent_version = '{{ agent_version }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_agent_collaborator

Updates an agent's collaborator.

UPDATE aws.bedrock_agent.agent_collaborators
SET 
agentDescriptor = '{{ agentDescriptor }}',
collaboratorName = '{{ collaboratorName }}',
collaborationInstruction = '{{ collaborationInstruction }}',
relayConversationHistory = '{{ relayConversationHistory }}'
WHERE 
agent_id = '{{ agent_id }}' --required
AND agent_version = '{{ agent_version }}' --required
AND collaborator_id = '{{ collaborator_id }}' --required
AND region = '{{ region }}' --required
AND agentDescriptor = '{{ agentDescriptor }}' --required
AND collaboratorName = '{{ collaboratorName }}' --required
AND collaborationInstruction = '{{ collaborationInstruction }}' --required
RETURNING
agent_collaborator;

associate_agent_collaborator

Makes an agent a collaborator for another agent.

UPDATE aws.bedrock_agent.agent_collaborators
SET 
agentDescriptor = '{{ agentDescriptor }}',
collaboratorName = '{{ collaboratorName }}',
collaborationInstruction = '{{ collaborationInstruction }}',
relayConversationHistory = '{{ relayConversationHistory }}',
clientToken = '{{ clientToken }}'
WHERE 
agent_id = '{{ agent_id }}' --required
AND agent_version = '{{ agent_version }}' --required
AND region = '{{ region }}' --required
AND agentDescriptor = '{{ agentDescriptor }}' --required
AND collaboratorName = '{{ collaboratorName }}' --required
AND collaborationInstruction = '{{ collaborationInstruction }}' --required
RETURNING
agent_collaborator;

disassociate_agent_collaborator

Disassociates an agent collaborator.

UPDATE aws.bedrock_agent.agent_collaborators
SET 
-- No updatable properties
WHERE 
agent_id = '{{ agent_id }}' --required
AND agent_version = '{{ agent_version }}' --required
AND collaborator_id = '{{ collaborator_id }}' --required
AND region = '{{ region }}' --required;