AgentsforBedrock / Paginator / ListAgents
ListAgents¶
- class AgentsforBedrock.Paginator.ListAgents¶
paginator = client.get_paginator('list_agents')
- paginate(**kwargs)¶
Creates an iterator that will paginate through responses from
AgentsforBedrock.Client.list_agents()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- 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) –
Details about the guardrail associated with the agent.
guardrailIdentifier (string) –
The unique identifier of the guardrail.
guardrailVersion (string) –
The version of the guardrail.
latestAgentVersion (string) –
The latest version of the agent.
updatedAt (datetime) –
The time at which the agent was last updated.
NextToken (string) –
A token to resume pagination.