Bedrock Agent  >  Operations  >  list_agent_collaborators

list_agent_collaborators

Operation

list_agent_collaborators async

list_agent_collaborators(input: ListAgentCollaboratorsInput, plugins: list[Plugin] | None = None) -> ListAgentCollaboratorsOutput

Retrieve a list of an agent's collaborators.

Parameters:

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

Input

ListAgentCollaboratorsInput dataclass

Dataclass for ListAgentCollaboratorsInput structure.

Attributes

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.

max_results class-attribute instance-attribute

max_results: int | None = None

The maximum number of agent collaborators to return in one page of results.

next_token class-attribute instance-attribute

next_token: str | None = None

Specify the pagination token from a previous request to retrieve the next page of results.

Output

ListAgentCollaboratorsOutput dataclass

Dataclass for ListAgentCollaboratorsOutput structure.

Attributes

agent_collaborator_summaries instance-attribute

agent_collaborator_summaries: list[AgentCollaboratorSummary]

A list of collaborator summaries.

next_token class-attribute instance-attribute

next_token: str | None = None

Specify the pagination token from a previous request to retrieve the next page of results.