Connect / Client / search_vocabularies

search_vocabularies#

Connect.Client.search_vocabularies(**kwargs)#

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

See also: AWS API Documentation

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'
)
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.

  • MaxResults (integer) – The maximum number of results to return per page.

  • NextToken (string) – 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.

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

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

        • 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

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InternalServiceException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.AccessDeniedException