DeleteBotReplica - Amazon Lex API Reference

DeleteBotReplica

The action to delete the replicated bot in the secondary region.

Request Syntax

DELETE /bots/botId/replicas/replicaRegion/ HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

botId

The unique ID of the replicated bot to be deleted from the secondary region

Length Constraints: Fixed length of 10.

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

Required: Yes

replicaRegion

The secondary region of the replicated bot that will be deleted.

Length Constraints: Minimum length of 2. Maximum length of 25.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 202 Content-type: application/json { "botId": "string", "botReplicaStatus": "string", "replicaRegion": "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 unique bot ID of the replicated bot generated.

Type: String

Length Constraints: Fixed length of 10.

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

botReplicaStatus

The operational status of the replicated bot generated.

Type: String

Valid Values: Enabling | Enabled | Deleting | Failed

replicaRegion

The region of the replicated bot generated.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 25.

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

Examples

This example illustrates one example input of DeleteBotReplica.

This example illustrates one usage of DeleteBotReplica.

DELETE https://models-v2-lex.us-east-1.amazonaws.com/bots/BOT1234567/replicas/us-west-2 { "replicaRegion": "us-west-2" }

This example illustrates one example response of DeleteBotReplica.

This example illustrates one usage of DeleteBotReplica.

{ "botId": "BOT1234567", "botReplicaStatus": "Deleting", "replicaRegion": "us-west-2" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: