list_agents#

AgentsforBedrock.Client.list_agents(**kwargs)#

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

Request Syntax

response = client.list_agents(
    maxResults=123,
    nextToken='string'
)

Parameters:

maxResults (integer) – 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.
nextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'agentSummaries': [
        {
            'agentId': 'string',
            'agentName': 'string',
            'agentStatus': 'CREATING'|'PREPARING'|'PREPARED'|'NOT_PREPARED'|'DELETING'|'FAILED'|'VERSIONING'|'UPDATING',
            'description': 'string',
            'guardrailConfiguration': {
                'guardrailIdentifier': 'string',
                'guardrailVersion': 'string'
            },
            'latestAgentVersion': 'string',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- agentSummaries (list) –
  
  A list of objects, each of which contains information about an agent.
  - (dict) –
    
    Contains details about an agent.
    - agentId (string) –
      
      The unique identifier of the agent.
    - agentName (string) –
      
      The name of the agent.
    - agentStatus (string) –
      
      The status of the agent.
    - description (string) –
      
      The description of the agent.
    - guardrailConfiguration (dict) –
      
      The details of the guardrails configuration in the agent summary.
      - guardrailIdentifier (string) –
        
        The guardrails identifier assigned to the guardrails configuration.
      - guardrailVersion (string) –
        
        The guardrails version assigned to the guardrails configuration.
    - latestAgentVersion (string) –
      
      The latest version of the agent.
    - updatedAt (datetime) –
      
      The time at which the agent was last updated.
- nextToken (string) –
  
  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.

Exceptions

AgentsforBedrock.Client.exceptions.ThrottlingException
AgentsforBedrock.Client.exceptions.AccessDeniedException
AgentsforBedrock.Client.exceptions.ValidationException
AgentsforBedrock.Client.exceptions.InternalServerException