Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

CreateBotReplica

Action to create a replication of the source bot in the secondary region.

Request Syntax


PUT /bots/botId/replicas/ HTTP/1.1
Content-type: application/json

{
   "replicaRegion": "string"
}

URI Request Parameters

The request uses the following URI parameters.

botId

The request for the unique bot ID of the source bot to be replicated in the secondary region.

Length Constraints: Fixed length of 10.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

replicaRegion

The request for the secondary region that will be used in the replication of the source bot.

Type: String

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

Required: Yes

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "botId": "string",
   "botReplicaStatus": "string",
   "creationDateTime": number,
   "replicaRegion": "string",
   "sourceRegion": "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

creationDateTime

The creation date and time of the replicated bot generated.

Type: Timestamp

replicaRegion

The region of the replicated bot generated.

Type: String

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

sourceRegion

The source region for the source bot used for 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.

retryAfterSeconds: The number of seconds after which the user can invoke the API again.

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 CreateBotReplica.

This example illustrates one usage of CreateBotReplica.


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

This example illustrates one example response of CreateBotReplica.

This example illustrates one usage of CreateBotReplica.


{
    "botId": "BOT1234567",
    "botReplicaStatus": "Enabling",
    "creationDateTime": 1.706821927957E9,
    "replicaRegion": "us-west-2",
    "sourceRegion": "us-east-1"
}