Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetDevicePoolCompatibility

Gets information about compatibility with a device pool.

Request Syntax


{
   "appArn": "string",
   "configuration": { 
      "auxiliaryApps": [ "string" ],
      "billingMethod": "string",
      "customerArtifactPaths": { 
         "androidPaths": [ "string" ],
         "deviceHostPaths": [ "string" ],
         "iosPaths": [ "string" ]
      },
      "extraDataPackageArn": "string",
      "locale": "string",
      "location": { 
         "latitude": number,
         "longitude": number
      },
      "networkProfileArn": "string",
      "radios": { 
         "bluetooth": boolean,
         "gps": boolean,
         "nfc": boolean,
         "wifi": boolean
      },
      "vpceConfigurationArns": [ "string" ]
   },
   "devicePoolArn": "string",
   "test": { 
      "filter": "string",
      "parameters": { 
         "string" : "string" 
      },
      "testPackageArn": "string",
      "testSpecArn": "string",
      "type": "string"
   },
   "testType": "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.

appArn

The ARN of the app that is associated with the specified device pool.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 1011.

Pattern: ^arn:.+

Required: No

configuration

An object that contains information about the settings for a run.

Type: ScheduleRunConfiguration object

Required: No

devicePoolArn

The device pool's ARN.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 1011.

Pattern: ^arn:.+

Required: Yes

test

Information about the uploaded test to be run against the device pool.

Type: ScheduleRunTest object

Required: No

testType

The test type for the specified device pool.

Allowed values include the following:

BUILTIN_FUZZ.
BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT.
APPIUM_JAVA_TESTNG.
APPIUM_PYTHON.
APPIUM_NODE.
APPIUM_RUBY.
APPIUM_WEB_JAVA_JUNIT.
APPIUM_WEB_JAVA_TESTNG.
APPIUM_WEB_PYTHON.
APPIUM_WEB_NODE.
APPIUM_WEB_RUBY.
CALABASH.
INSTRUMENTATION.
UIAUTOMATION.
UIAUTOMATOR.
XCTEST.
XCTEST_UI.

Type: String

Required: No

Response Syntax


{
   "compatibleDevices": [ 
      { 
         "compatible": boolean,
         "device": { 
            "arn": "string",
            "availability": "string",
            "carrier": "string",
            "cpu": { 
               "architecture": "string",
               "clock": number,
               "frequency": "string"
            },
            "fleetName": "string",
            "fleetType": "string",
            "formFactor": "string",
            "heapSize": number,
            "image": "string",
            "instances": [ 
               { 
                  "arn": "string",
                  "deviceArn": "string",
                  "instanceProfile": { 
                     "arn": "string",
                     "description": "string",
                     "excludeAppPackagesFromCleanup": [ "string" ],
                     "name": "string",
                     "packageCleanup": boolean,
                     "rebootAfterUse": boolean
                  },
                  "labels": [ "string" ],
                  "status": "string",
                  "udid": "string"
               }
            ],
            "manufacturer": "string",
            "memory": number,
            "model": "string",
            "modelId": "string",
            "name": "string",
            "os": "string",
            "platform": "string",
            "radio": "string",
            "remoteAccessEnabled": boolean,
            "remoteDebugEnabled": boolean,
            "resolution": { 
               "height": number,
               "width": number
            }
         },
         "incompatibilityMessages": [ 
            { 
               "message": "string",
               "type": "string"
            }
         ]
      }
   ],
   "incompatibleDevices": [ 
      { 
         "compatible": boolean,
         "device": { 
            "arn": "string",
            "availability": "string",
            "carrier": "string",
            "cpu": { 
               "architecture": "string",
               "clock": number,
               "frequency": "string"
            },
            "fleetName": "string",
            "fleetType": "string",
            "formFactor": "string",
            "heapSize": number,
            "image": "string",
            "instances": [ 
               { 
                  "arn": "string",
                  "deviceArn": "string",
                  "instanceProfile": { 
                     "arn": "string",
                     "description": "string",
                     "excludeAppPackagesFromCleanup": [ "string" ],
                     "name": "string",
                     "packageCleanup": boolean,
                     "rebootAfterUse": boolean
                  },
                  "labels": [ "string" ],
                  "status": "string",
                  "udid": "string"
               }
            ],
            "manufacturer": "string",
            "memory": number,
            "model": "string",
            "modelId": "string",
            "name": "string",
            "os": "string",
            "platform": "string",
            "radio": "string",
            "remoteAccessEnabled": boolean,
            "remoteDebugEnabled": boolean,
            "resolution": { 
               "height": number,
               "width": number
            }
         },
         "incompatibilityMessages": [ 
            { 
               "message": "string",
               "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.

compatibleDevices

Information about compatible devices.

Type: Array of DevicePoolCompatibilityResult objects

incompatibleDevices

Information about incompatible devices.

Type: Array of DevicePoolCompatibilityResult 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