[ aws . transcribe ]

update-medical-vocabulary

Description

Updates an existing custom medical vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing vocabulary.

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>]

Options

--vocabulary-name (string)

The name of the custom medical vocabulary you want to update. Vocabulary names are case sensitive.

--language-code (string)

The language code that represents the language of the entries in the custom vocabulary you want to update. US English (en-US ) is the only language supported with Amazon Transcribe Medical.

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

--vocabulary-file-uri (string)

The Amazon S3 location of the text file that contains your custom medical vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you’re calling.

Here’s an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt

--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 medical custom vocabulary with new terms.

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

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

Output:

{
    "VocabularyName": "medical-custom-vocabulary",
    "LanguageCode": "en-US",
    "VocabularyState": "PENDING"
}

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

Output

VocabularyName -> (string)

The name of the updated custom medical vocabulary.

LanguageCode -> (string)

The language code you selected for your medical vocabulary. US English (en-US ) is the only language supported with Amazon Transcribe Medical.

LastModifiedTime -> (timestamp)

The date and time the specified custom medical vocabulary was last updated.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

VocabularyState -> (string)

The processing state of your custom medical vocabulary. If the state is READY , you can use the vocabulary in a StartMedicalTranscriptionJob request.