SearchVocabularies

class Connect.Paginator.SearchVocabularies

paginator = client.get_paginator('search_vocabularies')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.search_vocabularies().

See also: AWS API Documentation

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',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

• InstanceId (string) --

  [REQUIRED]

  The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

• State (string) -- The current state of the custom vocabulary.
• NameStartsWith (string) -- The starting pattern of the name of the 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?
• PaginationConfig (dict) --

  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.

Return type

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',
            '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?

      • 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.