Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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

get-medical-vocabulary

Description

Retrieves information about a medical vocabulary.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--vocabulary-name (string)

The name of the vocabulary that you want information about. The value is case sensitive.

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

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 vocabulary returned by Amazon Transcribe Medical.

LanguageCode -> (string)

The valid language code for your vocabulary entries.

VocabularyState -> (string)

The processing state of the vocabulary. If the VocabularyState is READY then you can use it in the StartMedicalTranscriptionJob operation.

LastModifiedTime -> (timestamp)

The date and time that the vocabulary was last modified with a text file different from the one that was previously used.

FailureReason -> (string)

If the VocabularyState is FAILED , this field contains information about why the job failed.

DownloadUri -> (string)

The location in Amazon S3 where the vocabulary is stored. Use this URI to get the contents of the vocabulary. You can download your vocabulary from the URI for a limited time.