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

StartTestRun

Starts a test run.

Request Syntax


POST /testrun HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "tags": { 
      "string" : "string" 
   },
   "testConfigurationId": "string",
   "testSuiteId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

The client token of the test run.

Type: String

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

Required: No

tags

The tags of the test run.

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.

Required: No

testConfigurationId

The configuration ID of the test run.

Type: String

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

Required: No

testSuiteId

The test suite ID of the test run.

Type: String

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

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "testRunId": "string",
   "testRunStatus": "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.

testRunId

The test run ID of the test run.

Type: String

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

testRunStatus

The test run status of the test run.

Type: String

Valid Values: Success | Running | Failed | Deleting

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

ConflictException

The parameters provided in the request conflict with existing resources.

resourceId: The resource ID of the conflicts with existing resources.
resourceType: The resource type of the conflicts with existing resources.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred during the processing of the request.

retryAfterSeconds: The number of seconds to retry the query.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found.

resourceId: The resource ID of the resource not found.
resourceType: The resource type of the resource not found.

HTTP Status Code: 404

ServiceQuotaExceededException

One or more quotas for AWS Mainframe Modernization Application Testing exceeds the limit.

quotaCode: The quote codes of AWS Mainframe Modernization Application Testing that exceeded the limit.
resourceId: The resource ID of AWS Mainframe Modernization Application Testing that exceeded the limit.
resourceType: The resource type of AWS Mainframe Modernization Application Testing that exceeded the limit.
serviceCode: The service code of AWS Mainframe Modernization Application Testing that exceeded the limit.

HTTP Status Code: 402

ThrottlingException

The number of requests made exceeds the limit.

quotaCode: The quota code of requests that exceed the limit.
retryAfterSeconds: The number of seconds to retry after for requests that exceed the limit.
serviceCode: The service code of requests that exceed the limit.

HTTP Status Code: 429

ValidationException

One or more parameter provided in the request is not valid.

fieldList: The field list of the validation exception.
reason: The reason for the validation exception.

HTTP Status Code: 400