Skip to main content

medical_vocabularies

Creates, updates, deletes, gets or lists a medical_vocabularies resource.

Overview​

Namemedical_vocabularies
TypeResource
Idaws.transcribe.medical_vocabularies

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
download_uristringThe Amazon S3 location where the specified custom medical vocabulary is stored; use this URI to view or download the custom vocabulary. (pattern: <code>(s3:​//|http(s*):​//).+</code>)
failure_reasonstringIf VocabularyState is FAILED, FailureReason contains information about why the custom medical vocabulary request failed. See also: Common Errors.
language_codestringThe language code you selected for your custom medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical. (af-ZA, ar-AE, ar-SA, am-ET, 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-MX, es-US, fa-AF, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, ht-HT, id-ID, it-IT, ja-JP, jv-ID, km-KH, ko-KR, my-MM, 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, vi-VN, sv-SE, ab-GE, ast-ES, az-AZ, ba-RU, be-BY, bg-BG, bn-IN, bs-BA, ca-ES, ckb-IQ, ckb-IR, cs-CZ, cy-WL, el-GR, et-EE, et-ET, eu-ES, fi-FI, gl-ES, gu-IN, ha-NG, hr-HR, hu-HU, hy-AM, is-IS, ka-GE, kab-DZ, kk-KZ, kn-IN, ky-KG, lg-IN, lt-LT, lv-LV, mhr-RU, mi-NZ, mk-MK, ml-IN, mn-MN, mr-IN, mt-MT, no-NO, ne-NP, or-IN, pa-IN, pl-PL, ps-AF, ro-RO, rw-RW, si-LK, sk-SK, sl-SI, so-SO, sq-AL, sr-RS, su-ID, sw-BI, sw-KE, sw-RW, sw-TZ, sw-UG, tl-PH, tt-RU, ug-CN, uk-UA, uz-UZ, wo-SN, zh-HK, zu-ZA)
last_modified_timestring (date-time)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.
vocabulary_namestringThe name of the custom medical vocabulary you requested information about. (pattern: <code>^[0-9a-zA-Z._-]+</code>)
vocabulary_statestringThe processing state of your custom medical vocabulary. If the state is READY, you can use the custom vocabulary in a StartMedicalTranscriptionJob request. (PENDING, READY, FAILED)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_medical_vocabularyselectregionProvides information about the specified custom medical vocabulary. To view the status of the specified custom medical vocabulary, check the VocabularyState field. If the status is READY, your custom 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.
list_medical_vocabulariesselectregionProvides a list of custom medical vocabularies that match the specified criteria. If no criteria are specified, all custom medical vocabularies are returned. To get detailed information about a specific custom medical vocabulary, use the operation.
create_medical_vocabularyinsertregion, VocabularyName, LanguageCode, VocabularyFileUriCreates a new custom medical vocabulary. Before creating a new custom medical vocabulary, you must first upload a text file that contains your vocabulary table into an Amazon S3 bucket. Note that this differs from , where you can include a list of terms within your request using the Phrases flag; CreateMedicalVocabulary does not support the Phrases flag and only accepts vocabularies in table format. Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language. For more information, see Custom vocabularies.
update_medical_vocabularyupdateregion, VocabularyName, LanguageCode, VocabularyFileUriUpdates 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 custom vocabulary.
delete_medical_vocabularydeleteregionDeletes a custom medical vocabulary. To use this operation, specify the name of the custom vocabulary you want to delete using VocabularyName. Custom vocabulary names are case sensitive.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

Provides information about the specified custom medical vocabulary. To view the status of the specified custom medical vocabulary, check the VocabularyState field. If the status is READY, your custom 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.

SELECT
download_uri,
failure_reason,
language_code,
last_modified_time,
vocabulary_name,
vocabulary_state
FROM aws.transcribe.medical_vocabularies
WHERE region = '{{ region }}' -- required
;

INSERT examples​

Creates a new custom medical vocabulary. Before creating a new custom medical vocabulary, you must first upload a text file that contains your vocabulary table into an Amazon S3 bucket. Note that this differs from , where you can include a list of terms within your request using the Phrases flag; CreateMedicalVocabulary does not support the Phrases flag and only accepts vocabularies in table format. Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language. For more information, see Custom vocabularies.

INSERT INTO aws.transcribe.medical_vocabularies (
VocabularyName,
LanguageCode,
VocabularyFileUri,
Tags,
region
)
SELECT 
'{{ VocabularyName }}' /* required */,
'{{ LanguageCode }}' /* required */,
'{{ VocabularyFileUri }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
failure_reason,
language_code,
last_modified_time,
vocabulary_name,
vocabulary_state
;

UPDATE examples​

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

UPDATE aws.transcribe.medical_vocabularies
SET 
VocabularyName = '{{ VocabularyName }}',
LanguageCode = '{{ LanguageCode }}',
VocabularyFileUri = '{{ VocabularyFileUri }}'
WHERE 
region = '{{ region }}' --required
AND VocabularyName = '{{ VocabularyName }}' --required
AND LanguageCode = '{{ LanguageCode }}' --required
AND VocabularyFileUri = '{{ VocabularyFileUri }}' --required
RETURNING
language_code,
last_modified_time,
vocabulary_name,
vocabulary_state;

DELETE examples​

Deletes a custom medical vocabulary. To use this operation, specify the name of the custom vocabulary you want to delete using VocabularyName. Custom vocabulary names are case sensitive.

DELETE FROM aws.transcribe.medical_vocabularies
WHERE region = '{{ region }}' --required
;
Last updated on