:doc:`AgentsforBedrock <../../bedrock-agent>` / Client / list_agent_aliases

******************
list_agent_aliases
******************



.. py:method:: AgentsforBedrock.Client.list_agent_aliases(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentAliases>`_  


  **Request Syntax**
  ::

    response = client.list_agent_aliases(
        agentId='string',
        maxResults=123,
        nextToken='string'
    )
    
  :type agentId: string
  :param agentId: **[REQUIRED]** 

    The unique identifier of the agent.

    

  
  :type maxResults: integer
  :param maxResults: 

    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.

    

  
  :type nextToken: string
  :param nextToken: 

    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.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'agentAliasSummaries': [
              {
                  'agentAliasId': 'string',
                  'agentAliasName': 'string',
                  'description': 'string',
                  'routingConfiguration': [
                      {
                          'agentVersion': 'string',
                          'provisionedThroughput': 'string'
                      },
                  ],
                  'agentAliasStatus': 'CREATING'|'PREPARED'|'FAILED'|'UPDATING'|'DELETING'|'DISSOCIATED',
                  'createdAt': datetime(2015, 1, 1),
                  'updatedAt': datetime(2015, 1, 1),
                  'aliasInvocationState': 'ACCEPT_INVOCATIONS'|'REJECT_INVOCATIONS'
              },
          ],
          '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.

            
          

          - **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.

                
          
        
          

          - **agentAliasStatus** *(string) --* 

            The status of the alias.

            
          

          - **createdAt** *(datetime) --* 

            The time at which the alias of the agent was created.

            
          

          - **updatedAt** *(datetime) --* 

            The time at which the alias was last updated.

            
          

          - **aliasInvocationState** *(string) --* 

            The invocation state for the agent alias. If the agent alias is running, the value is ``ACCEPT_INVOCATIONS``. If the agent alias is paused, the value is ``REJECT_INVOCATIONS``. Use the ``UpdateAgentAlias`` operation to change the invocation state.

            
      
    
      

      - **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**
  
  *   :py:class:`AgentsforBedrock.Client.exceptions.ThrottlingException`

  
  *   :py:class:`AgentsforBedrock.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`AgentsforBedrock.Client.exceptions.ValidationException`

  
  *   :py:class:`AgentsforBedrock.Client.exceptions.InternalServerException`

  
  *   :py:class:`AgentsforBedrock.Client.exceptions.ResourceNotFoundException`

  