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

DescribeBotReplica

Monitors the bot replication status through the UI console.

Request Syntax


GET /bots/botId/replicas/replicaRegion/ HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

botId

The request for the unique bot ID of the replicated bot being monitored.

Length Constraints: Fixed length of 10.

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

Required: Yes

replicaRegion

The request for the region of the replicated bot being monitored.

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 200
Content-type: application/json

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

botId

The unique bot ID of the replicated bot being monitored.

Type: String

Length Constraints: Fixed length of 10.

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

botReplicaStatus

The operational status of the replicated bot being monitored.

Type: String

Valid Values: Enabling | Enabled | Deleting | Failed

creationDateTime

The creation date and time of the replicated bot being monitored.

Type: Timestamp

failureReasons

The failure reasons the bot being monitored failed to replicate.

Type: Array of strings

replicaRegion

The region of the replicated bot being monitored.

Type: String

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

sourceRegion

The source region of the replicated bot being monitored.

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.

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

HTTP Status Code: 404

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 DescribeBotReplica

This example illustrates one usage of DescribeBotReplica.


GET 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 DescribeBotReplica.

This example illustrates one usage of DescribeBotReplica.


{
    "botId": "BOT1234567",
    "botReplicaStatus": "Enabled",
    "creationDateTime": 1.706821927692E9,
    "failureReasons": null,
    "replicaRegion": "us-west-2",
    "sourceRegion": "us-east-1"
}