DescribeTestSet
Gets metadata information about the test set.
Request Syntax
GET /testsets/testSetId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- testSetId
-
The test set Id for the test set request.
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,
"description": "string",
"lastUpdatedDateTime": number,
"modality": "string",
"numTurns": number,
"roleArn": "string",
"status": "string",
"storageLocation": {
"kmsKeyArn": "string",
"s3BucketName": "string",
"s3Path": "string"
},
"testSetId": "string",
"testSetName": "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 creation date and time for the test set data.
Type: Timestamp
- description
-
The description of the test set.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 200.
- lastUpdatedDateTime
-
The date and time for the last update of the test set data.
Type: Timestamp
- modality
-
Indicates whether the test set is audio or text data.
Type: String
Valid Values:
Text | Audio - numTurns
-
The total number of agent and user turn in the test set.
Type: Integer
- roleArn
-
The roleARN used for any operation in the test set to access resources in the AWS account.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 2048.
Pattern:
^arn:aws:iam::[0-9]{12}:role/.*$ - status
-
The status of the test set.
Type: String
Valid Values:
Importing | PendingAnnotation | Deleting | ValidationError | Ready - storageLocation
-
The Amazon S3 storage location for the test set data.
Type: TestSetStorageLocation object
- testSetId
-
The test set Id for the test set response.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$ - testSetName
-
The test set name of the test set.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^([0-9a-zA-Z][_-]?){1,100}$
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:
