GetTestSuite
Gets a test suite.
Request Syntax
GET /testsuites/testSuiteId
?testSuiteVersion=testSuiteVersion
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- testSuiteId
-
The ID of the test suite.
Pattern:
[A-Za-z0-9:/\-]{1,100}
Required: Yes
- testSuiteVersion
-
The version of the test suite.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"afterSteps": [
{
"action": { ... },
"description": "string",
"name": "string"
}
],
"beforeSteps": [
{
"action": { ... },
"description": "string",
"name": "string"
}
],
"creationTime": number,
"description": "string",
"lastUpdateTime": number,
"latestVersion": {
"status": "string",
"statusReason": "string",
"version": number
},
"name": "string",
"status": "string",
"statusReason": "string",
"tags": {
"string" : "string"
},
"testCases": { ... },
"testSuiteArn": "string",
"testSuiteId": "string",
"testSuiteVersion": number
}
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.
- afterSteps
-
The after steps of the test suite.
Type: Array of Step objects
Array Members: Minimum number of 1 item. Maximum number of 20 items.
- beforeSteps
-
The before steps of the test suite.
Type: Array of Step objects
Array Members: Minimum number of 1 item. Maximum number of 20 items.
- creationTime
-
The creation time of the test suite.
Type: Timestamp
- description
-
The description of the test suite.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
- lastUpdateTime
-
The last update time of the test suite.
Type: Timestamp
- latestVersion
-
The latest version of the test suite.
Type: TestSuiteLatestVersion object
- name
-
The name of the test suite.
Type: String
Pattern:
[A-Za-z][A-Za-z0-9_\-]{1,59}
- status
-
The status of the test suite.
Type: String
Valid Values:
Creating | Updating | Active | Failed | Deleting
- statusReason
-
The status reason of the test suite.
Type: String
-
The tags of the test suite.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
(?!aws:).+
Value Length Constraints: Minimum length of 0. Maximum length of 256.
- testCases
-
The test cases of the test suite.
Type: TestCases object
Note: This object is a Union. Only one member of this object can be specified or returned.
- testSuiteArn
-
The test suite Amazon Resource Name (ARN).
Type: String
Pattern:
arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}
- testSuiteId
-
The response ID of the test suite.
Type: String
Pattern:
[A-Za-z0-9:/\-]{1,100}
- testSuiteVersion
-
The version of the test suite.
Type: Integer
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The account or role doesn't have the right permissions to make the request.
HTTP Status Code: 403
- InternalServerException
-
An unexpected error occurred during the processing of the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
- ThrottlingException
-
The number of requests made exceeds the limit.
HTTP Status Code: 429
- ValidationException
-
One or more parameter provided in the request is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: