DescribeTestSetDiscrepancyReport
Gets metadata information about the test set discrepancy report.
Request Syntax
GET /testsetdiscrepancy/testSetDiscrepancyReportId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- testSetDiscrepancyReportId
-
The unique identifier of the test set discrepancy report.
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
{
"creationDateTime": number,
"failureReasons": [ "string" ],
"lastUpdatedDataTime": number,
"target": {
"botAliasTarget": {
"botAliasId": "string",
"botId": "string",
"localeId": "string"
}
},
"testSetDiscrepancyRawOutputUrl": "string",
"testSetDiscrepancyReportId": "string",
"testSetDiscrepancyReportStatus": "string",
"testSetDiscrepancyTopErrors": {
"intentDiscrepancies": [
{
"errorMessage": "string",
"intentName": "string"
}
],
"slotDiscrepancies": [
{
"errorMessage": "string",
"intentName": "string",
"slotName": "string"
}
]
},
"testSetId": "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.
- creationDateTime
-
The time and date of creation for the test set discrepancy report.
Type: Timestamp
- failureReasons
-
The failure report for the test set discrepancy report generation action.
Type: Array of strings
- lastUpdatedDataTime
-
The date and time of the last update for the test set discrepancy report.
Type: Timestamp
- target
-
The target bot location for the test set discrepancy report.
Type: TestSetDiscrepancyReportResourceTarget object
- testSetDiscrepancyRawOutputUrl
-
Pre-signed Amazon S3 URL to download the test set discrepancy report.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
- testSetDiscrepancyReportId
-
The unique identifier of the test set discrepancy report to describe.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$ - testSetDiscrepancyReportStatus
-
The status for the test set discrepancy report.
Type: String
Valid Values:
InProgress | Completed | Failed - testSetDiscrepancyTopErrors
-
The top 200 error results from the test set discrepancy report.
Type: TestSetDiscrepancyErrors object
- testSetId
-
The test set Id for the test set discrepancy report.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$
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:
