End of support notice: On September 15, 2025, AWS will discontinue support for Amazon Lex V1. After September 15, 2025, you will no longer be able to access the Amazon Lex V1 console or Amazon Lex V1 resources. If you are using Amazon Lex V2, refer to the Amazon Lex V2 guide instead. .
GetBotAliases
Returns a list of aliases for a specified Amazon Lex bot.
This operation requires permissions for the
lex:GetBotAliases action.
Request Syntax
GET /bots/botName/aliases/?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- botName
-
The name of the bot.
Length Constraints: Minimum length of 2. Maximum length of 50.
Pattern:
^([A-Za-z]_?)+$Required: Yes
- maxResults
-
The maximum number of aliases to return in the response. The default is 50. .
Valid Range: Minimum value of 1. Maximum value of 50.
- nameContains
-
Substring to match in bot alias names. An alias will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^([A-Za-z]_?)+$ - nextToken
-
A pagination token for fetching the next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"BotAliases": [
{
"botName": "string",
"botVersion": "string",
"checksum": "string",
"conversationLogs": {
"iamRoleArn": "string",
"logSettings": [
{
"destination": "string",
"kmsKeyArn": "string",
"logType": "string",
"resourceArn": "string",
"resourcePrefix": "string"
}
]
},
"createdDate": number,
"description": "string",
"lastUpdatedDate": number,
"name": "string"
}
],
"nextToken": "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.
- BotAliases
-
An array of
BotAliasMetadataobjects, each describing a bot alias.Type: Array of BotAliasMetadata objects
- nextToken
-
A pagination token for fetching next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.
Type: String
Errors
- BadRequestException
-
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
HTTP Status Code: 400
- InternalFailureException
-
An internal Amazon Lex error occurred. Try your request again.
HTTP Status Code: 500
- LimitExceededException
-
The request exceeded a limit. Try your request again.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
