ListBotAliasReplicas - Amazon Lex API Reference

ListBotAliasReplicas

The action to list the replicated bots created from the source bot alias.

Request Syntax

POST /bots/botId/replicas/replicaRegion/botaliases/ HTTP/1.1 Content-type: application/json { "maxResults": number, "nextToken": "string" }

URI Request Parameters

The request uses the following URI parameters.

botId

The request for the unique bot ID of the replicated bot created from the source bot alias.

Length Constraints: Fixed length of 10.

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

Required: Yes

replicaRegion

The request for the secondary region of the replicated bot created from the source bot alias.

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 request for maximum results to list the replicated bots created from the source bot alias.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

nextToken

The request for the next token for the replicated bot created from the source bot alias.

Type: String

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "botAliasReplicaSummaries": [ { "botAliasId": "string", "botAliasReplicationStatus": "string", "botVersion": "string", "creationDateTime": number, "failureReasons": [ "string" ], "lastUpdatedDateTime": number } ], "botId": "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.

botAliasReplicaSummaries

The summary information of the replicated bot created from the source bot alias.

Type: Array of BotAliasReplicaSummary objects

botId

The unique bot ID of the replicated bot created from the source bot alias.

Type: String

Length Constraints: Fixed length of 10.

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

nextToken

The next token for the replicated bots created from the source bot alias.

Type: String

replicaRegion

The secondary region of the replicated bot created from the source bot alias.

Type: String

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

sourceRegion

The source region of the replicated bot created from the source bot alias.

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

This example illustrates one usage of ListBotAliasReplicas.

POST https://models-v2-lex.us-east-1.amazonaws.com/bots/BOT1234567/replicas/us-west-2/botaliases { "replicaRegion": "us-west-2", "maxResults": 50 }

This example illustrates one example response of ListBotAliasReplicas.

This example illustrates one usage of ListBotAliasReplicas.

{ "botAliasReplicaSummaries": [{ "botAliasId": "ALIAS12345", "botAliasReplicationStatus": "Available", "botVersion": "0000000001", "creationDateTime": 1.706822183021E9, "failureReasons": [], "lastUpdatedDateTime": 1.706822187379E9 }], "botId": "BOT1234567", "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: