:doc:`Connect <../../connect>` / Client / search_vocabularies

*******************
search_vocabularies
*******************



.. py:method:: Connect.Client.search_vocabularies(**kwargs)

  

  Searches for vocabularies within a specific Amazon Connect instance using ``State``, ``NameStartsWith``, and ``LanguageCode``.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchVocabularies>`_  


  **Request Syntax**
  ::

    response = client.search_vocabularies(
        InstanceId='string',
        MaxResults=123,
        NextToken='string',
        State='CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED'|'DELETE_IN_PROGRESS',
        NameStartsWith='string',
        LanguageCode='ar-AE'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fr-CA'|'fr-FR'|'hi-IN'|'it-IT'|'ja-JP'|'ko-KR'|'pt-BR'|'pt-PT'|'zh-CN'|'en-NZ'|'en-ZA'|'ca-ES'|'da-DK'|'fi-FI'|'id-ID'|'ms-MY'|'nl-NL'|'no-NO'|'pl-PL'|'sv-SE'|'tl-PH'
    )
    
  :type InstanceId: string
  :param InstanceId: **[REQUIRED]** 

    The identifier of the Amazon Connect instance. You can `find the instance ID <https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html>`__ in the Amazon Resource Name (ARN) of the instance.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return per page.

    

  
  :type NextToken: string
  :param NextToken: 

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    

  
  :type State: string
  :param State: 

    The current state of the custom vocabulary.

    

  
  :type NameStartsWith: string
  :param NameStartsWith: 

    The starting pattern of the name of the vocabulary.

    

  
  :type LanguageCode: string
  :param LanguageCode: 

    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see `What is Amazon Transcribe? <https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html>`__

    

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

    
    ::

      {
          'VocabularySummaryList': [
              {
                  'Name': 'string',
                  'Id': 'string',
                  'Arn': 'string',
                  'LanguageCode': 'ar-AE'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fr-CA'|'fr-FR'|'hi-IN'|'it-IT'|'ja-JP'|'ko-KR'|'pt-BR'|'pt-PT'|'zh-CN'|'en-NZ'|'en-ZA'|'ca-ES'|'da-DK'|'fi-FI'|'id-ID'|'ms-MY'|'nl-NL'|'no-NO'|'pl-PL'|'sv-SE'|'tl-PH',
                  'State': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED'|'DELETE_IN_PROGRESS',
                  'LastModifiedTime': datetime(2015, 1, 1),
                  'FailureReason': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **VocabularySummaryList** *(list) --* 

        The list of the available custom vocabularies.

        
        

        - *(dict) --* 

          Contains summary information about the custom vocabulary.

          
          

          - **Name** *(string) --* 

            A unique name of the custom vocabulary.

            
          

          - **Id** *(string) --* 

            The identifier of the custom vocabulary.

            
          

          - **Arn** *(string) --* 

            The Amazon Resource Name (ARN) of the custom vocabulary.

            
          

          - **LanguageCode** *(string) --* 

            The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see `What is Amazon Transcribe? <https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html>`__

            
          

          - **State** *(string) --* 

            The current state of the custom vocabulary.

            
          

          - **LastModifiedTime** *(datetime) --* 

            The timestamp when the custom vocabulary was last modified.

            
          

          - **FailureReason** *(string) --* 

            The reason why the custom vocabulary was not created.

            
      
    
      

      - **NextToken** *(string) --* 

        If there are additional results, this is the token for the next set of results.

        
  
  **Exceptions**
  
  *   :py:class:`Connect.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`Connect.Client.exceptions.InternalServiceException`

  
  *   :py:class:`Connect.Client.exceptions.ThrottlingException`

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

  