UpdateVocabularyFilter
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 vocabulary filter.
Request Syntax
{
"VocabularyFilterFileUri": "string
",
"VocabularyFilterName": "string
",
"Words": [ "string
" ]
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- VocabularyFilterFileUri
-
The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located in the same AWS 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 useWords
; you must choose one or the other.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
Pattern:
(s3://|http(s*)://).+
Required: No
- VocabularyFilterName
-
The name of the custom vocabulary filter you want to update. Vocabulary filter names are case sensitive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z._-]+
Required: Yes
- Words
-
Use this parameter if you want to update your 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 useVocabularyFilterFileUri
; 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 vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
Type: Array of strings
Array Members: Minimum number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
Response Syntax
{
"LanguageCode": "string",
"LastModifiedTime": number,
"VocabularyFilterName": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- LanguageCode
-
The language code you selected for your vocabulary filter.
Type: String
Valid 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
- LastModifiedTime
-
The date and time the specified 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.Type: Timestamp
- VocabularyFilterName
-
The name of the updated custom vocabulary filter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z._-]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as
IN PROGRESS
). See the exception message field for more information.HTTP Status Code: 400
- InternalFailureException
-
There was an internal error. Check the error message, correct the issue, and try your request again.
HTTP Status Code: 500
- LimitExceededException
-
You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
HTTP Status Code: 400
- NotFoundException
-
We can't find the requested resource. Check that the specified name is correct and try your request again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: