DeleteBotAlias - Amazon Lex

DeleteBotAlias

Deletes the specified bot alias.

Request Syntax

DELETE /bots/botId/botaliases/botAliasId/?skipResourceInUseCheck=skipResourceInUseCheck HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

botAliasId

The unique identifier of the bot alias to delete.

Length Constraints: Fixed length of 10.

Pattern: ^(\bTSTALIASID\b|[0-9a-zA-Z]+)$

Required: Yes

botId

The unique identifier of the bot associated with the alias to delete.

Length Constraints: Fixed length of 10.

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

Required: Yes

skipResourceInUseCheck

When this parameter is true, Amazon Lex doesn't check to see if any other resource is using the alias before it is deleted.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 202 Content-type: application/json { "botAliasId": "string", "botAliasStatus": "string", "botId": "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.

botAliasId

The unique identifier of the bot alias to delete.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^(\bTSTALIASID\b|[0-9a-zA-Z]+)$

botAliasStatus

The current status of the alias. The status is Deleting while the alias is in the process of being deleted. Once the alias is deleted, it will no longer appear in the list of aliases returned by the ListBotAliases operation.

Type: String

Valid Values: Creating | Available | Deleting | Failed

botId

The unique identifier of the bot that contains the alias to delete.

Type: String

Length Constraints: Fixed length of 10.

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

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: