CreateVocabularyCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ConnectClient, CreateVocabularyCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, CreateVocabularyCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // CreateVocabularyRequest
  ClientToken: "STRING_VALUE",
  InstanceId: "STRING_VALUE", // required
  VocabularyName: "STRING_VALUE", // required
  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", // required
  Content: "STRING_VALUE", // required
  Tags: { // TagMap
    "<keys>": "STRING_VALUE",
  },
};
const command = new CreateVocabularyCommand(input);
const response = await client.send(command);
// { // CreateVocabularyResponse
//   VocabularyArn: "STRING_VALUE", // required
//   VocabularyId: "STRING_VALUE", // required
//   State: "CREATION_IN_PROGRESS" || "ACTIVE" || "CREATION_FAILED" || "DELETE_IN_PROGRESS", // required
// };

CreateVocabularyCommand Input

See CreateVocabularyCommandInput for more details

Parameter
Type
Description
Content
Required
string | undefined

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 .

InstanceId
Required
string | undefined

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

LanguageCode
Required
VocabularyLanguageCode | undefined

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

VocabularyName
Required
string | undefined

A unique name of the custom vocabulary.

ClientToken
string | undefined

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.

Tags
Record<string, string> | undefined

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

CreateVocabularyCommand Output

See CreateVocabularyCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
State
Required
VocabularyState | undefined

The current state of the custom vocabulary.

VocabularyArn
Required
string | undefined

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

VocabularyId
Required
string | undefined

The identifier of the custom vocabulary.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient permissions to perform this action.

InternalServiceException
server

Request processing failed because of an error or failure with the service.

InvalidRequestException
client

The request is not valid.

ResourceConflictException
client

A resource already has that name.

ResourceNotFoundException
client

The specified resource was not found.

ServiceQuotaExceededException
client

The service quota has been exceeded.

ThrottlingException
client

The throttling limit has been exceeded.

ConnectServiceException
Base exception class for all service exceptions from Connect service.