[ aws . transcribe ]

update-vocabulary

Description

Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites all of the existing information with the values that you provide in the request.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-vocabulary
--vocabulary-name <value>
--language-code <value>
[--phrases <value>]
[--vocabulary-file-uri <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--vocabulary-name (string)

The name of the vocabulary to update. The name is case sensitive. If you try to update a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.

--language-code (string)

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see Supported languages .

Possible values:

• af-ZA

• ar-AE

• ar-SA

• cy-GB

• da-DK

• de-CH

• de-DE

• en-AB

• en-AU

• en-GB

• en-IE

• en-IN

• en-US

• en-WL

• es-ES

• es-US

• fa-IR

• fr-CA

• fr-FR

• ga-IE

• gd-GB

• he-IL

• hi-IN

• id-ID

• it-IT

• ja-JP

• ko-KR

• ms-MY

• nl-NL

• pt-BR

• pt-PT

• ru-RU

• ta-IN

• te-IN

• tr-TR

• zh-CN

• zh-TW

• th-TH

• en-ZA

• en-NZ

--phrases (list)

An array of strings containing the vocabulary entries.

(string)

Syntax:

"string" "string" ...

--vocabulary-file-uri (string)

The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is:

https://s3.<aws-region>.amazonaws.com/<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>

For example:

https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt

For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide .

For more information about custom vocabularies, see Custom Vocabularies .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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.

Examples

To update a custom vocabulary with new terms.

The following update-vocabulary example overwrites the terms used to create a custom vocabulary with the new ones that you provide. Prerequisite: to replace the terms in a custom vocabulary, you need a file with new terms.

aws transcribe update-vocabulary \
    --vocabulary-file-uri s3://DOC-EXAMPLE-BUCKET/Amazon-S3-Prefix/custom-vocabulary.txt \
    --vocabulary-name custom-vocabulary \
    --language-code language-code

Output:

{
    "VocabularyName": "custom-vocabulary",
    "LanguageCode": "language",
    "VocabularyState": "PENDING"
}

For more information, see Custom Vocabularies in the Amazon Transcribe Developer Guide.

Output

VocabularyName -> (string)

The name of the vocabulary that was updated.

LanguageCode -> (string)

The language code of the vocabulary entries.

LastModifiedTime -> (timestamp)

The date and time that the vocabulary was updated.

VocabularyState -> (string)

The processing state of the vocabulary. When the VocabularyState field contains READY the vocabulary is ready to be used in a StartTranscriptionJob request.