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. .
Returns information about an Amazon Lex bot alias. For more information about aliases, see Versioning and Aliases.
This operation requires permissions for the
lex:GetBotAlias action.
Request Syntax
GET /bots/botName/aliases/name HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"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"
}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.
- botName
-
The name of the bot that the alias points to.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 50.
Pattern:
^([A-Za-z]_?)+$ - botVersion
-
The version of the bot that the alias points to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
\$LATEST|[0-9]+ - checksum
-
Checksum of the bot alias.
Type: String
- conversationLogs
-
The settings that determine how Amazon Lex uses conversation logs for the alias.
Type: ConversationLogsResponse object
- createdDate
-
The date that the bot alias was created.
Type: Timestamp
- description
-
A description of the bot alias.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 200.
- lastUpdatedDate
-
The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.
Type: Timestamp
- name
-
The name of the bot alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^([A-Za-z]_?)+$
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
- NotFoundException
-
The resource specified in the request was not found. Check the resource and try again.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
