Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . connect ]

create-vocabulary

Description

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

See 'aws help' for descriptions of global parameters.

Synopsis

  create-vocabulary
[--client-token <value>]
--instance-id <value>
--vocabulary-name <value>
--language-code <value>
--content <value>
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.

--instance-id (string)

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

--vocabulary-name (string)

A unique name of the custom vocabulary.

--language-code (string)

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

Possible values:

  • 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

--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. The size limit is 50KB. For more information, see Create a custom vocabulary using a table .

--tags (map)

The tags used to organize, track, or control access for this resource.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

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.