ListSuites
Gets information about test suites for a given job.
Request Syntax
{
"arn": "string",
"nextToken": "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.
- arn
-
The job's Amazon Resource Name (ARN).
Type: String
Length Constraints: Minimum length of 32. Maximum length of 1011.
Pattern:
^arn:.+Required: Yes
- nextToken
-
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 1024.
Required: No
Response Syntax
{
"nextToken": "string",
"suites": [
{
"arn": "string",
"counters": {
"errored": number,
"failed": number,
"passed": number,
"skipped": number,
"stopped": number,
"total": number,
"warned": number
},
"created": number,
"deviceMinutes": {
"metered": number,
"total": number,
"unmetered": number
},
"message": "string",
"name": "string",
"result": "string",
"started": number,
"status": "string",
"stopped": number,
"type": "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
-
If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 1024.
- suites
-
Information about the suites.
Type: Array of Suite objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- ArgumentException
-
An invalid argument was specified.
HTTP Status Code: 400
- LimitExceededException
-
A limit was exceeded.
HTTP Status Code: 400
- NotFoundException
-
The specified entity was not found.
HTTP Status Code: 400
- ServiceAccountException
-
There was a problem with the service account.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
