:doc:`LexModelsV2 <../../lexv2-models>` / Client / list_bot_aliases

****************
list_bot_aliases
****************



.. py:method:: LexModelsV2.Client.list_bot_aliases(**kwargs)

  

  Gets a list of aliases for the specified bot.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotAliases>`_  


  **Request Syntax**
  ::

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

    The identifier of the bot to list aliases for.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

    

  
  :type nextToken: string
  :param nextToken: 

    If the response from the ``ListBotAliases`` operation contains more results than specified in the ``maxResults`` parameter, a token is returned in the response. Use that token in the ``nextToken`` parameter to return the next page of results.

    

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

    
    ::

      {
          'botAliasSummaries': [
              {
                  'botAliasId': 'string',
                  'botAliasName': 'string',
                  'description': 'string',
                  'botVersion': 'string',
                  'botAliasStatus': 'Creating'|'Available'|'Deleting'|'Failed',
                  'creationDateTime': datetime(2015, 1, 1),
                  'lastUpdatedDateTime': datetime(2015, 1, 1)
              },
          ],
          'nextToken': 'string',
          'botId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **botAliasSummaries** *(list) --* 

        Summary information for the bot aliases that meet the filter criteria specified in the request. The length of the list is specified in the ``maxResults`` parameter of the request. If there are more aliases available, the ``nextToken`` field contains a token to get the next page of results.

        
        

        - *(dict) --* 

          Summary information about bot aliases returned from the `ListBotAliases <https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotAliases.html>`__ operation.

          
          

          - **botAliasId** *(string) --* 

            The unique identifier assigned to the bot alias. You can use this ID to get detailed information about the alias using the `DescribeBotAlias <https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBotAlias.html>`__ operation.

            
          

          - **botAliasName** *(string) --* 

            The name of the bot alias.

            
          

          - **description** *(string) --* 

            The description of the bot alias.

            
          

          - **botVersion** *(string) --* 

            The version of the bot that the bot alias references.

            
          

          - **botAliasStatus** *(string) --* 

            The current state of the bot alias. If the status is ``Available``, the alias is ready for use.

            
          

          - **creationDateTime** *(datetime) --* 

            A timestamp of the date and time that the bot alias was created.

            
          

          - **lastUpdatedDateTime** *(datetime) --* 

            A timestamp of the date and time that the bot alias was last updated.

            
      
    
      

      - **nextToken** *(string) --* 

        A token that indicates whether there are more results to return in a response to the ``ListBotAliases`` operation. If the ``nextToken`` field is present, you send the contents as the ``nextToken`` parameter of a ``ListBotAliases`` operation request to get the next page of results.

        
      

      - **botId** *(string) --* 

        The identifier of the bot associated with the aliases.

        
  
  **Exceptions**
  
  *   :py:class:`LexModelsV2.Client.exceptions.ThrottlingException`

  
  *   :py:class:`LexModelsV2.Client.exceptions.ServiceQuotaExceededException`

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

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

  