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', '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) –
A token to resume pagination.