Skip to main content

vocabulary_filters

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

Overview​

Namevocabulary_filters
TypeResource
Idaws.transcribe.vocabulary_filters

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
download_uristringThe Amazon S3 location where the custom vocabulary filter is stored; use this URI to view or download the custom vocabulary filter. (pattern: <code>(s3:​//|http(s*):​//).+</code>)
language_codestringThe language code you selected for your custom vocabulary filter. (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 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.
vocabulary_filter_namestringThe name of the custom vocabulary filter you requested information about. (pattern: <code>^[0-9a-zA-Z._-]+</code>)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_vocabulary_filterselectregionProvides information about the specified custom vocabulary filter. To get a list of your custom vocabulary filters, use the operation.
list_vocabulary_filtersselectregionProvides a list of custom vocabulary filters that match the specified criteria. If no criteria are specified, all custom vocabularies are returned. To get detailed information about a specific custom vocabulary filter, use the operation.
create_vocabulary_filterinsertregion, VocabularyFilterName, LanguageCodeCreates 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.
update_vocabulary_filterupdateregion, VocabularyFilterNameUpdates 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.
delete_vocabulary_filterdeleteregionDeletes a custom vocabulary filter. To use this operation, specify the name of the custom vocabulary filter you want to delete using VocabularyFilterName. Custom vocabulary filter 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 vocabulary filter. To get a list of your custom vocabulary filters, use the operation.

SELECT
download_uri,
language_code,
last_modified_time,
vocabulary_filter_name
FROM aws.transcribe.vocabulary_filters
WHERE region = '{{ region }}' -- required
;

INSERT examples​

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.

INSERT INTO aws.transcribe.vocabulary_filters (
VocabularyFilterName,
LanguageCode,
Words,
VocabularyFilterFileUri,
Tags,
DataAccessRoleArn,
region
)
SELECT 
'{{ VocabularyFilterName }}' /* required */,
'{{ LanguageCode }}' /* required */,
'{{ Words }}',
'{{ VocabularyFilterFileUri }}',
'{{ Tags }}',
'{{ DataAccessRoleArn }}',
'{{ region }}'
RETURNING
language_code,
last_modified_time,
vocabulary_filter_name
;

UPDATE examples​

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.

UPDATE aws.transcribe.vocabulary_filters
SET 
VocabularyFilterName = '{{ VocabularyFilterName }}',
Words = '{{ Words }}',
VocabularyFilterFileUri = '{{ VocabularyFilterFileUri }}',
DataAccessRoleArn = '{{ DataAccessRoleArn }}'
WHERE 
region = '{{ region }}' --required
AND VocabularyFilterName = '{{ VocabularyFilterName }}' --required
RETURNING
language_code,
last_modified_time,
vocabulary_filter_name;

DELETE examples​

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

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