2019/01/25 - AWS Device Farm - 5 updated api methods
Changes Introduces a new rule in Device Pools - "Availability". Customers can now ensure they pick devices that are available (i.e., not being used by other customers).
{'maxDevices': 'integer',
'rules': {'attribute': ['AVAILABILITY', 'OS_VERSION', 'MODEL'],
'operator': ['LESS_THAN_OR_EQUALS', 'GREATER_THAN_OR_EQUALS']}}
Response {'devicePool': {'maxDevices': 'integer',
'rules': {'attribute': ['AVAILABILITY', 'OS_VERSION', 'MODEL'],
'operator': ['LESS_THAN_OR_EQUALS',
'GREATER_THAN_OR_EQUALS']}}}
Creates a device pool.
See also: AWS API Documentation
Request Syntax
client.create_device_pool(
projectArn='string',
name='string',
description='string',
rules=[
{
'attribute': 'ARN'|'PLATFORM'|'FORM_FACTOR'|'MANUFACTURER'|'REMOTE_ACCESS_ENABLED'|'REMOTE_DEBUG_ENABLED'|'APPIUM_VERSION'|'INSTANCE_ARN'|'INSTANCE_LABELS'|'FLEET_TYPE'|'OS_VERSION'|'MODEL'|'AVAILABILITY',
'operator': 'EQUALS'|'LESS_THAN'|'LESS_THAN_OR_EQUALS'|'GREATER_THAN'|'GREATER_THAN_OR_EQUALS'|'IN'|'NOT_IN'|'CONTAINS',
'value': 'string'
},
],
maxDevices=123
)
string
[REQUIRED]
The ARN of the project for the device pool.
string
[REQUIRED]
The device pool's name.
string
The device pool's description.
list
[REQUIRED]
The device pool's rules.
(dict) --
Represents a condition for a device pool.
attribute (string) --
The rule's stringified attribute. For example, specify the value as "\"abc\"" .
The supported operators for each attribute are provided in the following list.
APPIUM_VERSION
The Appium version for the test.
Supported operators : CONTAINS
ARN
The Amazon Resource Name (ARN) of the device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example".
Supported operators : EQUALS , IN , NOT_IN
AVAILABILITY
The current availability of the device. Valid values are "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE".
Supported operators : EQUALS
FLEET_TYPE
The fleet type. Valid values are "PUBLIC" or "PRIVATE".
Supported operators : EQUALS
FORM_FACTOR
The device form factor. Valid values are "PHONE" or "TABLET".
Supported operators : EQUALS , IN , NOT_IN
INSTANCE_ARN
The Amazon Resource Name (ARN) of the device instance.
Supported operators : IN , NOT_IN
INSTANCE_LABELS
The label of the device instance.
Supported operators : CONTAINS
MANUFACTURER
The device manufacturer. For example, "Apple".
Supported operators : EQUALS , IN , NOT_IN
MODEL
The device model, such as "Apple iPad Air 2" or "Google Pixel".
Supported operators : CONTAINS , EQUALS , IN , NOT_IN
OS_VERSION
The operating system version. For example, "10.3.2".
Supported operators : EQUALS , GREATER_THAN , GREATER_THAN_OR_EQUALS , IN , LESS_THAN , LESS_THAN_OR_EQUALS , NOT_IN
PLATFORM
The device platform. Valid values are "ANDROID" or "IOS".
Supported operators : EQUALS , IN , NOT_IN
REMOTE_ACCESS_ENABLED
Whether the device is enabled for remote access. Valid values are "TRUE" or "FALSE".
Supported operators : EQUALS
REMOTE_DEBUG_ENABLED
Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE".
Supported operators : EQUALS
operator (string) --
Specifies how Device Farm compares the rule's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.
value (string) --
The rule's value.
integer
The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.
By specifying the maximum number of devices, you can control the costs that you incur by running tests.
dict
Response Syntax
{
'devicePool': {
'arn': 'string',
'name': 'string',
'description': 'string',
'type': 'CURATED'|'PRIVATE',
'rules': [
{
'attribute': 'ARN'|'PLATFORM'|'FORM_FACTOR'|'MANUFACTURER'|'REMOTE_ACCESS_ENABLED'|'REMOTE_DEBUG_ENABLED'|'APPIUM_VERSION'|'INSTANCE_ARN'|'INSTANCE_LABELS'|'FLEET_TYPE'|'OS_VERSION'|'MODEL'|'AVAILABILITY',
'operator': 'EQUALS'|'LESS_THAN'|'LESS_THAN_OR_EQUALS'|'GREATER_THAN'|'GREATER_THAN_OR_EQUALS'|'IN'|'NOT_IN'|'CONTAINS',
'value': 'string'
},
],
'maxDevices': 123
}
}
Response Structure
(dict) --
Represents the result of a create device pool request.
devicePool (dict) --
The newly created device pool.
arn (string) --
The device pool's ARN.
name (string) --
The device pool's name.
description (string) --
The device pool's description.
type (string) --
The device pool's type.
Allowed values include:
CURATED: A device pool that is created and managed by AWS Device Farm.
PRIVATE: A device pool that is created and managed by the device pool developer.
rules (list) --
Information about the device pool's rules.
(dict) --
Represents a condition for a device pool.
attribute (string) --
The rule's stringified attribute. For example, specify the value as "\"abc\"" .
The supported operators for each attribute are provided in the following list.
APPIUM_VERSION
The Appium version for the test.
Supported operators : CONTAINS
ARN
The Amazon Resource Name (ARN) of the device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example".
Supported operators : EQUALS , IN , NOT_IN
AVAILABILITY
The current availability of the device. Valid values are "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE".
Supported operators : EQUALS
FLEET_TYPE
The fleet type. Valid values are "PUBLIC" or "PRIVATE".
Supported operators : EQUALS
FORM_FACTOR
The device form factor. Valid values are "PHONE" or "TABLET".
Supported operators : EQUALS , IN , NOT_IN
INSTANCE_ARN
The Amazon Resource Name (ARN) of the device instance.
Supported operators : IN , NOT_IN
INSTANCE_LABELS
The label of the device instance.
Supported operators : CONTAINS
MANUFACTURER
The device manufacturer. For example, "Apple".
Supported operators : EQUALS , IN , NOT_IN
MODEL
The device model, such as "Apple iPad Air 2" or "Google Pixel".
Supported operators : CONTAINS , EQUALS , IN , NOT_IN
OS_VERSION
The operating system version. For example, "10.3.2".
Supported operators : EQUALS , GREATER_THAN , GREATER_THAN_OR_EQUALS , IN , LESS_THAN , LESS_THAN_OR_EQUALS , NOT_IN
PLATFORM
The device platform. Valid values are "ANDROID" or "IOS".
Supported operators : EQUALS , IN , NOT_IN
REMOTE_ACCESS_ENABLED
Whether the device is enabled for remote access. Valid values are "TRUE" or "FALSE".
Supported operators : EQUALS
REMOTE_DEBUG_ENABLED
Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE".
Supported operators : EQUALS
operator (string) --
Specifies how Device Farm compares the rule's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.
value (string) --
The rule's value.
maxDevices (integer) --
The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.
By specifying the maximum number of devices, you can control the costs that you incur by running tests.
{'devicePool': {'maxDevices': 'integer',
'rules': {'attribute': ['AVAILABILITY', 'OS_VERSION', 'MODEL'],
'operator': ['LESS_THAN_OR_EQUALS',
'GREATER_THAN_OR_EQUALS']}}}
Gets information about a device pool.
See also: AWS API Documentation
Request Syntax
client.get_device_pool(
arn='string'
)
string
[REQUIRED]
The device pool's ARN.
dict
Response Syntax
{
'devicePool': {
'arn': 'string',
'name': 'string',
'description': 'string',
'type': 'CURATED'|'PRIVATE',
'rules': [
{
'attribute': 'ARN'|'PLATFORM'|'FORM_FACTOR'|'MANUFACTURER'|'REMOTE_ACCESS_ENABLED'|'REMOTE_DEBUG_ENABLED'|'APPIUM_VERSION'|'INSTANCE_ARN'|'INSTANCE_LABELS'|'FLEET_TYPE'|'OS_VERSION'|'MODEL'|'AVAILABILITY',
'operator': 'EQUALS'|'LESS_THAN'|'LESS_THAN_OR_EQUALS'|'GREATER_THAN'|'GREATER_THAN_OR_EQUALS'|'IN'|'NOT_IN'|'CONTAINS',
'value': 'string'
},
],
'maxDevices': 123
}
}
Response Structure
(dict) --
Represents the result of a get device pool request.
devicePool (dict) --
An object containing information about the requested device pool.
arn (string) --
The device pool's ARN.
name (string) --
The device pool's name.
description (string) --
The device pool's description.
type (string) --
The device pool's type.
Allowed values include:
CURATED: A device pool that is created and managed by AWS Device Farm.
PRIVATE: A device pool that is created and managed by the device pool developer.
rules (list) --
Information about the device pool's rules.
(dict) --
Represents a condition for a device pool.
attribute (string) --
The rule's stringified attribute. For example, specify the value as "\"abc\"" .
The supported operators for each attribute are provided in the following list.
APPIUM_VERSION
The Appium version for the test.
Supported operators : CONTAINS
ARN
The Amazon Resource Name (ARN) of the device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example".
Supported operators : EQUALS , IN , NOT_IN
AVAILABILITY
The current availability of the device. Valid values are "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE".
Supported operators : EQUALS
FLEET_TYPE
The fleet type. Valid values are "PUBLIC" or "PRIVATE".
Supported operators : EQUALS
FORM_FACTOR
The device form factor. Valid values are "PHONE" or "TABLET".
Supported operators : EQUALS , IN , NOT_IN
INSTANCE_ARN
The Amazon Resource Name (ARN) of the device instance.
Supported operators : IN , NOT_IN
INSTANCE_LABELS
The label of the device instance.
Supported operators : CONTAINS
MANUFACTURER
The device manufacturer. For example, "Apple".
Supported operators : EQUALS , IN , NOT_IN
MODEL
The device model, such as "Apple iPad Air 2" or "Google Pixel".
Supported operators : CONTAINS , EQUALS , IN , NOT_IN
OS_VERSION
The operating system version. For example, "10.3.2".
Supported operators : EQUALS , GREATER_THAN , GREATER_THAN_OR_EQUALS , IN , LESS_THAN , LESS_THAN_OR_EQUALS , NOT_IN
PLATFORM
The device platform. Valid values are "ANDROID" or "IOS".
Supported operators : EQUALS , IN , NOT_IN
REMOTE_ACCESS_ENABLED
Whether the device is enabled for remote access. Valid values are "TRUE" or "FALSE".
Supported operators : EQUALS
REMOTE_DEBUG_ENABLED
Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE".
Supported operators : EQUALS
operator (string) --
Specifies how Device Farm compares the rule's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.
value (string) --
The rule's value.
maxDevices (integer) --
The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.
By specifying the maximum number of devices, you can control the costs that you incur by running tests.
{'compatibleDevices': {'incompatibilityMessages': {'type': ['AVAILABILITY',
'OS_VERSION',
'MODEL']}},
'incompatibleDevices': {'incompatibilityMessages': {'type': ['AVAILABILITY',
'OS_VERSION',
'MODEL']}}}
Gets information about compatibility with a device pool.
See also: AWS API Documentation
Request Syntax
client.get_device_pool_compatibility(
devicePoolArn='string',
appArn='string',
testType='BUILTIN_FUZZ'|'BUILTIN_EXPLORER'|'WEB_PERFORMANCE_PROFILE'|'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'|'REMOTE_ACCESS_RECORD'|'REMOTE_ACCESS_REPLAY',
test={
'type': 'BUILTIN_FUZZ'|'BUILTIN_EXPLORER'|'WEB_PERFORMANCE_PROFILE'|'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'|'REMOTE_ACCESS_RECORD'|'REMOTE_ACCESS_REPLAY',
'testPackageArn': 'string',
'testSpecArn': 'string',
'filter': 'string',
'parameters': {
'string': 'string'
}
},
configuration={
'extraDataPackageArn': 'string',
'networkProfileArn': 'string',
'locale': 'string',
'location': {
'latitude': 123.0,
'longitude': 123.0
},
'vpceConfigurationArns': [
'string',
],
'customerArtifactPaths': {
'iosPaths': [
'string',
],
'androidPaths': [
'string',
],
'deviceHostPaths': [
'string',
]
},
'radios': {
'wifi': True|False,
'bluetooth': True|False,
'nfc': True|False,
'gps': True|False
},
'auxiliaryApps': [
'string',
],
'billingMethod': 'METERED'|'UNMETERED'
}
)
string
[REQUIRED]
The device pool's ARN.
string
The ARN of the app that is associated with the specified device pool.
string
The test type for the specified device pool.
Allowed values include the following:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_NODE: The Appium Node.js type.
APPIUM_RUBY: The Appium Ruby type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.
APPIUM_WEB_PYTHON: The Appium Python type for web apps.
APPIUM_WEB_NODE: The Appium Node.js type for web apps.
APPIUM_WEB_RUBY: The Appium Ruby type for web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
dict
Information about the uploaded test to be run against the device pool.
type (string) -- [REQUIRED]
The test's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_NODE: The Appium Node.js type.
APPIUM_RUBY: The Appium Ruby type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.
APPIUM_WEB_PYTHON: The Appium Python type for web apps.
APPIUM_WEB_NODE: The Appium Node.js type for web apps.
APPIUM_WEB_RUBY: The Appium Ruby type for web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
testPackageArn (string) --
The ARN of the uploaded test that will be run.
testSpecArn (string) --
The ARN of the YAML-formatted test specification.
filter (string) --
The test's filter.
parameters (dict) --
The test's parameters, such as test framework parameters and fixture settings. Parameters are represented by name-value pairs of strings.
For all tests:
app_performance_monitoring: Performance monitoring is enabled by default. Set this parameter to "false" to disable it.
For Calabash tests:
profile: A cucumber profile, for example, "my_profile_name".
tags: You can limit execution to features or scenarios that have (or don't have) certain tags, for example, "@smoke" or "@smoke,~@wip".
For Appium tests (all types):
appium_version: The Appium version. Currently supported values are "1.6.5" (and higher), "latest", and "default".
“latest” will run the latest Appium version supported by Device Farm (1.9.1).
For “default”, Device Farm will choose a compatible version of Appium for the device. The current behavior is to run 1.7.2 on Android devices and iOS 9 and earlier, 1.7.2 for iOS 10 and later.
This behavior is subject to change.
For Fuzz tests (Android only):
event_count: The number of events, between 1 and 10000, that the UI fuzz test should perform.
throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait between events.
seed: A seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.
For Explorer tests:
username: A username to use if the Explorer encounters a login form. If not supplied, no username will be inserted.
password: A password to use if the Explorer encounters a login form. If not supplied, no password will be inserted.
For Instrumentation:
filter: A test filter string. Examples:
Running a single test case: "com.android.abc.Test1"
Running a single test: "com.android.abc.Test1#smoke"
Running multiple tests: "com.android.abc.Test1,com.android.abc.Test2"
For XCTest and XCTestUI:
filter: A test filter string. Examples:
Running a single test class: "LoginTests"
Running a multiple test classes: "LoginTests,SmokeTests"
Running a single test: "LoginTests/testValid"
Running multiple tests: "LoginTests/testValid,LoginTests/testInvalid"
For UIAutomator:
filter: A test filter string. Examples:
Running a single test case: "com.android.abc.Test1"
Running a single test: "com.android.abc.Test1#smoke"
Running multiple tests: "com.android.abc.Test1,com.android.abc.Test2"
(string) --
(string) --
dict
An object containing information about the settings for a run.
extraDataPackageArn (string) --
The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm will extract to external data for Android or the app's sandbox for iOS.
networkProfileArn (string) --
Reserved for internal use.
locale (string) --
Information about the locale that is used for the run.
location (dict) --
Information about the location that is used for the run.
latitude (float) -- [REQUIRED]
The latitude.
longitude (float) -- [REQUIRED]
The longitude.
vpceConfigurationArns (list) --
An array of Amazon Resource Names (ARNs) for your VPC endpoint configurations.
(string) --
customerArtifactPaths (dict) --
Input CustomerArtifactPaths object for the scheduled run configuration.
iosPaths (list) --
Comma-separated list of paths on the iOS device where the artifacts generated by the customer's tests will be pulled from.
(string) --
androidPaths (list) --
Comma-separated list of paths on the Android device where the artifacts generated by the customer's tests will be pulled from.
(string) --
deviceHostPaths (list) --
Comma-separated list of paths in the test execution environment where the artifacts generated by the customer's tests will be pulled from.
(string) --
radios (dict) --
Information about the radio states for the run.
wifi (boolean) --
True if Wi-Fi is enabled at the beginning of the test; otherwise, false.
bluetooth (boolean) --
True if Bluetooth is enabled at the beginning of the test; otherwise, false.
nfc (boolean) --
True if NFC is enabled at the beginning of the test; otherwise, false.
gps (boolean) --
True if GPS is enabled at the beginning of the test; otherwise, false.
auxiliaryApps (list) --
A list of auxiliary apps for the run.
(string) --
billingMethod (string) --
Specifies the billing method for a test run: metered or unmetered . If the parameter is not specified, the default value is metered .
dict
Response Syntax
{
'compatibleDevices': [
{
'device': {
'arn': 'string',
'name': 'string',
'manufacturer': 'string',
'model': 'string',
'modelId': 'string',
'formFactor': 'PHONE'|'TABLET',
'platform': 'ANDROID'|'IOS',
'os': 'string',
'cpu': {
'frequency': 'string',
'architecture': 'string',
'clock': 123.0
},
'resolution': {
'width': 123,
'height': 123
},
'heapSize': 123,
'memory': 123,
'image': 'string',
'carrier': 'string',
'radio': 'string',
'remoteAccessEnabled': True|False,
'remoteDebugEnabled': True|False,
'fleetType': 'string',
'fleetName': 'string',
'instances': [
{
'arn': 'string',
'deviceArn': 'string',
'labels': [
'string',
],
'status': 'IN_USE'|'PREPARING'|'AVAILABLE'|'NOT_AVAILABLE',
'udid': 'string',
'instanceProfile': {
'arn': 'string',
'packageCleanup': True|False,
'excludeAppPackagesFromCleanup': [
'string',
],
'rebootAfterUse': True|False,
'name': 'string',
'description': 'string'
}
},
],
'availability': 'TEMPORARY_NOT_AVAILABLE'|'BUSY'|'AVAILABLE'|'HIGHLY_AVAILABLE'
},
'compatible': True|False,
'incompatibilityMessages': [
{
'message': 'string',
'type': 'ARN'|'PLATFORM'|'FORM_FACTOR'|'MANUFACTURER'|'REMOTE_ACCESS_ENABLED'|'REMOTE_DEBUG_ENABLED'|'APPIUM_VERSION'|'INSTANCE_ARN'|'INSTANCE_LABELS'|'FLEET_TYPE'|'OS_VERSION'|'MODEL'|'AVAILABILITY'
},
]
},
],
'incompatibleDevices': [
{
'device': {
'arn': 'string',
'name': 'string',
'manufacturer': 'string',
'model': 'string',
'modelId': 'string',
'formFactor': 'PHONE'|'TABLET',
'platform': 'ANDROID'|'IOS',
'os': 'string',
'cpu': {
'frequency': 'string',
'architecture': 'string',
'clock': 123.0
},
'resolution': {
'width': 123,
'height': 123
},
'heapSize': 123,
'memory': 123,
'image': 'string',
'carrier': 'string',
'radio': 'string',
'remoteAccessEnabled': True|False,
'remoteDebugEnabled': True|False,
'fleetType': 'string',
'fleetName': 'string',
'instances': [
{
'arn': 'string',
'deviceArn': 'string',
'labels': [
'string',
],
'status': 'IN_USE'|'PREPARING'|'AVAILABLE'|'NOT_AVAILABLE',
'udid': 'string',
'instanceProfile': {
'arn': 'string',
'packageCleanup': True|False,
'excludeAppPackagesFromCleanup': [
'string',
],
'rebootAfterUse': True|False,
'name': 'string',
'description': 'string'
}
},
],
'availability': 'TEMPORARY_NOT_AVAILABLE'|'BUSY'|'AVAILABLE'|'HIGHLY_AVAILABLE'
},
'compatible': True|False,
'incompatibilityMessages': [
{
'message': 'string',
'type': 'ARN'|'PLATFORM'|'FORM_FACTOR'|'MANUFACTURER'|'REMOTE_ACCESS_ENABLED'|'REMOTE_DEBUG_ENABLED'|'APPIUM_VERSION'|'INSTANCE_ARN'|'INSTANCE_LABELS'|'FLEET_TYPE'|'OS_VERSION'|'MODEL'|'AVAILABILITY'
},
]
},
]
}
Response Structure
(dict) --
Represents the result of describe device pool compatibility request.
compatibleDevices (list) --
Information about compatible devices.
(dict) --
Represents a device pool compatibility result.
device (dict) --
The device (phone or tablet) that you wish to return information about.
arn (string) --
The device's ARN.
name (string) --
The device's display name.
manufacturer (string) --
The device's manufacturer name.
model (string) --
The device's model name.
modelId (string) --
The device's model ID.
formFactor (string) --
The device's form factor.
Allowed values include:
PHONE: The phone form factor.
TABLET: The tablet form factor.
platform (string) --
The device's platform.
Allowed values include:
ANDROID: The Android platform.
IOS: The iOS platform.
os (string) --
The device's operating system type.
cpu (dict) --
Information about the device's CPU.
frequency (string) --
The CPU's frequency.
architecture (string) --
The CPU's architecture, for example x86 or ARM.
clock (float) --
The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000.
resolution (dict) --
The resolution of the device.
width (integer) --
The screen resolution's width, expressed in pixels.
height (integer) --
The screen resolution's height, expressed in pixels.
heapSize (integer) --
The device's heap size, expressed in bytes.
memory (integer) --
The device's total memory size, expressed in bytes.
image (string) --
The device's image name.
carrier (string) --
The device's carrier.
radio (string) --
The device's radio.
remoteAccessEnabled (boolean) --
Specifies whether remote access has been enabled for the specified device.
remoteDebugEnabled (boolean) --
This flag is set to true if remote debugging is enabled for the device.
fleetType (string) --
The type of fleet to which this device belongs. Possible values for fleet type are PRIVATE and PUBLIC.
fleetName (string) --
The name of the fleet to which this device belongs.
instances (list) --
The instances belonging to this device.
(dict) --
Represents the device instance.
arn (string) --
The Amazon Resource Name (ARN) of the device instance.
deviceArn (string) --
The Amazon Resource Name (ARN) of the device.
labels (list) --
An array of strings describing the device instance.
(string) --
status (string) --
The status of the device instance. Valid values are listed below.
udid (string) --
Unique device identifier for the device instance.
instanceProfile (dict) --
A object containing information about the instance profile.
arn (string) --
The Amazon Resource Name (ARN) of the instance profile.
packageCleanup (boolean) --
When set to true , Device Farm will remove app packages after a test run. The default value is false for private devices.
excludeAppPackagesFromCleanup (list) --
An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over.
The list of packages is only considered if you set packageCleanup to true .
(string) --
rebootAfterUse (boolean) --
When set to true , Device Farm will reboot the instance after a test run. The default value is true .
name (string) --
The name of the instance profile.
description (string) --
The description of the instance profile.
availability (string) --
Reflects how likely a device will be available for a test run. It is currently available in the ListDevices and GetDevice API methods.
compatible (boolean) --
Whether the result was compatible with the device pool.
incompatibilityMessages (list) --
Information about the compatibility.
(dict) --
Represents information about incompatibility.
message (string) --
A message about the incompatibility.
type (string) --
The type of incompatibility.
Allowed values include:
ARN: The ARN.
FORM_FACTOR: The form factor (for example, phone or tablet).
MANUFACTURER: The manufacturer.
PLATFORM: The platform (for example, Android or iOS).
REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.
APPIUM_VERSION: The Appium version for the test.
incompatibleDevices (list) --
Information about incompatible devices.
(dict) --
Represents a device pool compatibility result.
device (dict) --
The device (phone or tablet) that you wish to return information about.
arn (string) --
The device's ARN.
name (string) --
The device's display name.
manufacturer (string) --
The device's manufacturer name.
model (string) --
The device's model name.
modelId (string) --
The device's model ID.
formFactor (string) --
The device's form factor.
Allowed values include:
PHONE: The phone form factor.
TABLET: The tablet form factor.
platform (string) --
The device's platform.
Allowed values include:
ANDROID: The Android platform.
IOS: The iOS platform.
os (string) --
The device's operating system type.
cpu (dict) --
Information about the device's CPU.
frequency (string) --
The CPU's frequency.
architecture (string) --
The CPU's architecture, for example x86 or ARM.
clock (float) --
The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000.
resolution (dict) --
The resolution of the device.
width (integer) --
The screen resolution's width, expressed in pixels.
height (integer) --
The screen resolution's height, expressed in pixels.
heapSize (integer) --
The device's heap size, expressed in bytes.
memory (integer) --
The device's total memory size, expressed in bytes.
image (string) --
The device's image name.
carrier (string) --
The device's carrier.
radio (string) --
The device's radio.
remoteAccessEnabled (boolean) --
Specifies whether remote access has been enabled for the specified device.
remoteDebugEnabled (boolean) --
This flag is set to true if remote debugging is enabled for the device.
fleetType (string) --
The type of fleet to which this device belongs. Possible values for fleet type are PRIVATE and PUBLIC.
fleetName (string) --
The name of the fleet to which this device belongs.
instances (list) --
The instances belonging to this device.
(dict) --
Represents the device instance.
arn (string) --
The Amazon Resource Name (ARN) of the device instance.
deviceArn (string) --
The Amazon Resource Name (ARN) of the device.
labels (list) --
An array of strings describing the device instance.
(string) --
status (string) --
The status of the device instance. Valid values are listed below.
udid (string) --
Unique device identifier for the device instance.
instanceProfile (dict) --
A object containing information about the instance profile.
arn (string) --
The Amazon Resource Name (ARN) of the instance profile.
packageCleanup (boolean) --
When set to true , Device Farm will remove app packages after a test run. The default value is false for private devices.
excludeAppPackagesFromCleanup (list) --
An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over.
The list of packages is only considered if you set packageCleanup to true .
(string) --
rebootAfterUse (boolean) --
When set to true , Device Farm will reboot the instance after a test run. The default value is true .
name (string) --
The name of the instance profile.
description (string) --
The description of the instance profile.
availability (string) --
Reflects how likely a device will be available for a test run. It is currently available in the ListDevices and GetDevice API methods.
compatible (boolean) --
Whether the result was compatible with the device pool.
incompatibilityMessages (list) --
Information about the compatibility.
(dict) --
Represents information about incompatibility.
message (string) --
A message about the incompatibility.
type (string) --
The type of incompatibility.
Allowed values include:
ARN: The ARN.
FORM_FACTOR: The form factor (for example, phone or tablet).
MANUFACTURER: The manufacturer.
PLATFORM: The platform (for example, Android or iOS).
REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.
APPIUM_VERSION: The Appium version for the test.
{'devicePools': {'maxDevices': 'integer',
'rules': {'attribute': ['AVAILABILITY', 'OS_VERSION', 'MODEL'],
'operator': ['LESS_THAN_OR_EQUALS',
'GREATER_THAN_OR_EQUALS']}}}
Gets information about device pools.
See also: AWS API Documentation
Request Syntax
client.list_device_pools(
arn='string',
type='CURATED'|'PRIVATE',
nextToken='string'
)
string
[REQUIRED]
The project ARN.
string
The device pools' type.
Allowed values include:
CURATED: A device pool that is created and managed by AWS Device Farm.
PRIVATE: A device pool that is created and managed by the device pool developer.
string
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.
dict
Response Syntax
{
'devicePools': [
{
'arn': 'string',
'name': 'string',
'description': 'string',
'type': 'CURATED'|'PRIVATE',
'rules': [
{
'attribute': 'ARN'|'PLATFORM'|'FORM_FACTOR'|'MANUFACTURER'|'REMOTE_ACCESS_ENABLED'|'REMOTE_DEBUG_ENABLED'|'APPIUM_VERSION'|'INSTANCE_ARN'|'INSTANCE_LABELS'|'FLEET_TYPE'|'OS_VERSION'|'MODEL'|'AVAILABILITY',
'operator': 'EQUALS'|'LESS_THAN'|'LESS_THAN_OR_EQUALS'|'GREATER_THAN'|'GREATER_THAN_OR_EQUALS'|'IN'|'NOT_IN'|'CONTAINS',
'value': 'string'
},
],
'maxDevices': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Represents the result of a list device pools request.
devicePools (list) --
Information about the device pools.
(dict) --
Represents a collection of device types.
arn (string) --
The device pool's ARN.
name (string) --
The device pool's name.
description (string) --
The device pool's description.
type (string) --
The device pool's type.
Allowed values include:
CURATED: A device pool that is created and managed by AWS Device Farm.
PRIVATE: A device pool that is created and managed by the device pool developer.
rules (list) --
Information about the device pool's rules.
(dict) --
Represents a condition for a device pool.
attribute (string) --
The rule's stringified attribute. For example, specify the value as "\"abc\"" .
The supported operators for each attribute are provided in the following list.
APPIUM_VERSION
The Appium version for the test.
Supported operators : CONTAINS
ARN
The Amazon Resource Name (ARN) of the device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example".
Supported operators : EQUALS , IN , NOT_IN
AVAILABILITY
The current availability of the device. Valid values are "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE".
Supported operators : EQUALS
FLEET_TYPE
The fleet type. Valid values are "PUBLIC" or "PRIVATE".
Supported operators : EQUALS
FORM_FACTOR
The device form factor. Valid values are "PHONE" or "TABLET".
Supported operators : EQUALS , IN , NOT_IN
INSTANCE_ARN
The Amazon Resource Name (ARN) of the device instance.
Supported operators : IN , NOT_IN
INSTANCE_LABELS
The label of the device instance.
Supported operators : CONTAINS
MANUFACTURER
The device manufacturer. For example, "Apple".
Supported operators : EQUALS , IN , NOT_IN
MODEL
The device model, such as "Apple iPad Air 2" or "Google Pixel".
Supported operators : CONTAINS , EQUALS , IN , NOT_IN
OS_VERSION
The operating system version. For example, "10.3.2".
Supported operators : EQUALS , GREATER_THAN , GREATER_THAN_OR_EQUALS , IN , LESS_THAN , LESS_THAN_OR_EQUALS , NOT_IN
PLATFORM
The device platform. Valid values are "ANDROID" or "IOS".
Supported operators : EQUALS , IN , NOT_IN
REMOTE_ACCESS_ENABLED
Whether the device is enabled for remote access. Valid values are "TRUE" or "FALSE".
Supported operators : EQUALS
REMOTE_DEBUG_ENABLED
Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE".
Supported operators : EQUALS
operator (string) --
Specifies how Device Farm compares the rule's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.
value (string) --
The rule's value.
maxDevices (integer) --
The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.
By specifying the maximum number of devices, you can control the costs that you incur by running tests.
nextToken (string) --
If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
{'clearMaxDevices': 'boolean',
'maxDevices': 'integer',
'rules': {'attribute': ['AVAILABILITY', 'OS_VERSION', 'MODEL'],
'operator': ['LESS_THAN_OR_EQUALS', 'GREATER_THAN_OR_EQUALS']}}
Response {'devicePool': {'maxDevices': 'integer',
'rules': {'attribute': ['AVAILABILITY', 'OS_VERSION', 'MODEL'],
'operator': ['LESS_THAN_OR_EQUALS',
'GREATER_THAN_OR_EQUALS']}}}
Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).
See also: AWS API Documentation
Request Syntax
client.update_device_pool(
arn='string',
name='string',
description='string',
rules=[
{
'attribute': 'ARN'|'PLATFORM'|'FORM_FACTOR'|'MANUFACTURER'|'REMOTE_ACCESS_ENABLED'|'REMOTE_DEBUG_ENABLED'|'APPIUM_VERSION'|'INSTANCE_ARN'|'INSTANCE_LABELS'|'FLEET_TYPE'|'OS_VERSION'|'MODEL'|'AVAILABILITY',
'operator': 'EQUALS'|'LESS_THAN'|'LESS_THAN_OR_EQUALS'|'GREATER_THAN'|'GREATER_THAN_OR_EQUALS'|'IN'|'NOT_IN'|'CONTAINS',
'value': 'string'
},
],
maxDevices=123,
clearMaxDevices=True|False
)
string
[REQUIRED]
The Amazon Resourc Name (ARN) of the Device Farm device pool you wish to update.
string
A string representing the name of the device pool you wish to update.
string
A description of the device pool you wish to update.
list
Represents the rules you wish to modify for the device pool. Updating rules is optional; however, if you choose to update rules for your request, the update will replace the existing rules.
(dict) --
Represents a condition for a device pool.
attribute (string) --
The rule's stringified attribute. For example, specify the value as "\"abc\"" .
The supported operators for each attribute are provided in the following list.
APPIUM_VERSION
The Appium version for the test.
Supported operators : CONTAINS
ARN
The Amazon Resource Name (ARN) of the device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example".
Supported operators : EQUALS , IN , NOT_IN
AVAILABILITY
The current availability of the device. Valid values are "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE".
Supported operators : EQUALS
FLEET_TYPE
The fleet type. Valid values are "PUBLIC" or "PRIVATE".
Supported operators : EQUALS
FORM_FACTOR
The device form factor. Valid values are "PHONE" or "TABLET".
Supported operators : EQUALS , IN , NOT_IN
INSTANCE_ARN
The Amazon Resource Name (ARN) of the device instance.
Supported operators : IN , NOT_IN
INSTANCE_LABELS
The label of the device instance.
Supported operators : CONTAINS
MANUFACTURER
The device manufacturer. For example, "Apple".
Supported operators : EQUALS , IN , NOT_IN
MODEL
The device model, such as "Apple iPad Air 2" or "Google Pixel".
Supported operators : CONTAINS , EQUALS , IN , NOT_IN
OS_VERSION
The operating system version. For example, "10.3.2".
Supported operators : EQUALS , GREATER_THAN , GREATER_THAN_OR_EQUALS , IN , LESS_THAN , LESS_THAN_OR_EQUALS , NOT_IN
PLATFORM
The device platform. Valid values are "ANDROID" or "IOS".
Supported operators : EQUALS , IN , NOT_IN
REMOTE_ACCESS_ENABLED
Whether the device is enabled for remote access. Valid values are "TRUE" or "FALSE".
Supported operators : EQUALS
REMOTE_DEBUG_ENABLED
Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE".
Supported operators : EQUALS
operator (string) --
Specifies how Device Farm compares the rule's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.
value (string) --
The rule's value.
integer
The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.
By specifying the maximum number of devices, you can control the costs that you incur by running tests.
If you use this parameter in your request, you cannot use the clearMaxDevices parameter in the same request.
boolean
Sets whether the maxDevices parameter applies to your device pool. If you set this parameter to true , the maxDevices parameter does not apply, and Device Farm does not limit the number of devices that it adds to your device pool. In this case, Device Farm adds all available devices that meet the criteria that are specified for the rules parameter.
If you use this parameter in your request, you cannot use the maxDevices parameter in the same request.
dict
Response Syntax
{
'devicePool': {
'arn': 'string',
'name': 'string',
'description': 'string',
'type': 'CURATED'|'PRIVATE',
'rules': [
{
'attribute': 'ARN'|'PLATFORM'|'FORM_FACTOR'|'MANUFACTURER'|'REMOTE_ACCESS_ENABLED'|'REMOTE_DEBUG_ENABLED'|'APPIUM_VERSION'|'INSTANCE_ARN'|'INSTANCE_LABELS'|'FLEET_TYPE'|'OS_VERSION'|'MODEL'|'AVAILABILITY',
'operator': 'EQUALS'|'LESS_THAN'|'LESS_THAN_OR_EQUALS'|'GREATER_THAN'|'GREATER_THAN_OR_EQUALS'|'IN'|'NOT_IN'|'CONTAINS',
'value': 'string'
},
],
'maxDevices': 123
}
}
Response Structure
(dict) --
Represents the result of an update device pool request.
devicePool (dict) --
The device pool you just updated.
arn (string) --
The device pool's ARN.
name (string) --
The device pool's name.
description (string) --
The device pool's description.
type (string) --
The device pool's type.
Allowed values include:
CURATED: A device pool that is created and managed by AWS Device Farm.
PRIVATE: A device pool that is created and managed by the device pool developer.
rules (list) --
Information about the device pool's rules.
(dict) --
Represents a condition for a device pool.
attribute (string) --
The rule's stringified attribute. For example, specify the value as "\"abc\"" .
The supported operators for each attribute are provided in the following list.
APPIUM_VERSION
The Appium version for the test.
Supported operators : CONTAINS
ARN
The Amazon Resource Name (ARN) of the device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example".
Supported operators : EQUALS , IN , NOT_IN
AVAILABILITY
The current availability of the device. Valid values are "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE".
Supported operators : EQUALS
FLEET_TYPE
The fleet type. Valid values are "PUBLIC" or "PRIVATE".
Supported operators : EQUALS
FORM_FACTOR
The device form factor. Valid values are "PHONE" or "TABLET".
Supported operators : EQUALS , IN , NOT_IN
INSTANCE_ARN
The Amazon Resource Name (ARN) of the device instance.
Supported operators : IN , NOT_IN
INSTANCE_LABELS
The label of the device instance.
Supported operators : CONTAINS
MANUFACTURER
The device manufacturer. For example, "Apple".
Supported operators : EQUALS , IN , NOT_IN
MODEL
The device model, such as "Apple iPad Air 2" or "Google Pixel".
Supported operators : CONTAINS , EQUALS , IN , NOT_IN
OS_VERSION
The operating system version. For example, "10.3.2".
Supported operators : EQUALS , GREATER_THAN , GREATER_THAN_OR_EQUALS , IN , LESS_THAN , LESS_THAN_OR_EQUALS , NOT_IN
PLATFORM
The device platform. Valid values are "ANDROID" or "IOS".
Supported operators : EQUALS , IN , NOT_IN
REMOTE_ACCESS_ENABLED
Whether the device is enabled for remote access. Valid values are "TRUE" or "FALSE".
Supported operators : EQUALS
REMOTE_DEBUG_ENABLED
Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE".
Supported operators : EQUALS
operator (string) --
Specifies how Device Farm compares the rule's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.
value (string) --
The rule's value.
maxDevices (integer) --
The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.
By specifying the maximum number of devices, you can control the costs that you incur by running tests.