[ aws . transcribe ]

create-vocabulary

Description

Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-vocabulary
--vocabulary-name <value>
--language-code <value>
[--phrases <value>]
[--vocabulary-file-uri <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--vocabulary-name (string)

The name of the vocabulary. The name must be unique within an Amazon Web Services account. The name is case sensitive. If you try to create a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.

--language-code (string)

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see table-language-matrix .

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

--phrases (list)

An array of strings that contains the vocabulary entries.

(string)

Syntax:

"string" "string" ...

--vocabulary-file-uri (string)

The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is:

https://s3.<Amazon Web Services-region>.amazonaws.com/<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>

For example:

https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt

For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide .

For more information about custom vocabularies, see Custom vocabularies .

--tags (list)

Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary at the time you create this new vocabulary.

(structure)

A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization’s sales department.

Key -> (string)

The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’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’.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--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 create a custom vocabulary

The following create-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-vocabulary \
    --language-code language-code \
    --vocabulary-name cli-vocab-example \
    --vocabulary-file-uri s3://DOC-EXAMPLE-BUCKET/Amazon-S3-prefix/the-text-file-for-the-custom-vocabulary.txt

Output:

{
    "VocabularyName": "cli-vocab-example",
    "LanguageCode": "language-code",
    "VocabularyState": "PENDING"
}

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

Output

VocabularyName -> (string)

The name of the vocabulary.

LanguageCode -> (string)

The language code of the vocabulary entries.

VocabularyState -> (string)

The processing state of the vocabulary. When the VocabularyState field contains READY the vocabulary is ready to be used in a StartTranscriptionJob request.

LastModifiedTime -> (timestamp)

The date and time that the vocabulary was created.

FailureReason -> (string)

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