DescribeBotAlias
Get information about a specific bot alias.
Request Syntax
GET /bots/botId/botaliases/botAliasId/ HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- botAliasId
-
The identifier of the bot alias to describe.
Length Constraints: Fixed length of 10.
Pattern:
^(\bTSTALIASID\b|[0-9a-zA-Z]+)$Required: Yes
- botId
-
The identifier of the bot associated with the bot alias to describe.
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
{
"botAliasHistoryEvents": [
{
"botVersion": "string",
"endDate": number,
"startDate": number
}
],
"botAliasId": "string",
"botAliasLocaleSettings": {
"string" : {
"codeHookSpecification": {
"lambdaCodeHook": {
"codeHookInterfaceVersion": "string",
"lambdaARN": "string"
}
},
"enabled": boolean
}
},
"botAliasName": "string",
"botAliasStatus": "string",
"botId": "string",
"botVersion": "string",
"conversationLogSettings": {
"audioLogSettings": [
{
"destination": {
"s3Bucket": {
"kmsKeyArn": "string",
"logPrefix": "string",
"s3BucketArn": "string"
}
},
"enabled": boolean,
"selectiveLoggingEnabled": boolean
}
],
"textLogSettings": [
{
"destination": {
"cloudWatch": {
"cloudWatchLogGroupArn": "string",
"logPrefix": "string"
}
},
"enabled": boolean,
"selectiveLoggingEnabled": boolean
}
]
},
"creationDateTime": number,
"description": "string",
"lastUpdatedDateTime": number,
"parentBotNetworks": [
{
"botId": "string",
"botVersion": "string"
}
],
"sentimentAnalysisSettings": {
"detectSentiment": boolean
}
}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.
- botAliasHistoryEvents
-
A list of events that affect a bot alias. For example, an event is recorded when the version that the alias points to changes.
Type: Array of BotAliasHistoryEvent objects
- botAliasId
-
The identifier of the bot alias.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^(\bTSTALIASID\b|[0-9a-zA-Z]+)$ - botAliasLocaleSettings
-
The locale settings that are unique to the alias.
Type: String to BotAliasLocaleSettings object map
Map Entries: Maximum number of items.
- botAliasName
-
The name of the bot alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^([0-9a-zA-Z][_-]?){1,100}$ - botAliasStatus
-
The current status of the alias. When the alias is
Available, the alias is ready for use with your bot.Type: String
Valid Values:
Creating | Available | Deleting | Failed - botId
-
The identifier of the bot associated with the bot alias.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$ - botVersion
-
The version of the bot associated with the bot alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern:
^(DRAFT|[0-9]+)$ - conversationLogSettings
-
Specifics of how Amazon Lex logs text and audio conversations with the bot associated with the alias.
Type: ConversationLogSettings object
- creationDateTime
-
A timestamp of the date and time that the alias was created.
Type: Timestamp
- description
-
The description of the bot alias.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 200.
- lastUpdatedDateTime
-
A timestamp of the date and time that the alias was last updated.
Type: Timestamp
- parentBotNetworks
-
A list of the networks to which the bot alias you described belongs.
Type: Array of ParentBotNetwork objects
Array Members: Minimum number of 0 items. Maximum number of 30 items.
- sentimentAnalysisSettings
-
Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
Type: SentimentAnalysisSettings object
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
- ResourceNotFoundException
-
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
