Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetTestCase

Gets a test case.

Request Syntax


GET /testcases/testCaseId?testCaseVersion=testCaseVersion HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

testCaseId

The request test ID of the test case.

Pattern: [A-Za-z0-9:/\-]{1,100}

Required: Yes

testCaseVersion

The test case version of the test case.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "creationTime": number,
   "description": "string",
   "lastUpdateTime": number,
   "latestVersion": { 
      "status": "string",
      "statusReason": "string",
      "version": number
   },
   "name": "string",
   "status": "string",
   "statusReason": "string",
   "steps": [ 
      { 
         "action": { ... },
         "description": "string",
         "name": "string"
      }
   ],
   "tags": { 
      "string" : "string" 
   },
   "testCaseArn": "string",
   "testCaseId": "string",
   "testCaseVersion": 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.

creationTime

The creation time of the test case.

Type: Timestamp

description

The description of the test case.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

lastUpdateTime

The last update time of the test case.

Type: Timestamp

latestVersion

The latest version of the test case.

Type: TestCaseLatestVersion object

name

The name of the test case.

Type: String

Pattern: [A-Za-z][A-Za-z0-9_\-]{1,59}

status

The status of the test case.

Type: String

Valid Values: Active | Deleting

statusReason

The status reason of the test case.

Type: String

steps

The steps of the test case.

Type: Array of Step objects

Array Members: Minimum number of 1 item. Maximum number of 20 items.

tags

The tags of the test case.

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.

testCaseArn

The Amazon Resource Name (ARN) of the test case.

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}

testCaseId

The response test ID of the test case.

Type: String

Pattern: [A-Za-z0-9:/\-]{1,100}

testCaseVersion

The case version of the test case.

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