Connect / Client / create_vocabulary

create_vocabulary#

Connect.Client.create_vocabulary(**kwargs)#

Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.

See also: AWS API Documentation

Request Syntax

response = client.create_vocabulary(
    ClientToken='string',
    InstanceId='string',
    VocabularyName='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',
    Content='string',
    Tags={
        'string': 'string'
    }
)
Parameters:

  • ClientToken (string) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.

    This field is autopopulated if not provided.

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

  • VocabularyName (string) –

    [REQUIRED]

    A unique name of the custom vocabulary.

  • LanguageCode (string) –

    [REQUIRED]

    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

  • Content (string) –

    [REQUIRED]

    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. The size limit is 50KB. 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) –

Return type:

dict

Returns:

Response Syntax

{
    'VocabularyArn': 'string',
    'VocabularyId': 'string',
    'State': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED'|'DELETE_IN_PROGRESS'
}

Response Structure

  • (dict) –

    • VocabularyArn (string) –

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

    • VocabularyId (string) –

      The identifier of the custom vocabulary.

    • State (string) –

      The current state of the custom vocabulary.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.InternalServiceException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.AccessDeniedException

  • Connect.Client.exceptions.ResourceConflictException

  • Connect.Client.exceptions.ServiceQuotaExceededException