ListBotVersionReplicas
Contains information about all the versions replication statuses applicable for Global Resiliency.
Request Syntax
POST /bots/botId/replicas/replicaRegion/botversions/ HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string",
"sortBy": {
"attribute": "string",
"order": "string"
}
}URI Request Parameters
The request uses the following URI parameters.
- botId
-
The request for the unique ID in the list of replicated bots.
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$Required: Yes
- replicaRegion
-
The request for the region used in the list of replicated bots.
Length Constraints: Minimum length of 2. Maximum length of 25.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- maxResults
-
The maximum results given in the list of replicated bots.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- nextToken
-
The next token given in the list of replicated bots.
Type: String
Required: No
- sortBy
-
The requested sort category for the list of replicated bots.
Type: BotVersionReplicaSortBy object
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botVersionReplicaSummaries": [
{
"botVersion": "string",
"botVersionReplicationStatus": "string",
"creationDateTime": number,
"failureReasons": [ "string" ]
}
],
"nextToken": "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 ID of the bots in the list of replicated bots.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$ - botVersionReplicaSummaries
-
The information summary used for the replicated bots in the list of replicated bots.
Type: Array of BotVersionReplicaSummary objects
- nextToken
-
The next token used for the replicated bots in the list of replicated bots.
Type: String
- replicaRegion
-
The region used for the replicated bots in the list of replicated bots.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 25.
- sourceRegion
-
The source region used for the 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 ListBotVersionReplicas.
This example illustrates one usage of ListBotVersionReplicas.
POST https://models-v2-lex.us-east-1.amazonaws.com/bots/BOT1234567/replicas/us-west-2/botversions { "replicaRegion": "us-west-2", "maxResults": 50, "sortBy": { "attribute" : "BotVersion", "order" : "Ascending" } }
This example illustrates one example response of ListBotVersionReplicas.
This example illustrates one usage of ListBotVersionReplicas.
{ "botId": "BOT1234567", "botVersionReplicaSummaries": [{ "botVersion": "0000000001", "botVersionReplicationStatus": "Available", "creationDateTime": 1.706822064378E9, "failureReasons": [] }], "nextToken": null, "replicaRegion": "us-west-2", "sourceRegion": "us-east-1" }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
