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

ListTestSuites

Lists test suites.

Request Syntax


GET /testsuites?maxResults=maxResults&nextToken=nextToken&testSuiteIds=testSuiteIds HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of test suites to return in one page of results.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

The token from a previous request to retrieve the next page of results.

Pattern: \S{1,2000}

testSuiteIds

The suite ID of the test suites.

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

{
   "nextToken": "string",
   "testSuites": [ 
      { 
         "creationTime": number,
         "lastUpdateTime": number,
         "latestVersion": number,
         "name": "string",
         "status": "string",
         "statusReason": "string",
         "testSuiteArn": "string",
         "testSuiteId": "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.

nextToken

The token from a previous request to retrieve the next page of test suites results.

Type: String

Pattern: \S{1,2000}

testSuites

The test suites returned with the response query.

Type: Array of TestSuiteSummary objects

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.

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

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