DescribeBotRecommendation
Provides metadata information about a bot recommendation. This information will enable you to get a description on the request inputs, to download associated transcripts after processing is complete, and to download intents and slot-types generated by the bot recommendation.
Request Syntax
GET /bots/botId/botversions/botVersion/botlocales/localeId/botrecommendations/botRecommendationId/ HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- botId
-
The unique identifier of the bot associated with the bot recommendation.
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$Required: Yes
- botRecommendationId
-
The identifier of the bot recommendation to describe.
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$Required: Yes
- botVersion
-
The version of the bot associated with the bot recommendation.
Length Constraints: Fixed length of 5.
Pattern:
^DRAFT$Required: Yes
- localeId
-
The identifier of the language and locale of the bot recommendation to describe. The string must match one of the supported locales. For more information, see Supported languages.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botRecommendationId": "string",
"botRecommendationResults": {
"associatedTranscriptsUrl": "string",
"botLocaleExportUrl": "string",
"statistics": {
"intents": {
"discoveredIntentCount": number
},
"slotTypes": {
"discoveredSlotTypeCount": number
}
}
},
"botRecommendationStatus": "string",
"botVersion": "string",
"creationDateTime": number,
"encryptionSetting": {
"associatedTranscriptsPassword": "string",
"botLocaleExportPassword": "string",
"kmsKeyArn": "string"
},
"failureReasons": [ "string" ],
"lastUpdatedDateTime": number,
"localeId": "string",
"transcriptSourceSetting": {
"s3BucketTranscriptSource": {
"kmsKeyArn": "string",
"pathFormat": {
"objectPrefixes": [ "string" ]
},
"s3BucketName": "string",
"transcriptFilter": {
"lexTranscriptFilter": {
"dateRangeFilter": {
"endDateTime": number,
"startDateTime": number
}
}
},
"transcriptFormat": "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 identifier of the bot associated with the bot recommendation.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$ - botRecommendationId
-
The identifier of the bot recommendation being described.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$ - botRecommendationResults
-
The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.
Type: BotRecommendationResults object
- botRecommendationStatus
-
The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
Type: String
Valid Values:
Processing | Deleting | Deleted | Downloading | Updating | Available | Failed | Stopping | Stopped - botVersion
-
The version of the bot associated with the bot recommendation.
Type: String
Length Constraints: Fixed length of 5.
Pattern:
^DRAFT$ - creationDateTime
-
The date and time that the bot recommendation was created.
Type: Timestamp
- encryptionSetting
-
The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
Type: EncryptionSetting object
- failureReasons
-
If botRecommendationStatus is Failed, Amazon Lex explains why.
Type: Array of strings
- lastUpdatedDateTime
-
The date and time that the bot recommendation was last updated.
Type: Timestamp
- localeId
-
The identifier of the language and locale of the bot recommendation to describe.
Type: String
- transcriptSourceSetting
-
The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
Type: TranscriptSourceSetting 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
- 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:
