AgentsforBedrock / Client / list_agent_aliases

list_agent_aliases#

AgentsforBedrock.Client.list_agent_aliases(**kwargs)#

Lists the aliases of an agent and information about each one.

Request Syntax

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

Parameters:

agentId (string) –
[REQUIRED]

The unique identifier of the agent.
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

{
    'agentAliasSummaries': [
        {
            'agentAliasId': 'string',
            'agentAliasName': 'string',
            'agentAliasStatus': 'CREATING'|'PREPARED'|'FAILED'|'UPDATING'|'DELETING',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'routingConfiguration': [
                {
                    'agentVersion': 'string',
                    'provisionedThroughput': 'string'
                },
            ],
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- agentAliasSummaries (list) –
  
  A list of objects, each of which contains information about an alias of the agent.
  - (dict) –
    
    Contains details about an alias of an agent.
    - agentAliasId (string) –
      
      Contains details about
    - agentAliasName (string) –
      
      The name of the alias.
    - agentAliasStatus (string) –
      
      The status of the alias.
    - createdAt (datetime) –
      
      The time at which the alias of the agent was created.
    - description (string) –
      
      The description of the alias.
    - routingConfiguration (list) –
      
      Contains details about the version of the agent with which the alias is associated.
      - (dict) –
        
        Contains details about the routing configuration of the alias.
        
        agentVersion (string) –
        
        The version of the agent with which the alias is associated.
        
        provisionedThroughput (string) –
        
        Information on the Provisioned Throughput assigned to an agent alias.
    - updatedAt (datetime) –
      
      The time at which the alias 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
AgentsforBedrock.Client.exceptions.ResourceNotFoundException