2016/07/19 - AWS Device Farm - 6 new11 updated api methods
Changes Update devicefarm client to latest version
Returns a link to a currently running remote access session.
Request Syntax
client.get_remote_access_session(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the remote access session about which you want to get session information.
dict
Response Syntax
{
'remoteAccessSession': {
'arn': 'string',
'name': 'string',
'created': datetime(2015, 1, 1),
'status': 'PENDING'|'PENDING_CONCURRENCY'|'PENDING_DEVICE'|'PROCESSING'|'SCHEDULING'|'PREPARING'|'RUNNING'|'COMPLETED'|'STOPPING',
'result': 'PENDING'|'PASSED'|'WARNED'|'FAILED'|'SKIPPED'|'ERRORED'|'STOPPED',
'message': 'string',
'started': datetime(2015, 1, 1),
'stopped': datetime(2015, 1, 1),
'device': {
'arn': 'string',
'name': 'string',
'manufacturer': 'string',
'model': '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,
'fleetType': 'string',
'fleetName': 'string'
},
'billingMethod': 'METERED'|'UNMETERED',
'deviceMinutes': {
'total': 123.0,
'metered': 123.0,
'unmetered': 123.0
},
'endpoint': 'string'
}
}
Response Structure
(dict) --
Represents the response from the server that lists detailed information about the remote access session.
remoteAccessSession (dict) --
A container that lists detailed information about the remote access session.
arn (string) --
The Amazon Resource Name (ARN) of the remote access session.
name (string) --
The name of the remote access session.
created (datetime) --
The date and time the remote access session was created.
status (string) --
The status of the remote access session. Can be any of the following:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
result (string) --
The result of the remote access session. Can be any of the following:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
message (string) --
A message about the remote access session.
started (datetime) --
The date and time the remote access session was started.
stopped (datetime) --
The date and time the remote access session was stopped.
device (dict) --
Represents a device type that an app is tested against.
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.
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) --
Represents the screen resolution of a device in height and width, expressed in pixels.
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.
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.
billingMethod (string) --
The billing method of the remote access session. Possible values include METERED or UNMETERED. For more information about metered devices, see AWS Device Farm terminology."
deviceMinutes (dict) --
Represents the total (metered or unmetered) minutes used by the resource to run tests. Contains the sum of minutes consumed by all children.
total (float) --
When specified, represents the total minutes used by the resource to run tests.
metered (float) --
When specified, represents only the sum of metered minutes used by the resource to run tests.
unmetered (float) --
When specified, represents only the sum of unmetered minutes used by the resource to run tests.
endpoint (string) --
The endpoint for the remote access sesssion.
Ends a specified remote access session.
Request Syntax
client.stop_remote_access_session(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the remote access session you wish to stop.
dict
Response Syntax
{
'remoteAccessSession': {
'arn': 'string',
'name': 'string',
'created': datetime(2015, 1, 1),
'status': 'PENDING'|'PENDING_CONCURRENCY'|'PENDING_DEVICE'|'PROCESSING'|'SCHEDULING'|'PREPARING'|'RUNNING'|'COMPLETED'|'STOPPING',
'result': 'PENDING'|'PASSED'|'WARNED'|'FAILED'|'SKIPPED'|'ERRORED'|'STOPPED',
'message': 'string',
'started': datetime(2015, 1, 1),
'stopped': datetime(2015, 1, 1),
'device': {
'arn': 'string',
'name': 'string',
'manufacturer': 'string',
'model': '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,
'fleetType': 'string',
'fleetName': 'string'
},
'billingMethod': 'METERED'|'UNMETERED',
'deviceMinutes': {
'total': 123.0,
'metered': 123.0,
'unmetered': 123.0
},
'endpoint': 'string'
}
}
Response Structure
(dict) --
Represents the response from the server that describes the remote access session when AWS Device Farm stops the session.
remoteAccessSession (dict) --
A container representing the metadata from the service about the remote access session you are stopping.
arn (string) --
The Amazon Resource Name (ARN) of the remote access session.
name (string) --
The name of the remote access session.
created (datetime) --
The date and time the remote access session was created.
status (string) --
The status of the remote access session. Can be any of the following:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
result (string) --
The result of the remote access session. Can be any of the following:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
message (string) --
A message about the remote access session.
started (datetime) --
The date and time the remote access session was started.
stopped (datetime) --
The date and time the remote access session was stopped.
device (dict) --
Represents a device type that an app is tested against.
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.
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) --
Represents the screen resolution of a device in height and width, expressed in pixels.
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.
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.
billingMethod (string) --
The billing method of the remote access session. Possible values include METERED or UNMETERED. For more information about metered devices, see AWS Device Farm terminology."
deviceMinutes (dict) --
Represents the total (metered or unmetered) minutes used by the resource to run tests. Contains the sum of minutes consumed by all children.
total (float) --
When specified, represents the total minutes used by the resource to run tests.
metered (float) --
When specified, represents only the sum of metered minutes used by the resource to run tests.
unmetered (float) --
When specified, represents only the sum of unmetered minutes used by the resource to run tests.
endpoint (string) --
The endpoint for the remote access sesssion.
Returns a list of all currently running remote access sessions.
Request Syntax
client.list_remote_access_sessions(
arn='string',
nextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.
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
{
'remoteAccessSessions': [
{
'arn': 'string',
'name': 'string',
'created': datetime(2015, 1, 1),
'status': 'PENDING'|'PENDING_CONCURRENCY'|'PENDING_DEVICE'|'PROCESSING'|'SCHEDULING'|'PREPARING'|'RUNNING'|'COMPLETED'|'STOPPING',
'result': 'PENDING'|'PASSED'|'WARNED'|'FAILED'|'SKIPPED'|'ERRORED'|'STOPPED',
'message': 'string',
'started': datetime(2015, 1, 1),
'stopped': datetime(2015, 1, 1),
'device': {
'arn': 'string',
'name': 'string',
'manufacturer': 'string',
'model': '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,
'fleetType': 'string',
'fleetName': 'string'
},
'billingMethod': 'METERED'|'UNMETERED',
'deviceMinutes': {
'total': 123.0,
'metered': 123.0,
'unmetered': 123.0
},
'endpoint': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Represents the response from the server after AWS Device Farm makes a request to return information about the remote access session.
remoteAccessSessions (list) --
A container representing the metadata from the service about each remote access session you are requesting.
(dict) --
Represents information about the remote access session.
arn (string) --
The Amazon Resource Name (ARN) of the remote access session.
name (string) --
The name of the remote access session.
created (datetime) --
The date and time the remote access session was created.
status (string) --
The status of the remote access session. Can be any of the following:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
result (string) --
The result of the remote access session. Can be any of the following:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
message (string) --
A message about the remote access session.
started (datetime) --
The date and time the remote access session was started.
stopped (datetime) --
The date and time the remote access session was stopped.
device (dict) --
Represents a device type that an app is tested against.
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.
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) --
Represents the screen resolution of a device in height and width, expressed in pixels.
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.
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.
billingMethod (string) --
The billing method of the remote access session. Possible values include METERED or UNMETERED. For more information about metered devices, see AWS Device Farm terminology."
deviceMinutes (dict) --
Represents the total (metered or unmetered) minutes used by the resource to run tests. Contains the sum of minutes consumed by all children.
total (float) --
When specified, represents the total minutes used by the resource to run tests.
metered (float) --
When specified, represents only the sum of metered minutes used by the resource to run tests.
unmetered (float) --
When specified, represents only the sum of unmetered minutes used by the resource to run tests.
endpoint (string) --
The endpoint for the remote access sesssion.
nextToken (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.
Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.
Request Syntax
client.install_to_remote_access_session(
remoteAccessSessionArn='string',
appArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the app about which you are requesting information.
dict
Response Syntax
{
'appUpload': {
'arn': 'string',
'name': 'string',
'created': datetime(2015, 1, 1),
'type': 'ANDROID_APP'|'IOS_APP'|'WEB_APP'|'EXTERNAL_DATA'|'APPIUM_JAVA_JUNIT_TEST_PACKAGE'|'APPIUM_JAVA_TESTNG_TEST_PACKAGE'|'APPIUM_PYTHON_TEST_PACKAGE'|'APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE'|'APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE'|'APPIUM_WEB_PYTHON_TEST_PACKAGE'|'CALABASH_TEST_PACKAGE'|'INSTRUMENTATION_TEST_PACKAGE'|'UIAUTOMATION_TEST_PACKAGE'|'UIAUTOMATOR_TEST_PACKAGE'|'XCTEST_TEST_PACKAGE'|'XCTEST_UI_TEST_PACKAGE',
'status': 'INITIALIZED'|'PROCESSING'|'SUCCEEDED'|'FAILED',
'url': 'string',
'metadata': 'string',
'contentType': 'string',
'message': 'string'
}
}
Response Structure
(dict) --
Represents the response from the server after AWS Device Farm makes a request to install to a remote access session.
appUpload (dict) --
An app or a set of one or more tests to upload or that have been uploaded.
arn (string) --
The upload's ARN.
name (string) --
The upload's file name.
created (datetime) --
When the upload was created.
type (string) --
The upload's type.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
WEB_APP: A web appliction upload.
EXTERNAL_DATA: An external data upload.
APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.
status (string) --
The upload's status.
Must be one of the following values:
FAILED: A failed status.
INITIALIZED: An initialized status.
PROCESSING: A processing status.
SUCCEEDED: A succeeded status.
url (string) --
The pre-signed Amazon S3 URL that was used to store a file through a corresponding PUT request.
metadata (string) --
The upload's metadata. For example, for Android, this contains information that is parsed from the manifest and is displayed in the AWS Device Farm console after the associated app is uploaded.
contentType (string) --
The upload's content type (for example, "application/octet-stream").
message (string) --
A message about the upload's result.
Deletes a completed remote access session and its results.
Request Syntax
client.delete_remote_access_session(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the sesssion for which you want to delete remote access.
dict
Response Syntax
{}
Response Structure
(dict) --
The response from the server when a request is made to delete the remote access session.
Specifies and starts a remote access session.
Request Syntax
client.create_remote_access_session(
projectArn='string',
deviceArn='string',
name='string',
configuration={
'billingMethod': 'METERED'|'UNMETERED'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the device for which you want to create a remote access session.
string
The name of the remote access session that you wish to create.
dict
The configuration information for the remote access session request.
billingMethod (string) --
Returns the billing method for purposes of configuring a remote access session.
dict
Response Syntax
{
'remoteAccessSession': {
'arn': 'string',
'name': 'string',
'created': datetime(2015, 1, 1),
'status': 'PENDING'|'PENDING_CONCURRENCY'|'PENDING_DEVICE'|'PROCESSING'|'SCHEDULING'|'PREPARING'|'RUNNING'|'COMPLETED'|'STOPPING',
'result': 'PENDING'|'PASSED'|'WARNED'|'FAILED'|'SKIPPED'|'ERRORED'|'STOPPED',
'message': 'string',
'started': datetime(2015, 1, 1),
'stopped': datetime(2015, 1, 1),
'device': {
'arn': 'string',
'name': 'string',
'manufacturer': 'string',
'model': '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,
'fleetType': 'string',
'fleetName': 'string'
},
'billingMethod': 'METERED'|'UNMETERED',
'deviceMinutes': {
'total': 123.0,
'metered': 123.0,
'unmetered': 123.0
},
'endpoint': 'string'
}
}
Response Structure
(dict) --
Represents the server response from a request to create a remote access session.
remoteAccessSession (dict) --
A container that describes the remote access session when the request to create a remote access session is sent.
arn (string) --
The Amazon Resource Name (ARN) of the remote access session.
name (string) --
The name of the remote access session.
created (datetime) --
The date and time the remote access session was created.
status (string) --
The status of the remote access session. Can be any of the following:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
result (string) --
The result of the remote access session. Can be any of the following:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
message (string) --
A message about the remote access session.
started (datetime) --
The date and time the remote access session was started.
stopped (datetime) --
The date and time the remote access session was stopped.
device (dict) --
Represents a device type that an app is tested against.
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.
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) --
Represents the screen resolution of a device in height and width, expressed in pixels.
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.
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.
billingMethod (string) --
The billing method of the remote access session. Possible values include METERED or UNMETERED. For more information about metered devices, see AWS Device Farm terminology."
deviceMinutes (dict) --
Represents the total (metered or unmetered) minutes used by the resource to run tests. Contains the sum of minutes consumed by all children.
total (float) --
When specified, represents the total minutes used by the resource to run tests.
metered (float) --
When specified, represents only the sum of metered minutes used by the resource to run tests.
unmetered (float) --
When specified, represents only the sum of unmetered minutes used by the resource to run tests.
endpoint (string) --
The endpoint for the remote access sesssion.
{'rules': {'attribute': {'REMOTE_ACCESS_ENABLED'}}}
Response {'devicePool': {'rules': {'attribute': {'REMOTE_ACCESS_ENABLED'}}}}
Creates a device pool.
Request Syntax
client.create_device_pool(
projectArn='string',
name='string',
description='string',
rules=[
{
'attribute': 'ARN'|'PLATFORM'|'FORM_FACTOR'|'MANUFACTURER'|'REMOTE_ACCESS_ENABLED',
'operator': 'EQUALS'|'LESS_THAN'|'GREATER_THAN'|'IN'|'NOT_IN',
'value': 'string'
},
]
)
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\"".
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).
operator (string) --
The rule's operator.
EQUALS: The equals operator.
GREATER_THAN: The greater-than operator.
IN: The in operator.
LESS_THAN: The less-than operator.
NOT_IN: The not-in operator.
value (string) --
The rule's value.
dict
Response Syntax
{
'devicePool': {
'arn': 'string',
'name': 'string',
'description': 'string',
'type': 'CURATED'|'PRIVATE',
'rules': [
{
'attribute': 'ARN'|'PLATFORM'|'FORM_FACTOR'|'MANUFACTURER'|'REMOTE_ACCESS_ENABLED',
'operator': 'EQUALS'|'LESS_THAN'|'GREATER_THAN'|'IN'|'NOT_IN',
'value': 'string'
},
]
}
}
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\"".
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).
operator (string) --
The rule's operator.
EQUALS: The equals operator.
GREATER_THAN: The greater-than operator.
IN: The in operator.
LESS_THAN: The less-than operator.
NOT_IN: The not-in operator.
value (string) --
The rule's value.
{'device': {'fleetName': 'string',
'fleetType': 'string',
'remoteAccessEnabled': 'boolean'}}
Gets information about a unique device type.
Request Syntax
client.get_device(
arn='string'
)
string
[REQUIRED]
The device type's ARN.
dict
Response Syntax
{
'device': {
'arn': 'string',
'name': 'string',
'manufacturer': 'string',
'model': '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,
'fleetType': 'string',
'fleetName': 'string'
}
}
Response Structure
(dict) --
Represents the result of a get device request.
device (dict) --
Represents a device type that an app is tested against.
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.
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) --
Represents the screen resolution of a device in height and width, expressed in pixels.
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.
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.
{'devicePool': {'rules': {'attribute': {'REMOTE_ACCESS_ENABLED'}}}}
Gets information about a device pool.
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',
'operator': 'EQUALS'|'LESS_THAN'|'GREATER_THAN'|'IN'|'NOT_IN',
'value': 'string'
},
]
}
}
Response Structure
(dict) --
Represents the result of a get device pool request.
devicePool (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\"".
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).
operator (string) --
The rule's operator.
EQUALS: The equals operator.
GREATER_THAN: The greater-than operator.
IN: The in operator.
LESS_THAN: The less-than operator.
NOT_IN: The not-in operator.
value (string) --
The rule's value.
{'compatibleDevices': {'device': {'fleetName': 'string',
'fleetType': 'string',
'remoteAccessEnabled': 'boolean'},
'incompatibilityMessages': {'type': {'REMOTE_ACCESS_ENABLED'}}},
'incompatibleDevices': {'device': {'fleetName': 'string',
'fleetType': 'string',
'remoteAccessEnabled': 'boolean'},
'incompatibilityMessages': {'type': {'REMOTE_ACCESS_ENABLED'}}}}
Gets information about compatibility with a device pool.
Request Syntax
client.get_device_pool_compatibility(
devicePoolArn='string',
appArn='string',
testType='BUILTIN_FUZZ'|'BUILTIN_EXPLORER'|'APPIUM_JAVA_JUNIT'|'APPIUM_JAVA_TESTNG'|'APPIUM_PYTHON'|'APPIUM_WEB_JAVA_JUNIT'|'APPIUM_WEB_JAVA_TESTNG'|'APPIUM_WEB_PYTHON'|'CALABASH'|'INSTRUMENTATION'|'UIAUTOMATION'|'UIAUTOMATOR'|'XCTEST'|'XCTEST_UI'
)
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_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.
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
Response Syntax
{
'compatibleDevices': [
{
'device': {
'arn': 'string',
'name': 'string',
'manufacturer': 'string',
'model': '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,
'fleetType': 'string',
'fleetName': 'string'
},
'compatible': True|False,
'incompatibilityMessages': [
{
'message': 'string',
'type': 'ARN'|'PLATFORM'|'FORM_FACTOR'|'MANUFACTURER'|'REMOTE_ACCESS_ENABLED'
},
]
},
],
'incompatibleDevices': [
{
'device': {
'arn': 'string',
'name': 'string',
'manufacturer': 'string',
'model': '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,
'fleetType': 'string',
'fleetName': 'string'
},
'compatible': True|False,
'incompatibilityMessages': [
{
'message': 'string',
'type': 'ARN'|'PLATFORM'|'FORM_FACTOR'|'MANUFACTURER'|'REMOTE_ACCESS_ENABLED'
},
]
},
]
}
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) --
Represents a device type that an app is tested against.
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.
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) --
Represents the screen resolution of a device in height and width, expressed in pixels.
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.
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.
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).
incompatibleDevices (list) --
Information about incompatible devices.
(dict) --
Represents a device pool compatibility result.
device (dict) --
Represents a device type that an app is tested against.
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.
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) --
Represents the screen resolution of a device in height and width, expressed in pixels.
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.
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.
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).
{'job': {'device': {'fleetName': 'string',
'fleetType': 'string',
'remoteAccessEnabled': 'boolean'}}}
Gets information about a job.
Request Syntax
client.get_job(
arn='string'
)
string
[REQUIRED]
The job's ARN.
dict
Response Syntax
{
'job': {
'arn': 'string',
'name': 'string',
'type': 'BUILTIN_FUZZ'|'BUILTIN_EXPLORER'|'APPIUM_JAVA_JUNIT'|'APPIUM_JAVA_TESTNG'|'APPIUM_PYTHON'|'APPIUM_WEB_JAVA_JUNIT'|'APPIUM_WEB_JAVA_TESTNG'|'APPIUM_WEB_PYTHON'|'CALABASH'|'INSTRUMENTATION'|'UIAUTOMATION'|'UIAUTOMATOR'|'XCTEST'|'XCTEST_UI',
'created': datetime(2015, 1, 1),
'status': 'PENDING'|'PENDING_CONCURRENCY'|'PENDING_DEVICE'|'PROCESSING'|'SCHEDULING'|'PREPARING'|'RUNNING'|'COMPLETED'|'STOPPING',
'result': 'PENDING'|'PASSED'|'WARNED'|'FAILED'|'SKIPPED'|'ERRORED'|'STOPPED',
'started': datetime(2015, 1, 1),
'stopped': datetime(2015, 1, 1),
'counters': {
'total': 123,
'passed': 123,
'failed': 123,
'warned': 123,
'errored': 123,
'stopped': 123,
'skipped': 123
},
'message': 'string',
'device': {
'arn': 'string',
'name': 'string',
'manufacturer': 'string',
'model': '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,
'fleetType': 'string',
'fleetName': 'string'
},
'deviceMinutes': {
'total': 123.0,
'metered': 123.0,
'unmetered': 123.0
}
}
}
Response Structure
(dict) --
Represents the result of a get job request.
job (dict) --
Represents a device.
arn (string) --
The job's ARN.
name (string) --
The job's name.
type (string) --
The job's type.
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_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.
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.
created (datetime) --
When the job was created.
status (string) --
The job's status.
Allowed values include:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
result (string) --
The job's result.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
started (datetime) --
The job's start time.
stopped (datetime) --
The job's stop time.
counters (dict) --
The job's result counters.
total (integer) --
The total number of entities.
passed (integer) --
The number of passed entities.
failed (integer) --
The number of failed entities.
warned (integer) --
The number of warned entities.
errored (integer) --
The number of errored entities.
stopped (integer) --
The number of stopped entities.
skipped (integer) --
The number of skipped entities.
message (string) --
A message about the job's result.
device (dict) --
Represents a device type that an app is tested against.
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.
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) --
Represents the screen resolution of a device in height and width, expressed in pixels.
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.
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.
deviceMinutes (dict) --
Represents the total (metered or unmetered) minutes used by the job.
total (float) --
When specified, represents the total minutes used by the resource to run tests.
metered (float) --
When specified, represents only the sum of metered minutes used by the resource to run tests.
unmetered (float) --
When specified, represents only the sum of unmetered minutes used by the resource to run tests.
{'artifacts': {'type': {'VIDEO_LOG'}}}
Gets information about artifacts.
Request Syntax
client.list_artifacts(
arn='string',
type='SCREENSHOT'|'FILE'|'LOG',
nextToken='string'
)
string
[REQUIRED]
The Run, Job, Suite, or Test ARN.
string
[REQUIRED]
The artifacts' type.
Allowed values include:
FILE: The artifacts are files.
LOG: The artifacts are logs.
SCREENSHOT: The artifacts are screenshots.
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
{
'artifacts': [
{
'arn': 'string',
'name': 'string',
'type': 'UNKNOWN'|'SCREENSHOT'|'DEVICE_LOG'|'MESSAGE_LOG'|'VIDEO_LOG'|'RESULT_LOG'|'SERVICE_LOG'|'WEBKIT_LOG'|'INSTRUMENTATION_OUTPUT'|'EXERCISER_MONKEY_OUTPUT'|'CALABASH_JSON_OUTPUT'|'CALABASH_PRETTY_OUTPUT'|'CALABASH_STANDARD_OUTPUT'|'CALABASH_JAVA_XML_OUTPUT'|'AUTOMATION_OUTPUT'|'APPIUM_SERVER_OUTPUT'|'APPIUM_JAVA_OUTPUT'|'APPIUM_JAVA_XML_OUTPUT'|'APPIUM_PYTHON_OUTPUT'|'APPIUM_PYTHON_XML_OUTPUT'|'EXPLORER_EVENT_LOG'|'EXPLORER_SUMMARY_LOG'|'APPLICATION_CRASH_REPORT'|'XCTEST_LOG'|'VIDEO',
'extension': 'string',
'url': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Represents the result of a list artifacts operation.
artifacts (list) --
Information about the artifacts.
(dict) --
Represents the output of a test. Examples of artifacts include logs and screenshots.
arn (string) --
The artifact's ARN.
name (string) --
The artifact's name.
type (string) --
The artifact's type.
Allowed values include the following:
UNKNOWN: An unknown type.
SCREENSHOT: The screenshot type.
DEVICE_LOG: The device log type.
MESSAGE_LOG: The message log type.
RESULT_LOG: The result log type.
SERVICE_LOG: The service log type.
WEBKIT_LOG: The web kit log type.
INSTRUMENTATION_OUTPUT: The instrumentation type.
EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by an Android fuzz test.
CALABASH_JSON_OUTPUT: The Calabash JSON output type.
CALABASH_PRETTY_OUTPUT: The Calabash pretty output type.
CALABASH_STANDARD_OUTPUT: The Calabash standard output type.
CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type.
AUTOMATION_OUTPUT: The automation output type.
APPIUM_SERVER_OUTPUT: The Appium server output type.
APPIUM_JAVA_OUTPUT: The Appium Java output type.
APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type.
APPIUM_PYTHON_OUTPUT: The Appium Python output type.
APPIUM_PYTHON_XML_OUTPUT: The Appium Python XML output type.
EXPLORER_EVENT_LOG: The Explorer event log output type.
EXPLORER_SUMMARY_LOG: The Explorer summary log output type.
APPLICATION_CRASH_REPORT: The application crash report output type.
XCTEST_LOG: The XCode test output type.
extension (string) --
The artifact's file extension.
url (string) --
The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the artifact's file.
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.
{'devicePools': {'rules': {'attribute': {'REMOTE_ACCESS_ENABLED'}}}}
Gets information about device pools.
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',
'operator': 'EQUALS'|'LESS_THAN'|'GREATER_THAN'|'IN'|'NOT_IN',
'value': 'string'
},
]
},
],
'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\"".
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).
operator (string) --
The rule's operator.
EQUALS: The equals operator.
GREATER_THAN: The greater-than operator.
IN: The in operator.
LESS_THAN: The less-than operator.
NOT_IN: The not-in operator.
value (string) --
The rule's value.
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.
{'devices': {'fleetName': 'string',
'fleetType': 'string',
'remoteAccessEnabled': 'boolean'}}
Gets information about unique device types.
Request Syntax
client.list_devices(
arn='string',
nextToken='string'
)
string
The device types' ARNs.
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
{
'devices': [
{
'arn': 'string',
'name': 'string',
'manufacturer': 'string',
'model': '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,
'fleetType': 'string',
'fleetName': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Represents the result of a list devices operation.
devices (list) --
Information about the devices.
(dict) --
Represents a device type that an app is tested against.
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.
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) --
Represents the screen resolution of a device in height and width, expressed in pixels.
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.
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.
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.
{'jobs': {'device': {'fleetName': 'string',
'fleetType': 'string',
'remoteAccessEnabled': 'boolean'}}}
Gets information about jobs.
Request Syntax
client.list_jobs(
arn='string',
nextToken='string'
)
string
[REQUIRED]
The jobs' ARNs.
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
{
'jobs': [
{
'arn': 'string',
'name': 'string',
'type': 'BUILTIN_FUZZ'|'BUILTIN_EXPLORER'|'APPIUM_JAVA_JUNIT'|'APPIUM_JAVA_TESTNG'|'APPIUM_PYTHON'|'APPIUM_WEB_JAVA_JUNIT'|'APPIUM_WEB_JAVA_TESTNG'|'APPIUM_WEB_PYTHON'|'CALABASH'|'INSTRUMENTATION'|'UIAUTOMATION'|'UIAUTOMATOR'|'XCTEST'|'XCTEST_UI',
'created': datetime(2015, 1, 1),
'status': 'PENDING'|'PENDING_CONCURRENCY'|'PENDING_DEVICE'|'PROCESSING'|'SCHEDULING'|'PREPARING'|'RUNNING'|'COMPLETED'|'STOPPING',
'result': 'PENDING'|'PASSED'|'WARNED'|'FAILED'|'SKIPPED'|'ERRORED'|'STOPPED',
'started': datetime(2015, 1, 1),
'stopped': datetime(2015, 1, 1),
'counters': {
'total': 123,
'passed': 123,
'failed': 123,
'warned': 123,
'errored': 123,
'stopped': 123,
'skipped': 123
},
'message': 'string',
'device': {
'arn': 'string',
'name': 'string',
'manufacturer': 'string',
'model': '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,
'fleetType': 'string',
'fleetName': 'string'
},
'deviceMinutes': {
'total': 123.0,
'metered': 123.0,
'unmetered': 123.0
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Represents the result of a list jobs request.
jobs (list) --
Information about the jobs.
(dict) --
Represents a device.
arn (string) --
The job's ARN.
name (string) --
The job's name.
type (string) --
The job's type.
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_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.
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.
created (datetime) --
When the job was created.
status (string) --
The job's status.
Allowed values include:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
result (string) --
The job's result.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
started (datetime) --
The job's start time.
stopped (datetime) --
The job's stop time.
counters (dict) --
The job's result counters.
total (integer) --
The total number of entities.
passed (integer) --
The number of passed entities.
failed (integer) --
The number of failed entities.
warned (integer) --
The number of warned entities.
errored (integer) --
The number of errored entities.
stopped (integer) --
The number of stopped entities.
skipped (integer) --
The number of skipped entities.
message (string) --
A message about the job's result.
device (dict) --
Represents a device type that an app is tested against.
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.
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) --
Represents the screen resolution of a device in height and width, expressed in pixels.
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.
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.
deviceMinutes (dict) --
Represents the total (metered or unmetered) minutes used by the job.
total (float) --
When specified, represents the total minutes used by the resource to run tests.
metered (float) --
When specified, represents only the sum of metered minutes used by the resource to run tests.
unmetered (float) --
When specified, represents only the sum of unmetered minutes used by the resource to run 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.
{'uniqueProblems': {'problems': {'device': {'fleetName': 'string',
'fleetType': 'string',
'remoteAccessEnabled': 'boolean'}}}}
Gets information about unique problems.
Request Syntax
client.list_unique_problems(
arn='string',
nextToken='string'
)
string
[REQUIRED]
The unique problems' ARNs.
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
{
'uniqueProblems': {
'string': [
{
'message': 'string',
'problems': [
{
'run': {
'arn': 'string',
'name': 'string'
},
'job': {
'arn': 'string',
'name': 'string'
},
'suite': {
'arn': 'string',
'name': 'string'
},
'test': {
'arn': 'string',
'name': 'string'
},
'device': {
'arn': 'string',
'name': 'string',
'manufacturer': 'string',
'model': '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,
'fleetType': 'string',
'fleetName': 'string'
},
'result': 'PENDING'|'PASSED'|'WARNED'|'FAILED'|'SKIPPED'|'ERRORED'|'STOPPED',
'message': 'string'
},
]
},
]
},
'nextToken': 'string'
}
Response Structure
(dict) --
Represents the result of a list unique problems request.
uniqueProblems (dict) --
Information about the unique problems.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
(string) --
(list) --
(dict) --
A collection of one or more problems, grouped by their result.
message (string) --
A message about the unique problems' result.
problems (list) --
Information about the problems.
(dict) --
Represents a specific warning or failure.
run (dict) --
Information about the associated run.
arn (string) --
The problem detail's ARN.
name (string) --
The problem detail's name.
job (dict) --
Information about the associated job.
arn (string) --
The problem detail's ARN.
name (string) --
The problem detail's name.
suite (dict) --
Information about the associated suite.
arn (string) --
The problem detail's ARN.
name (string) --
The problem detail's name.
test (dict) --
Information about the associated test.
arn (string) --
The problem detail's ARN.
name (string) --
The problem detail's name.
device (dict) --
Information about the associated device.
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.
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) --
Represents the screen resolution of a device in height and width, expressed in pixels.
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.
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.
result (string) --
The problem's result.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
message (string) --
A message about the problem's result.
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.
{'rules': {'attribute': {'REMOTE_ACCESS_ENABLED'}}}
Response {'devicePool': {'rules': {'attribute': {'REMOTE_ACCESS_ENABLED'}}}}
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).
Request Syntax
client.update_device_pool(
arn='string',
name='string',
description='string',
rules=[
{
'attribute': 'ARN'|'PLATFORM'|'FORM_FACTOR'|'MANUFACTURER'|'REMOTE_ACCESS_ENABLED',
'operator': 'EQUALS'|'LESS_THAN'|'GREATER_THAN'|'IN'|'NOT_IN',
'value': 'string'
},
]
)
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\"".
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).
operator (string) --
The rule's operator.
EQUALS: The equals operator.
GREATER_THAN: The greater-than operator.
IN: The in operator.
LESS_THAN: The less-than operator.
NOT_IN: The not-in operator.
value (string) --
The rule's value.
dict
Response Syntax
{
'devicePool': {
'arn': 'string',
'name': 'string',
'description': 'string',
'type': 'CURATED'|'PRIVATE',
'rules': [
{
'attribute': 'ARN'|'PLATFORM'|'FORM_FACTOR'|'MANUFACTURER'|'REMOTE_ACCESS_ENABLED',
'operator': 'EQUALS'|'LESS_THAN'|'GREATER_THAN'|'IN'|'NOT_IN',
'value': 'string'
},
]
}
}
Response Structure
(dict) --
Represents the result of an update device pool request.
devicePool (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\"".
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).
operator (string) --
The rule's operator.
EQUALS: The equals operator.
GREATER_THAN: The greater-than operator.
IN: The in operator.
LESS_THAN: The less-than operator.
NOT_IN: The not-in operator.
value (string) --
The rule's value.