Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeTestCases

Returns a list of details about test cases for a report.

Request Syntax


{
   "filter": { 
      "keyword": "string",
      "status": "string"
   },
   "maxResults": number,
   "nextToken": "string",
   "reportArn": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

reportArn

The ARN of the report for which test cases are returned.

Type: String

Required: Yes

filter

A TestCaseFilter object used to filter the returned reports.

Type: TestCaseFilter object

Required: No

maxResults

The maximum number of paginated test cases returned per response. Use nextToken to iterate pages in the list of returned TestCase objects. The default value is 100.

Type: Integer

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

Required: No

nextToken

During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

Type: String

Required: No

Response Syntax


{
   "nextToken": "string",
   "testCases": [ 
      { 
         "durationInNanoSeconds": number,
         "expired": number,
         "message": "string",
         "name": "string",
         "prefix": "string",
         "reportArn": "string",
         "status": "string",
         "testRawDataPath": "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

Type: String

testCases

The returned list of test cases.

Type: Array of TestCase objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidInputException

The input value that was provided is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified AWS resource cannot be found.

HTTP Status Code: 400