AgentsforBedrock / Client / list_agent_aliases

list_agent_aliases#

AgentsforBedrock.Client.list_agent_aliases(**kwargs)#

Lists all the Aliases for an Amazon Bedrock Agent

Request Syntax

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

Parameters:

agentId (string) –
[REQUIRED]

Id generated at the server side when an Agent is created
maxResults (integer) – Max Results.
nextToken (string) – Opaque continuation token of previous paginated 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) –
  
  Opaque continuation token of previous paginated response.

Exceptions

AgentsforBedrock.Client.exceptions.ThrottlingException
AgentsforBedrock.Client.exceptions.AccessDeniedException
AgentsforBedrock.Client.exceptions.ValidationException
AgentsforBedrock.Client.exceptions.InternalServerException
AgentsforBedrock.Client.exceptions.ResourceNotFoundException