Menu
AWS Device Farm
API Reference (API Version 2015-06-23)

GetSuite

Gets information about a suite.

Request Syntax

{
   "arn": "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 suite's ARN.

Type: String

Length Constraints: Minimum length of 32.

Required: Yes

Response Syntax

{
   "suite": { 
      "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.

suite

A collection of one or more tests.

Type: Suite object

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: