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

*********************
list_built_in_intents
*********************



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

  

  Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.

   

  To use a built-in intent as a the base for your own intent, include the built-in intent signature in the ``parentIntentSignature`` parameter when you call the ``CreateIntent`` operation. For more information, see `CreateIntent <https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateIntent.html>`__.

  

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


  **Request Syntax**
  ::

    response = client.list_built_in_intents(
        localeId='string',
        sortBy={
            'attribute': 'IntentSignature',
            'order': 'Ascending'|'Descending'
        },
        maxResults=123,
        nextToken='string'
    )
    
  :type localeId: string
  :param localeId: **[REQUIRED]** 

    The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see `Supported languages <https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html>`__.

    

  
  :type sortBy: dict
  :param sortBy: 

    Specifies sorting parameters for the list of built-in intents. You can specify that the list be sorted by the built-in intent signature in either ascending or descending order.

    

  
    - **attribute** *(string) --* **[REQUIRED]** 

      The attribute to use to sort the list of built-in intents.

      

    
    - **order** *(string) --* **[REQUIRED]** 

      The order to sort the list. You can specify ascending or descending order.

      

    
  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of built-in intents 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 ``ListBuiltInIntents`` 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**

    
    ::

      {
          'builtInIntentSummaries': [
              {
                  'intentSignature': 'string',
                  'description': 'string'
              },
          ],
          'nextToken': 'string',
          'localeId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **builtInIntentSummaries** *(list) --* 

        Summary information for the built-in intents 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 intents available, the ``nextToken`` field contains a token to get the next page of results.

        
        

        - *(dict) --* 

          Provides summary information about a built-in intent for the `ListBuiltInIntents <https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBuiltInIntents.html>`__ operation.

          
          

          - **intentSignature** *(string) --* 

            The signature of the built-in intent. Use this to specify the parent intent of a derived intent.

            
          

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

            The description of the intent.

            
      
    
      

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

        A token that indicates whether there are more results to return in a response to the ``ListBuiltInIntents`` 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.

        
      

      - **localeId** *(string) --* 

        The language and locale of the intents in the list.

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

  