2026/09/18 - Amazon Transcribe Service - 1 new 9 updated api methods
Changes Amazon Transcribe now lets you encrypt your custom vocabularies, custom vocabulary filters, and custom language models with a customer managed AWS KMS key instead of an AWS owned key, and adds a new UpdateLanguageModel operation to transition CLM encryption to a different KMS key.
Updates the encryption configuration for an existing custom language model. You can use this operation to change the KMS key used to encrypt your model artifacts. The model artifacts are re-encrypted in place. No model training is required.
Your custom language model must not be in the IN_PROGRESS state when you call this operation. You cannot submit another update while a previous update is in progress. Use to check the current state of your model.
Your custom language model remains available for transcription jobs while the update is being processed.
See also: AWS API Documentation
Request Syntax
client.update_language_model(
ModelName='string',
DataAccessRoleArn='string',
EncryptionConfiguration={
'KMSEncryptionContext': {
'string': 'string'
},
'KMSKey': 'string'
}
)
string
[REQUIRED]
The name of the custom language model you want to update. Model names are case sensitive.
string
The Amazon Resource Name (ARN) of an IAM role. If you include EncryptionConfiguration in your request, this role must have permissions to access the specified KMS key. If the role that you specify doesn't have the appropriate permissions, your request fails.
IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.
For more information, see IAM ARNs.
dict
Specifies the new encryption configuration for your custom language model. The model artifacts are re-encrypted in place using the specified KMS key or with an AWS-owned key if a key is not supplied.
KMSEncryptionContext (dict) --
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context.
(string) --
(string) --
KMSKey (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the KMS key you want to use to encrypt your resource artifacts. Only full KMS key ARN format is supported.
KMS key ARNs have the format arn:partition:kms:region:account:key/key-id. For example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
For more information, see KMS key ARNs.
dict
Response Syntax
{
'ModelName': 'string',
'ModelStatus': 'IN_PROGRESS'|'FAILED'|'COMPLETED',
'LastModifiedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
ModelName (string) --
The name of the custom language model that was updated.
ModelStatus (string) --
The status of the specified custom language model.
LastModifiedTime (datetime) --
The date and time the specified custom language model was last modified.
{'EncryptionConfiguration': {'KMSEncryptionContext': {'string': 'string'},
'KMSKey': 'string'}}
Creates a new custom language model.
When creating a new custom language model, you must specify:
If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample rates under 16,000 Hz) base model
The location of your training and tuning files (this must be an Amazon S3 URI)
The language of your model
A unique name for your model
See also: AWS API Documentation
Request Syntax
client.create_language_model(
LanguageCode='en-US'|'hi-IN'|'es-US'|'en-GB'|'en-AU'|'de-DE'|'ja-JP',
BaseModelName='NarrowBand'|'WideBand',
ModelName='string',
InputDataConfig={
'S3Uri': 'string',
'TuningDataS3Uri': 'string',
'DataAccessRoleArn': 'string'
},
EncryptionConfiguration={
'KMSEncryptionContext': {
'string': 'string'
},
'KMSKey': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The language code that represents the language of your model. Each custom language model must contain terms in only one language, and the language you select for your custom language model must match the language of your training and tuning data.
For a list of supported languages and their associated language codes, refer to the Supported languages table. Note that US English ( en-US) is the only language supported with Amazon Transcribe Medical.
A custom language model can only be used to transcribe files in the same language as the model. For example, if you create a custom language model using US English ( en-US), you can only apply this model to files that contain English audio.
string
[REQUIRED]
The Amazon Transcribe standard language model, or base model, used to create your custom language model. Amazon Transcribe offers two options for base models: Wideband and Narrowband.
If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose WideBand. To transcribe audio with a sample rate less than 16,000 Hz, choose NarrowBand.
string
[REQUIRED]
A unique name, chosen by you, for your custom language model.
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 language model with the same name as an existing custom language model, you get a ConflictException error.
dict
[REQUIRED]
Contains the Amazon S3 location of the training data you want to use to create a new custom language model, and permissions to access this location.
When using InputDataConfig, you must include these sub-parameters: S3Uri, which is the Amazon S3 location of your training data, and DataAccessRoleArn, which is the Amazon Resource Name (ARN) of the role that has permission to access your specified Amazon S3 location. You can optionally include TuningDataS3Uri, which is the Amazon S3 location of your tuning data. If you specify different Amazon S3 locations for training and tuning data, the ARN you use must have permissions to access both locations.
S3Uri (string) -- [REQUIRED]
The Amazon S3 location (URI) of the text files you want to use to train your custom language model.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/
TuningDataS3Uri (string) --
The Amazon S3 location (URI) of the text files you want to use to tune your custom language model.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/
DataAccessRoleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.
IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.
For more information, see IAM ARNs.
dict
Specifies the encryption configuration for your custom language model. Your model artifacts are encrypted with the specified KMS key or with an AWS-owned key if a key is not supplied.
KMSEncryptionContext (dict) --
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context.
(string) --
(string) --
KMSKey (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the KMS key you want to use to encrypt your resource artifacts. Only full KMS key ARN format is supported.
KMS key ARNs have the format arn:partition:kms:region:account:key/key-id. For example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
For more information, see KMS key ARNs.
list
Adds one or more custom tags, each in the form of a key:value pair, to a new custom language model at the time you create this new model.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
(dict) --
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) -- [REQUIRED]
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) -- [REQUIRED]
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.
dict
Response Syntax
{
'LanguageCode': 'en-US'|'hi-IN'|'es-US'|'en-GB'|'en-AU'|'de-DE'|'ja-JP',
'BaseModelName': 'NarrowBand'|'WideBand',
'ModelName': 'string',
'InputDataConfig': {
'S3Uri': 'string',
'TuningDataS3Uri': 'string',
'DataAccessRoleArn': 'string'
},
'ModelStatus': 'IN_PROGRESS'|'FAILED'|'COMPLETED'
}
Response Structure
(dict) --
LanguageCode (string) --
The language code you selected for your custom language model.
BaseModelName (string) --
The Amazon Transcribe standard language model, or base model, you specified when creating your custom language model.
ModelName (string) --
The name of your custom language model.
InputDataConfig (dict) --
Lists your data access role ARN (Amazon Resource Name) and the Amazon S3 locations you provided for your training ( S3Uri) and tuning ( TuningDataS3Uri) data.
S3Uri (string) --
The Amazon S3 location (URI) of the text files you want to use to train your custom language model.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/
TuningDataS3Uri (string) --
The Amazon S3 location (URI) of the text files you want to use to tune your custom language model.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.
IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.
For more information, see IAM ARNs.
ModelStatus (string) --
The status of your custom language model. When the status displays as COMPLETED, your model is ready to use.
{'EncryptionConfiguration': {'KMSEncryptionContext': {'string': 'string'},
'KMSKey': 'string'}}
Creates a new custom vocabulary.
When creating a new custom vocabulary, you can either upload a text file that contains your new entries, phrases, and terms into an Amazon S3 bucket and include the URI in your request. Or you can include a list of terms directly in your request using the Phrases flag.
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
Request Syntax
client.create_vocabulary(
VocabularyName='string',
LanguageCode='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',
Phrases=[
'string',
],
VocabularyFileUri='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
DataAccessRoleArn='string',
EncryptionConfiguration={
'KMSEncryptionContext': {
'string': 'string'
},
'KMSKey': 'string'
}
)
string
[REQUIRED]
A unique name, chosen by you, for your new custom 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 vocabulary with the same name as an existing custom vocabulary, you get a ConflictException error.
string
[REQUIRED]
The language code that represents the language of the entries in your custom vocabulary. Each custom vocabulary must contain terms in only one language.
A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English ( en-US), you can only apply this custom vocabulary to files that contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
list
Use this parameter if you want to create your custom vocabulary by including all desired terms, as comma-separated values, within your request. The other option for creating your custom vocabulary is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFileUri parameter.
Note that if you include Phrases in your request, you cannot use VocabularyFileUri; you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
(string) --
string
The Amazon S3 location of the text file that contains your custom vocabulary. The URI must be located 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
Note that if you include VocabularyFileUri in your request, you cannot use the Phrases flag; you must choose one or the other.
list
Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary at the time you create this new custom vocabulary.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
(dict) --
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) -- [REQUIRED]
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) -- [REQUIRED]
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.
string
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary). If you include EncryptionConfiguration in your request, this role must also have permissions to access the specified KMS key. If the role that you specify doesn’t have the appropriate permissions, your request fails.
IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.
For more information, see IAM ARNs.
dict
Specifies the encryption configuration for your custom vocabulary. Your vocabulary artifacts are encrypted with the specified KMS key or with an AWS-owned key if a key is not supplied.
KMSEncryptionContext (dict) --
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context.
(string) --
(string) --
KMSKey (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the KMS key you want to use to encrypt your resource artifacts. Only full KMS key ARN format is supported.
KMS key ARNs have the format arn:partition:kms:region:account:key/key-id. For example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
For more information, see KMS key ARNs.
dict
Response Syntax
{
'VocabularyName': 'string',
'LanguageCode': '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',
'VocabularyState': 'PENDING'|'READY'|'FAILED',
'LastModifiedTime': datetime(2015, 1, 1),
'FailureReason': 'string'
}
Response Structure
(dict) --
VocabularyName (string) --
The name you chose for your custom vocabulary.
LanguageCode (string) --
The language code you selected for your custom vocabulary.
VocabularyState (string) --
The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.
LastModifiedTime (datetime) --
The date and time you created your custom 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) --
If VocabularyState is FAILED, FailureReason contains information about why the custom vocabulary request failed. See also: Common Errors.
{'EncryptionConfiguration': {'KMSEncryptionContext': {'string': 'string'},
'KMSKey': 'string'}}
Creates a new custom vocabulary filter.
You can use custom vocabulary filters to mask, delete, or flag specific words from your transcript. Custom vocabulary filters are commonly used to mask profanity in transcripts.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
For more information, see Vocabulary filtering.
See also: AWS API Documentation
Request Syntax
client.create_vocabulary_filter(
VocabularyFilterName='string',
LanguageCode='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',
Words=[
'string',
],
VocabularyFilterFileUri='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
DataAccessRoleArn='string',
EncryptionConfiguration={
'KMSEncryptionContext': {
'string': 'string'
},
'KMSKey': 'string'
}
)
string
[REQUIRED]
A unique name, chosen by you, for your new custom vocabulary filter.
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 vocabulary filter with the same name as an existing custom vocabulary filter, you get a ConflictException error.
string
[REQUIRED]
The language code that represents the language of the entries in your vocabulary filter. Each custom vocabulary filter must contain terms in only one language.
A custom vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a custom vocabulary filter using US English ( en-US), you can only apply this filter to files that contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
list
Use this parameter if you want to create your custom vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for creating your vocabulary filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFilterFileUri parameter.
Note that if you include Words in your request, you cannot use VocabularyFilterFileUri; you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
(string) --
string
The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located 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-filter-file.txt
Note that if you include VocabularyFilterFileUri in your request, you cannot use Words; you must choose one or the other.
list
Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at the time you create this new vocabulary filter.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
(dict) --
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) -- [REQUIRED]
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) -- [REQUIRED]
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.
string
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary filter). If you include EncryptionConfiguration in your request, this role must also have permissions to access the specified KMS key. If the role that you specify doesn’t have the appropriate permissions, your request fails.
IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.
For more information, see IAM ARNs.
dict
Specifies the encryption configuration for your custom vocabulary filter. Your vocabulary filter artifacts are encrypted with the specified KMS key or with an AWS-owned key if a key is not supplied.
KMSEncryptionContext (dict) --
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context.
(string) --
(string) --
KMSKey (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the KMS key you want to use to encrypt your resource artifacts. Only full KMS key ARN format is supported.
KMS key ARNs have the format arn:partition:kms:region:account:key/key-id. For example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
For more information, see KMS key ARNs.
dict
Response Syntax
{
'VocabularyFilterName': 'string',
'LanguageCode': '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',
'LastModifiedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
VocabularyFilterName (string) --
The name you chose for your custom vocabulary filter.
LanguageCode (string) --
The language code you selected for your custom vocabulary filter.
LastModifiedTime (datetime) --
The date and time you created your custom vocabulary filter.
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.
{'LanguageModel': {'EncryptionConfiguration': {'KMSEncryptionContext': {'string': 'string'},
'KMSKey': 'string'}}}
Provides information about the specified custom language model.
This operation also shows if the base language model that you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model.
If you tried to create a new custom language model and the request wasn't successful, you can use DescribeLanguageModel to help identify the reason for this failure.
See also: AWS API Documentation
Request Syntax
client.describe_language_model(
ModelName='string'
)
string
[REQUIRED]
The name of the custom language model you want information about. Model names are case sensitive.
dict
Response Syntax
{
'LanguageModel': {
'ModelName': 'string',
'CreateTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'LanguageCode': 'en-US'|'hi-IN'|'es-US'|'en-GB'|'en-AU'|'de-DE'|'ja-JP',
'BaseModelName': 'NarrowBand'|'WideBand',
'ModelStatus': 'IN_PROGRESS'|'FAILED'|'COMPLETED',
'UpgradeAvailability': True|False,
'FailureReason': 'string',
'InputDataConfig': {
'S3Uri': 'string',
'TuningDataS3Uri': 'string',
'DataAccessRoleArn': 'string'
},
'EncryptionConfiguration': {
'KMSEncryptionContext': {
'string': 'string'
},
'KMSKey': 'string'
}
}
}
Response Structure
(dict) --
LanguageModel (dict) --
Provides information about the specified custom language model.
This parameter also shows if the base language model you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model.
If you tried to create a new custom language model and the request wasn't successful, you can use this DescribeLanguageModel to help identify the reason for this failure.
ModelName (string) --
A unique name, chosen by you, for your custom language model.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.
CreateTime (datetime) --
The date and time the specified custom language model was created.
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.
LastModifiedTime (datetime) --
The date and time the specified custom language model 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.
LanguageCode (string) --
The language code used to create your custom language model. Each custom language model must contain terms in only one language, and the language you select for your custom language model must match the language of your training and tuning data.
For a list of supported languages and their associated language codes, refer to the Supported languages table. Note that US English ( en-US) is the only language supported with Amazon Transcribe Medical.
BaseModelName (string) --
The Amazon Transcribe standard language model, or base model, used to create your custom language model.
ModelStatus (string) --
The status of the specified custom language model. When the status displays as COMPLETED the model is ready for use.
UpgradeAvailability (boolean) --
Shows if a more current base model is available for use with the specified custom language model.
If false, your custom language model is using the most up-to-date base model.
If true, there is a newer base model available than the one your language model is using.
Note that to update a base model, you must recreate the custom language model using the new base model. Base model upgrades for existing custom language models are not supported.
FailureReason (string) --
If ModelStatus is FAILED, FailureReason contains information about why the custom language model request failed. See also: Common Errors.
InputDataConfig (dict) --
The Amazon S3 location of the input files used to train and tune your custom language model, in addition to the data access role ARN (Amazon Resource Name) that has permissions to access these data.
S3Uri (string) --
The Amazon S3 location (URI) of the text files you want to use to train your custom language model.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/
TuningDataS3Uri (string) --
The Amazon S3 location (URI) of the text files you want to use to tune your custom language model.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.
IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.
For more information, see IAM ARNs.
EncryptionConfiguration (dict) --
The encryption configuration used for your custom language model.
KMSEncryptionContext (dict) --
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context.
(string) --
(string) --
KMSKey (string) --
The Amazon Resource Name (ARN) of the KMS key you want to use to encrypt your resource artifacts. Only full KMS key ARN format is supported.
KMS key ARNs have the format arn:partition:kms:region:account:key/key-id. For example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
For more information, see KMS key ARNs.
{'DataAccessRoleArn': 'string',
'EncryptionConfiguration': {'KMSEncryptionContext': {'string': 'string'},
'KMSKey': 'string'}}
Provides information about the specified custom vocabulary.
To view the status of the specified custom 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 custom vocabulary failed.
To get a list of your custom vocabularies, use the operation.
See also: AWS API Documentation
Request Syntax
client.get_vocabulary(
VocabularyName='string'
)
string
[REQUIRED]
The name of the custom vocabulary you want information about. Custom vocabulary names are case sensitive.
dict
Response Syntax
{
'VocabularyName': 'string',
'LanguageCode': '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',
'VocabularyState': 'PENDING'|'READY'|'FAILED',
'LastModifiedTime': datetime(2015, 1, 1),
'FailureReason': 'string',
'DownloadUri': 'string',
'DataAccessRoleArn': 'string',
'EncryptionConfiguration': {
'KMSEncryptionContext': {
'string': 'string'
},
'KMSKey': 'string'
}
}
Response Structure
(dict) --
VocabularyName (string) --
The name of the custom vocabulary you requested information about.
LanguageCode (string) --
The language code you selected for your custom vocabulary.
VocabularyState (string) --
The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.
LastModifiedTime (datetime) --
The date and time the specified custom 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 custom vocabulary request failed. See also: Common Errors.
DownloadUri (string) --
The Amazon S3 location where the custom vocabulary is stored; use this URI to view or download the custom vocabulary.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role used to access the Amazon S3 bucket that contains your input files and, if applicable, the KMS key specified in EncryptionConfiguration.
EncryptionConfiguration (dict) --
The encryption configuration used for your custom vocabulary.
KMSEncryptionContext (dict) --
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context.
(string) --
(string) --
KMSKey (string) --
The Amazon Resource Name (ARN) of the KMS key you want to use to encrypt your resource artifacts. Only full KMS key ARN format is supported.
KMS key ARNs have the format arn:partition:kms:region:account:key/key-id. For example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
For more information, see KMS key ARNs.
{'DataAccessRoleArn': 'string',
'EncryptionConfiguration': {'KMSEncryptionContext': {'string': 'string'},
'KMSKey': 'string'}}
Provides information about the specified custom vocabulary filter.
To get a list of your custom vocabulary filters, use the operation.
See also: AWS API Documentation
Request Syntax
client.get_vocabulary_filter(
VocabularyFilterName='string'
)
string
[REQUIRED]
The name of the custom vocabulary filter you want information about. Custom vocabulary filter names are case sensitive.
dict
Response Syntax
{
'VocabularyFilterName': 'string',
'LanguageCode': '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',
'LastModifiedTime': datetime(2015, 1, 1),
'DownloadUri': 'string',
'DataAccessRoleArn': 'string',
'EncryptionConfiguration': {
'KMSEncryptionContext': {
'string': 'string'
},
'KMSKey': 'string'
}
}
Response Structure
(dict) --
VocabularyFilterName (string) --
The name of the custom vocabulary filter you requested information about.
LanguageCode (string) --
The language code you selected for your custom vocabulary filter.
LastModifiedTime (datetime) --
The date and time the specified custom vocabulary filter 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.
DownloadUri (string) --
The Amazon S3 location where the custom vocabulary filter is stored; use this URI to view or download the custom vocabulary filter.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role used to access the Amazon S3 bucket that contains your input files and, if applicable, the KMS key specified in EncryptionConfiguration.
EncryptionConfiguration (dict) --
The encryption configuration used for your custom vocabulary filter.
KMSEncryptionContext (dict) --
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context.
(string) --
(string) --
KMSKey (string) --
The Amazon Resource Name (ARN) of the KMS key you want to use to encrypt your resource artifacts. Only full KMS key ARN format is supported.
KMS key ARNs have the format arn:partition:kms:region:account:key/key-id. For example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
For more information, see KMS key ARNs.
{'Models': {'EncryptionConfiguration': {'KMSEncryptionContext': {'string': 'string'},
'KMSKey': 'string'}}}
Provides a list of custom language models that match the specified criteria. If no criteria are specified, all custom language models are returned.
To get detailed information about a specific custom language model, use the operation.
See also: AWS API Documentation
Request Syntax
client.list_language_models(
StatusEquals='IN_PROGRESS'|'FAILED'|'COMPLETED',
NameContains='string',
NextToken='string',
MaxResults=123
)
string
Returns only custom language models with the specified status. Language models are ordered by creation date, with the newest model first. If you do not include StatusEquals, all custom language models are returned.
string
Returns only the custom language models that contain the specified string. The search is not case sensitive.
string
If your ListLanguageModels request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.
integer
The maximum number of custom language models to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.
dict
Response Syntax
{
'NextToken': 'string',
'Models': [
{
'ModelName': 'string',
'CreateTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'LanguageCode': 'en-US'|'hi-IN'|'es-US'|'en-GB'|'en-AU'|'de-DE'|'ja-JP',
'BaseModelName': 'NarrowBand'|'WideBand',
'ModelStatus': 'IN_PROGRESS'|'FAILED'|'COMPLETED',
'UpgradeAvailability': True|False,
'FailureReason': 'string',
'InputDataConfig': {
'S3Uri': 'string',
'TuningDataS3Uri': 'string',
'DataAccessRoleArn': 'string'
},
'EncryptionConfiguration': {
'KMSEncryptionContext': {
'string': 'string'
},
'KMSKey': 'string'
}
},
]
}
Response Structure
(dict) --
NextToken (string) --
If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.
Models (list) --
Provides information about the custom language models that match the criteria specified in your request.
(dict) --
Provides information about a custom language model, including:
The base model name
When the model was created
The location of the files used to train the model
When the model was last modified
The name you chose for the model
The model's language
The model's processing state
Any available upgrades for the base model
ModelName (string) --
A unique name, chosen by you, for your custom language model.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.
CreateTime (datetime) --
The date and time the specified custom language model was created.
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.
LastModifiedTime (datetime) --
The date and time the specified custom language model 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.
LanguageCode (string) --
The language code used to create your custom language model. Each custom language model must contain terms in only one language, and the language you select for your custom language model must match the language of your training and tuning data.
For a list of supported languages and their associated language codes, refer to the Supported languages table. Note that US English ( en-US) is the only language supported with Amazon Transcribe Medical.
BaseModelName (string) --
The Amazon Transcribe standard language model, or base model, used to create your custom language model.
ModelStatus (string) --
The status of the specified custom language model. When the status displays as COMPLETED the model is ready for use.
UpgradeAvailability (boolean) --
Shows if a more current base model is available for use with the specified custom language model.
If false, your custom language model is using the most up-to-date base model.
If true, there is a newer base model available than the one your language model is using.
Note that to update a base model, you must recreate the custom language model using the new base model. Base model upgrades for existing custom language models are not supported.
FailureReason (string) --
If ModelStatus is FAILED, FailureReason contains information about why the custom language model request failed. See also: Common Errors.
InputDataConfig (dict) --
The Amazon S3 location of the input files used to train and tune your custom language model, in addition to the data access role ARN (Amazon Resource Name) that has permissions to access these data.
S3Uri (string) --
The Amazon S3 location (URI) of the text files you want to use to train your custom language model.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/
TuningDataS3Uri (string) --
The Amazon S3 location (URI) of the text files you want to use to tune your custom language model.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.
IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.
For more information, see IAM ARNs.
EncryptionConfiguration (dict) --
The encryption configuration used for your custom language model.
KMSEncryptionContext (dict) --
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context.
(string) --
(string) --
KMSKey (string) --
The Amazon Resource Name (ARN) of the KMS key you want to use to encrypt your resource artifacts. Only full KMS key ARN format is supported.
KMS key ARNs have the format arn:partition:kms:region:account:key/key-id. For example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
For more information, see KMS key ARNs.
{'EncryptionConfiguration': {'KMSEncryptionContext': {'string': 'string'},
'KMSKey': 'string'}}
Updates an existing custom vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing custom vocabulary.
Your custom vocabulary must be in a terminal state ( READY or FAILED) before you can update it. You must include either Phrases or VocabularyFileUri in your request.
See also: AWS API Documentation
Request Syntax
client.update_vocabulary(
VocabularyName='string',
LanguageCode='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',
Phrases=[
'string',
],
VocabularyFileUri='string',
DataAccessRoleArn='string',
EncryptionConfiguration={
'KMSEncryptionContext': {
'string': 'string'
},
'KMSKey': 'string'
}
)
string
[REQUIRED]
The name of the custom vocabulary you want to update. Custom vocabulary names are case sensitive.
string
[REQUIRED]
The language code that represents the language of the entries in the custom vocabulary you want to update. Each custom vocabulary must contain terms in only one language.
A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English ( en-US), you can only apply this custom vocabulary to files that contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
list
Use this parameter if you want to update your custom vocabulary by including all desired terms, as comma-separated values, within your request. The other option for updating your custom vocabulary is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFileUri parameter.
Note that if you include Phrases in your request, you cannot use VocabularyFileUri; you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
(string) --
string
The Amazon S3 location of the text file that contains your custom vocabulary. The URI must be located 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
Note that if you include VocabularyFileUri in your request, you cannot use the Phrases flag; you must choose one or the other.
string
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary). If you include EncryptionConfiguration in your request, this role must also have permissions to access the specified KMS key. If the role that you specify doesn’t have the appropriate permissions, your request fails.
IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.
For more information, see IAM ARNs.
dict
Specifies the new encryption configuration for your custom vocabulary. The vocabulary artifacts are re-encrypted in place using the specified KMS key or with an AWS-owned key if a key is not supplied.
KMSEncryptionContext (dict) --
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context.
(string) --
(string) --
KMSKey (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the KMS key you want to use to encrypt your resource artifacts. Only full KMS key ARN format is supported.
KMS key ARNs have the format arn:partition:kms:region:account:key/key-id. For example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
For more information, see KMS key ARNs.
dict
Response Syntax
{
'VocabularyName': 'string',
'LanguageCode': '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',
'LastModifiedTime': datetime(2015, 1, 1),
'VocabularyState': 'PENDING'|'READY'|'FAILED'
}
Response Structure
(dict) --
VocabularyName (string) --
The name of the updated custom vocabulary.
LanguageCode (string) --
The language code you selected for your custom vocabulary.
LastModifiedTime (datetime) --
The date and time the specified custom vocabulary was last updated.
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.
VocabularyState (string) --
The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.
{'EncryptionConfiguration': {'KMSEncryptionContext': {'string': 'string'},
'KMSKey': 'string'}}
Updates an existing custom vocabulary filter with a new list of words. The new list you provide overwrites all previous entries; you cannot append new terms onto an existing custom vocabulary filter.
You must include either Words or VocabularyFilterFileUri in your request.
See also: AWS API Documentation
Request Syntax
client.update_vocabulary_filter(
VocabularyFilterName='string',
Words=[
'string',
],
VocabularyFilterFileUri='string',
DataAccessRoleArn='string',
EncryptionConfiguration={
'KMSEncryptionContext': {
'string': 'string'
},
'KMSKey': 'string'
}
)
string
[REQUIRED]
The name of the custom vocabulary filter you want to update. Custom vocabulary filter names are case sensitive.
list
Use this parameter if you want to update your custom vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for updating your vocabulary filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFilterFileUri parameter.
Note that if you include Words in your request, you cannot use VocabularyFilterFileUri; you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
(string) --
string
The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located 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-filter-file.txt
Note that if you include VocabularyFilterFileUri in your request, you cannot use Words; you must choose one or the other.
string
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary filter). If you include EncryptionConfiguration in your request, this role must also have permissions to access the specified KMS key. If the role that you specify doesn’t have the appropriate permissions, your request fails.
IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.
For more information, see IAM ARNs.
dict
Specifies the new encryption configuration for your custom vocabulary filter. The vocabulary filter artifacts are re-encrypted in place using the specified KMS key or with an AWS-owned key if a key is not supplied.
KMSEncryptionContext (dict) --
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context.
(string) --
(string) --
KMSKey (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the KMS key you want to use to encrypt your resource artifacts. Only full KMS key ARN format is supported.
KMS key ARNs have the format arn:partition:kms:region:account:key/key-id. For example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
For more information, see KMS key ARNs.
dict
Response Syntax
{
'VocabularyFilterName': 'string',
'LanguageCode': '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',
'LastModifiedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
VocabularyFilterName (string) --
The name of the updated custom vocabulary filter.
LanguageCode (string) --
The language code you selected for your custom vocabulary filter.
LastModifiedTime (datetime) --
The date and time the specified custom vocabulary filter was last updated.
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.