GetTestRunStep
Gets a test run step.
Request Syntax
GET /testruns/testRunId/steps/stepName?testCaseId=testCaseId&testSuiteId=testSuiteId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- stepName
-
The step name of the test run step.
Pattern:
[A-Za-z][A-Za-z0-9_\-]{1,59}Required: Yes
- testCaseId
-
The test case ID of a test run step.
Pattern:
[A-Za-z0-9:/\-]{1,100} - testRunId
-
The test run ID of the test run step.
Pattern:
[A-Za-z0-9:/\-]{1,100}Required: Yes
- testSuiteId
-
The test suite ID of a test run step.
Pattern:
[A-Za-z0-9:/\-]{1,100}
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"afterStep": boolean,
"beforeStep": boolean,
"runEndTime": number,
"runStartTime": number,
"status": "string",
"statusReason": "string",
"stepName": "string",
"stepRunSummary": { ... },
"testCaseId": "string",
"testCaseVersion": number,
"testRunId": "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.
- afterStep
-
The after steps of the test run step.
Type: Boolean
- beforeStep
-
The before steps of the test run step.
Type: Boolean
- runEndTime
-
The run end time of the test run step.
Type: Timestamp
- runStartTime
-
The run start time of the test run step.
Type: Timestamp
- status
-
The status of the test run step.
Type: String
Valid Values:
Success | Failed | Running - statusReason
-
The status reason of the test run step.
Type: String
- stepName
-
The step name of the test run step.
Type: String
Pattern:
[A-Za-z][A-Za-z0-9_\-]{1,59} - stepRunSummary
-
The step run summary of the test run step.
Type: StepRunSummary object
Note: This object is a Union. Only one member of this object can be specified or returned.
- testCaseId
-
The test case ID of the test run step.
Type: String
Pattern:
[A-Za-z0-9:/\-]{1,100} - testCaseVersion
-
The test case version of the test run step.
Type: Integer
- testRunId
-
The test run ID of the test run step.
Type: String
Pattern:
[A-Za-z0-9:/\-]{1,100} - testSuiteId
-
The test suite ID of the test run step.
Type: String
Pattern:
[A-Za-z0-9:/\-]{1,100} - testSuiteVersion
-
The test suite version of the test run step.
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:
