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

ListBotReplicas

The action to list the replicated bots.

Request Syntax


POST /bots/botId/replicas/ HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

botId

The request for the unique bot IDs in the list of replicated bots.

Length Constraints: Fixed length of 10.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "botId": "string",
   "botReplicaSummaries": [ 
      { 
         "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 IDs in the list of replicated bots.

Type: String

Length Constraints: Fixed length of 10.

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

botReplicaSummaries

The summary details for the replicated bots.

Type: Array of BotReplicaSummary objects

sourceRegion

The source region of the source bots in the list of replicated bots.

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

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

This example illustrates one usage of ListBotReplicas.


POST https://models-v2-lex.us-east-1.amazonaws.com/bots/BOT1234567/replicas/
{
}

This example illustrates one example response of ListBotReplicas.

This example illustrates one usage of ListBotReplicas.


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