[ aws . transcribe ]

get-medical-vocabulary

Description

Provides information about the specified custom medical vocabulary.

To view the status of the specified medical vocabulary, check the VocabularyState field. If the status is READY , your vocabulary is available to use. If the status is FAILED , FailureReason provides details on why your vocabulary failed.

To get a list of your custom medical vocabularies, use the operation.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-medical-vocabulary
--vocabulary-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--vocabulary-name (string)

The name of the custom medical vocabulary you want information about. Vocabulary names are case sensitive.

--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 get information about a medical custom vocabulary

The following get-medical-vocabulary example gets information on a medical custom vocabulary. You can use the VocabularyState parameter to see the processing state of the vocabulary. If it’s READY, you can use it in the StartMedicalTranscriptionJob operation.:

aws transcribe get-medical-vocabulary \
    --vocabulary-name medical-vocab-example

Output:

{
    "VocabularyName": "medical-vocab-example",
    "LanguageCode": "en-US",
    "VocabularyState": "READY",
    "LastModifiedTime": "2020-09-19T23:59:04.349000+00:00",
    "DownloadUri": "https://link-to-download-the-text-file-used-to-create-your-medical-custom-vocabulary"
}

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

Output

VocabularyName -> (string)

The name of the custom medical vocabulary you requested information about.

LanguageCode -> (string)

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

VocabularyState -> (string)

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

LastModifiedTime -> (timestamp)

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

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.

FailureReason -> (string)

If VocabularyState is FAILED , FailureReason contains information about why the medical vocabulary request failed. See also: Common Errors .

DownloadUri -> (string)

The S3 location where the specified medical vocabulary is stored; use this URI to view or download the vocabulary.