Connect / Client / describe_vocabulary

describe_vocabulary#

Connect.Client.describe_vocabulary(**kwargs)#

Describes the specified vocabulary.

See also: AWS API Documentation

Request Syntax

response = client.describe_vocabulary(
    InstanceId='string',
    VocabularyId='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.

  • VocabularyId (string) –

    [REQUIRED]

    The identifier of the custom vocabulary.

Return type:

dict

Returns:

Response Syntax

{
    'Vocabulary': {
        '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',
        'Content': 'string',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • Vocabulary (dict) –

      A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They are generally domain-specific words and phrases, words that Contact Lens is not recognizing, or proper nouns.

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

      • Content (string) –

        The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. For more information, see Create a custom vocabulary using a table.

      • Tags (dict) –

        The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:”value1”, “key2”:”value2”} }.

        • (string) –

          • (string) –

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.InternalServiceException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.AccessDeniedException