Skip to content

Bedrock Agent  >  Operations  >  list_agents

list_agents

Operation

list_agents async 

list_agents(input: ListAgentsInput, plugins: list[Plugin] | None = None) -> ListAgentsOutput

Lists the agents belonging to an account and information about each agent.

Parameters:

Name Type Description Default
input ListAgentsInput

An instance of ListAgentsInput.

 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
ListAgentsOutput

An instance of ListAgentsOutput.

Input

ListAgentsInput dataclass

Dataclass for ListAgentsInput structure.

Attributes

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

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

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

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Output

ListAgentsOutput dataclass

Dataclass for ListAgentsOutput structure.

Attributes

agent_summaries instance-attribute 
agent_summaries: list[AgentSummary]

A list of objects, each of which contains information about an agent.

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

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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.