AgentsforBedrock / Paginator / ListAgentAliases
ListAgentAliases#
- class AgentsforBedrock.Paginator.ListAgentAliases#
paginator = client.get_paginator('list_agent_aliases')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
AgentsforBedrock.Client.list_agent_aliases()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( agentId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
agentId (string) –
[REQUIRED]
Id generated at the server side when an Agent is created
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
{ 'agentAliasSummaries': [ { 'agentAliasId': 'string', 'agentAliasName': 'string', 'description': 'string', 'routingConfiguration': [ { 'agentVersion': 'string' }, ], 'agentAliasStatus': 'CREATING'|'PREPARED'|'FAILED'|'UPDATING'|'DELETING', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' }
Response Structure
(dict) –
List Agent Aliases Response
agentAliasSummaries (list) –
The list of summaries of all the aliases for an Agent.
(dict) –
Summary of an alias for an Agent.
agentAliasId (string) –
Id for an Agent Alias generated at the server side.
agentAliasName (string) –
Name for a resource.
description (string) –
Description of the Resource.
routingConfiguration (list) –
Routing configuration for an Agent alias.
(dict) –
Details about the routing configuration for an Agent alias.
agentVersion (string) –
Agent Version.
agentAliasStatus (string) –
The statuses an Agent Alias can be in.
createdAt (datetime) –
Time Stamp.
updatedAt (datetime) –
Time Stamp.
NextToken (string) –
A token to resume pagination.