DeleteCustomVocabulary - Amazon Lex API Reference

DeleteCustomVocabulary

Removes a custom vocabulary from the specified locale in the specified bot.

Request Syntax

DELETE /bots/botId/botversions/botVersion/botlocales/localeId/customvocabulary HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

botId

The unique identifier of the bot to remove the custom vocabulary from.

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

Required: Yes

botVersion

The version of the bot to remove the custom vocabulary from.

Length Constraints: Fixed length of 5.

Pattern: ^DRAFT$

Required: Yes

localeId

The locale identifier for the locale that contains the custom vocabulary to remove.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 202 Content-type: application/json { "botId": "string", "botVersion": "string", "customVocabularyStatus": "string", "localeId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

botId

The identifier of the bot that the custom vocabulary was removed from.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

botVersion

The version of the bot that the custom vocabulary was removed from.

Type: String

Length Constraints: Fixed length of 5.

Pattern: ^DRAFT$

customVocabularyStatus

The status of removing the custom vocabulary.

Type: String

Valid Values: Ready | Deleting | Exporting | Importing | Creating

localeId

The locale identifier for the locale that the custom vocabulary was removed from.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

HTTP Status Code: 409

InternalServerException

The service encountered an unexpected condition. Try your request again.

HTTP Status Code: 500

PreconditionFailedException

Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

HTTP Status Code: 412

ServiceQuotaExceededException

You have reached a quota for your bot.

HTTP Status Code: 402

ThrottlingException

Your request rate is too high. Reduce the frequency of requests.

HTTP Status Code: 429

ValidationException

One of the input parameters in your request isn't valid. Check the parameters 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: