[ aws . transcribe ]

update-medical-vocabulary

Description

Updates an existing vocabulary with new values in a different text file. The UpdateMedicalVocabulary 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-medical-vocabulary
--vocabulary-name <value>
--language-code <value>
[--vocabulary-file-uri <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <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 entries in the updated vocabulary. US English (en-US) is the only valid language code in Amazon Transcribe Medical.

Possible values:

• en-US

• es-US

• en-AU

• fr-CA

• en-GB

• de-DE

• pt-BR

• fr-FR

• it-IT

• ko-KR

• es-ES

• en-IN

• hi-IN

• ar-SA

• ru-RU

• zh-CN

• nl-NL

• id-ID

• ta-IN

• fa-IR

• en-IE

• en-AB

• en-WL

• pt-PT

• te-IN

• tr-TR

• de-CH

• he-IL

• ms-MY

• ja-JP

• ar-AE

--vocabulary-file-uri (string)

The Amazon S3 location of the text file containing the definition of the custom vocabulary. The URI must be in the same AWS region as the API endpoint you are calling. You can see the fields you need to enter for you Amazon S3 location in the example URI here:

https://s3.<aws-region>.amazonaws.com/<bucket-name>/<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 in Amazon Transcribe Medical, see Medical 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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

VocabularyName -> (string)

The name of the updated vocabulary.

LanguageCode -> (string)

The language code for the text file used to update the custom vocabulary. US English (en-US) is the only language supported in Amazon Transcribe Medical.

LastModifiedTime -> (timestamp)

The date and time the vocabulary was updated.

VocabularyState -> (string)

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