Skip to content

list_agent_collaborators

Operation

list_agent_collaborators

list_agent_collaborators(request: ListAgentCollaboratorsInput | ListAgentCollaboratorsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListAgentCollaboratorsInputDict]) -> ListAgentCollaboratorsOutput

Retrieve a list of an agent's collaborators.

Parameters:

Name Type Description Default
request ListAgentCollaboratorsInput | ListAgentCollaboratorsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListAgentCollaboratorsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListAgentCollaboratorsOutput

An instance of ListAgentCollaboratorsOutput.

list_agent_collaborators async

list_agent_collaborators(request: ListAgentCollaboratorsInput | ListAgentCollaboratorsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListAgentCollaboratorsInputDict]) -> ListAgentCollaboratorsOutput

Retrieve a list of an agent's collaborators.

Parameters:

Name Type Description Default
request ListAgentCollaboratorsInput | ListAgentCollaboratorsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListAgentCollaboratorsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListAgentCollaboratorsOutput

An instance of ListAgentCollaboratorsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListAgentCollaboratorsInputDict

Bases: TypedDict

Dictionary form of ListAgentCollaboratorsInput.

Attributes

agent_id instance-attribute
agent_id: Required[str]

The agent's ID.

agent_version instance-attribute
agent_version: Required[str]

The agent's version.

max_results instance-attribute
max_results: int | None

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

next_token instance-attribute
next_token: str | None

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

ListAgentCollaboratorsInput dataclass

Bases: _SerdeShape

Dataclass for ListAgentCollaboratorsInput structure.

Attributes

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

The agent's ID.

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

The agent's version.

max_results class-attribute instance-attribute
max_results: int | None = ...

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

next_token class-attribute instance-attribute
next_token: str | None = ...

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

Output

ListAgentCollaboratorsOutput dataclass

Bases: _SerdeShape

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 = ...

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

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.