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

CreateTestSuite

Creates a test suite.

Request Syntax


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

{
   "afterSteps": [ 
      { 
         "action": { ... },
         "description": "string",
         "name": "string"
      }
   ],
   "beforeSteps": [ 
      { 
         "action": { ... },
         "description": "string",
         "name": "string"
      }
   ],
   "clientToken": "string",
   "description": "string",
   "name": "string",
   "tags": { 
      "string" : "string" 
   },
   "testCases": { ... }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

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.

Required: No

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.

Required: No

clientToken

The client token of the test suite.

Type: String

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

Required: No

description

The description of the test suite.

Type: String

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

Required: No

name

The name of the test suite.

Type: String

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

Required: Yes

tags

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.

Required: No

testCases

The test cases in the test suite.

Type: TestCases object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "testSuiteId": "string",
   "testSuiteVersion": number
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

testSuiteId

The suite ID of the test suite.

Type: String

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

testSuiteVersion

The suite 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

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

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