AgentsforBedrock / Client / list_agents

list_agents#

AgentsforBedrock.Client.list_agents(**kwargs)#

Lists Agents

See also: AWS API Documentation

Request Syntax

response = client.list_agents(
    maxResults=123,
    nextToken='string'
)
Parameters:
  • maxResults (integer) – Max Results.

  • nextToken (string) – Opaque continuation token of previous paginated response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    List Agent Response

    • agentSummaries (list) –

      List of AgentSummary.

      • (dict) –

        Summary of Agent.

        • agentId (string) –

          Identifier for a resource.

        • agentName (string) –

          Name for a resource.

        • agentStatus (string) –

          Schema Type for Action APIs.

        • description (string) –

          Description of the Resource.

        • updatedAt (datetime) –

          Time Stamp.

        • latestAgentVersion (string) –

          Agent Version.

    • nextToken (string) –

      Opaque continuation token of previous paginated response.

Exceptions

  • AgentsforBedrock.Client.exceptions.ThrottlingException

  • AgentsforBedrock.Client.exceptions.AccessDeniedException

  • AgentsforBedrock.Client.exceptions.ValidationException

  • AgentsforBedrock.Client.exceptions.InternalServerException