:doc:`Connect <../../connect>` / Paginator / SearchVocabularies

******************
SearchVocabularies
******************



.. py:class:: Connect.Paginator.SearchVocabularies

  ::

    
    paginator = client.get_paginator('search_vocabularies')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Connect.Client.search_vocabularies`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          InstanceId='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',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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 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>`__

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :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'
                },
            ],
            
        }
        
      **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.

              
        
      
    