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 ]
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 .
See also: AWS API Documentation
create-medical-vocabulary
--vocabulary-name <value>
--language-code <value>
--vocabulary-file-uri <value>
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--vocabulary-name
(string)
A unique name, chosen by you, for your new custom medical vocabulary.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new custom medical vocabulary with the same name as an existing custom medical vocabulary, you get a
ConflictException
error.
--language-code
(string)
The language code that represents the language of the entries in your custom vocabulary. US English (
en-US
) is the only language supported with Amazon Transcribe Medical.Possible values:
af-ZA
ar-AE
ar-SA
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
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
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-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
or-IN
pa-IN
pl-PL
ps-AF
ro-RO
rw-RW
si-LK
sk-SK
sl-SI
so-SO
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
zu-ZA
--vocabulary-file-uri
(string)
The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary. The URI must be 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
--tags
(list)
Adds one or more custom tags, each in the form of a key:value pair, to a new custom medical vocabulary at the time you create this new custom vocabulary.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources .
(structure)
Adds metadata, in the form of a key:value pair, to the specified resource.
For example, you could add the tag
Department:Sales
to a resource to indicate that it pertains to your organization's sales department. You can also use tags for tag-based access control.To learn more about tagging, see Tagging resources .
Key -> (string)
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tagDepartment:Sales
, the key is 'Department'.Value -> (string)
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag
Department:Sales
, the value is 'Sales'.Note that you can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.
Shorthand Syntax:
Key=string,Value=string ...
JSON Syntax:
[
{
"Key": "string",
"Value": "string"
}
...
]
--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.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To create a medical custom vocabulary
The following create-medical-vocabulary
example creates a custom vocabulary. To create a custom vocabulary, you must have created a text file with all the terms that you want to transcribe more accurately. For vocabulary-file-uri, specify the Amazon Simple Storage Service (Amazon S3) URI of that text file. For language-code, specify a language code corresponding to the language of your custom vocabulary. For vocabulary-name, specify what you want to call your custom vocabulary.
aws transcribe create-medical-vocabulary \
--vocabulary-name cli-medical-vocab-example \
--language-code language-code \
--vocabulary-file-uri https://DOC-EXAMPLE-BUCKET.AWS-Region.amazonaws.com/the-text-file-for-the-medical-custom-vocabulary.txt
Output:
{
"VocabularyName": "cli-medical-vocab-example",
"LanguageCode": "language-code",
"VocabularyState": "PENDING"
}
For more information, see Medical Custom Vocabularies in the Amazon Transcribe Developer Guide.
VocabularyName -> (string)
The name you chose for your custom medical vocabulary.
LanguageCode -> (string)
The language code you selected for your custom 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 isREADY
, you can use the custom vocabulary in aStartMedicalTranscriptionJob
request.
LastModifiedTime -> (timestamp)
The date and time you created your custom medical vocabulary.
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)
IfVocabularyState
isFAILED
,FailureReason
contains information about why the medical transcription job request failed. See also: Common Errors .