:doc:`LexModelBuildingService <../../lex-models>` / Client / get_builtin_intents

*******************
get_builtin_intents
*******************



.. py:method:: LexModelBuildingService.Client.get_builtin_intents(**kwargs)

  

  Gets a list of built-in intents that meet the specified criteria.

   

  This operation requires permission for the ``lex:GetBuiltinIntents`` action.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/lex-models-2017-04-19/GetBuiltinIntents>`_  


  **Request Syntax**
  ::

    response = client.get_builtin_intents(
        locale='de-DE'|'en-AU'|'en-GB'|'en-IN'|'en-US'|'es-419'|'es-ES'|'es-US'|'fr-FR'|'fr-CA'|'it-IT'|'ja-JP'|'ko-KR',
        signatureContains='string',
        nextToken='string',
        maxResults=123
    )
    
  :type locale: string
  :param locale: 

    A list of locales that the intent supports.

    

  
  :type signatureContains: string
  :param signatureContains: 

    Substring to match in built-in intent signatures. An intent will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To find the signature for an intent, see `Standard Built-in Intents <https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents>`__ in the *Alexa Skills Kit*.

    

  
  :type nextToken: string
  :param nextToken: 

    A pagination token that fetches the next page of intents. If this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, use the pagination token in the next request.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of intents to return in the response. The default is 10.

    

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

    
    ::

      {
          'intents': [
              {
                  'signature': 'string',
                  'supportedLocales': [
                      'de-DE'|'en-AU'|'en-GB'|'en-IN'|'en-US'|'es-419'|'es-ES'|'es-US'|'fr-FR'|'fr-CA'|'it-IT'|'ja-JP'|'ko-KR',
                  ]
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **intents** *(list) --* 

        An array of ``builtinIntentMetadata`` objects, one for each intent in the response.

        
        

        - *(dict) --* 

          Provides metadata for a built-in intent.

          
          

          - **signature** *(string) --* 

            A unique identifier for the built-in intent. To find the signature for an intent, see `Standard Built-in Intents <https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents>`__ in the *Alexa Skills Kit*.

            
          

          - **supportedLocales** *(list) --* 

            A list of identifiers for the locales that the intent supports.

            
            

            - *(string) --* 
        
      
    
      

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

        A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token in the next request.

        
  
  **Exceptions**
  
  *   :py:class:`LexModelBuildingService.Client.exceptions.LimitExceededException`

  
  *   :py:class:`LexModelBuildingService.Client.exceptions.InternalFailureException`

  
  *   :py:class:`LexModelBuildingService.Client.exceptions.BadRequestException`

  