2018/08/15 - AWS Device Farm - 2 new 12 updated api methods
Changes Support for running tests in a custom environment with live logs/video streaming, full test features parity and reduction in overall test execution time.
Initiates a stop request for the current job. AWS Device Farm will immediately stop the job on the device where tests have not started executing, and you will not be billed for this device. On the device where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on the device. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.
See also: AWS API Documentation
Request Syntax
client.stop_job(
arn='string'
)
string
[REQUIRED]
Represents the Amazon Resource Name (ARN) of the Device Farm job you wish to stop.
dict
Response Syntax
{
'job': {
'arn': 'string',
'name': 'string',
'type': 'BUILTIN_FUZZ'|'BUILTIN_EXPLORER'|'WEB_PERFORMANCE_PROFILE'|'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'|'REMOTE_ACCESS_RECORD'|'REMOTE_ACCESS_REPLAY',
'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',
'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'
}
},
]
},
'instanceArn': 'string',
'deviceMinutes': {
'total': 123.0,
'metered': 123.0,
'unmetered': 123.0
},
'videoEndpoint': 'string',
'videoCapture': True|False
}
}
Response Structure
(dict) --
job (dict) --
The job that was stopped.
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) --
The device (phone or tablet).
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.
instanceArn (string) --
The Amazon Resource Name (ARN) of the instance.
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.
videoEndpoint (string) --
The endpoint for streaming device video.
videoCapture (boolean) --
This value is set to true if video capture is enabled; otherwise, it is set to false.
Update an uploaded test specification (test spec).
See also: AWS API Documentation
Request Syntax
client.update_upload(
arn='string',
name='string',
contentType='string',
editContent=True|False
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the uploaded test spec.
string
The upload's test spec file name. The name should not contain the '/' character. The test spec file name must end with the .yaml or .yml file extension.
string
The upload's content type (for example, "application/x-yaml").
boolean
Set to true if the YAML file has changed and needs to be updated; otherwise, set to false.
dict
Response Syntax
{
'upload': {
'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'|'APPIUM_JAVA_JUNIT_TEST_SPEC'|'APPIUM_JAVA_TESTNG_TEST_SPEC'|'APPIUM_PYTHON_TEST_SPEC'|'APPIUM_WEB_JAVA_JUNIT_TEST_SPEC'|'APPIUM_WEB_JAVA_TESTNG_TEST_SPEC'|'APPIUM_WEB_PYTHON_TEST_SPEC'|'INSTRUMENTATION_TEST_SPEC'|'XCTEST_UI_TEST_SPEC',
'status': 'INITIALIZED'|'PROCESSING'|'SUCCEEDED'|'FAILED',
'url': 'string',
'metadata': 'string',
'contentType': 'string',
'message': 'string',
'category': 'CURATED'|'PRIVATE'
}
}
Response Structure
(dict) --
upload (dict) --
A test spec uploaded to Device Farm.
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.
category (string) --
The upload's category. Allowed values include:
CURATED: An upload managed by AWS Device Farm.
PRIVATE: An upload managed by the AWS Device Farm customer.
{'type': ['APPIUM_PYTHON_TEST_SPEC',
'APPIUM_WEB_PYTHON_TEST_SPEC',
'APPIUM_JAVA_JUNIT_TEST_SPEC',
'XCTEST_UI_TEST_SPEC',
'INSTRUMENTATION_TEST_SPEC',
'APPIUM_WEB_JAVA_JUNIT_TEST_SPEC',
'APPIUM_WEB_JAVA_TESTNG_TEST_SPEC',
'APPIUM_JAVA_TESTNG_TEST_SPEC']}
Response {'upload': {'category': 'CURATED | PRIVATE',
'type': ['APPIUM_PYTHON_TEST_SPEC',
'APPIUM_WEB_PYTHON_TEST_SPEC',
'APPIUM_JAVA_JUNIT_TEST_SPEC',
'XCTEST_UI_TEST_SPEC',
'INSTRUMENTATION_TEST_SPEC',
'APPIUM_WEB_JAVA_JUNIT_TEST_SPEC',
'APPIUM_WEB_JAVA_TESTNG_TEST_SPEC',
'APPIUM_JAVA_TESTNG_TEST_SPEC']}}
Uploads an app or test scripts.
See also: AWS API Documentation
Request Syntax
client.create_upload(
projectArn='string',
name='string',
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'|'APPIUM_JAVA_JUNIT_TEST_SPEC'|'APPIUM_JAVA_TESTNG_TEST_SPEC'|'APPIUM_PYTHON_TEST_SPEC'|'APPIUM_WEB_JAVA_JUNIT_TEST_SPEC'|'APPIUM_WEB_JAVA_TESTNG_TEST_SPEC'|'APPIUM_WEB_PYTHON_TEST_SPEC'|'INSTRUMENTATION_TEST_SPEC'|'XCTEST_UI_TEST_SPEC',
contentType='string'
)
string
[REQUIRED]
The ARN of the project for the upload.
string
[REQUIRED]
The upload's file name. The name should not contain the '/' character. If uploading an iOS app, the file name needs to end with the .ipa extension. If uploading an Android app, the file name needs to end with the .apk extension. For all others, the file name must end with the .zip file extension.
string
[REQUIRED]
The upload's upload type.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
WEB_APP: A web application 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.
Note If you call CreateUpload with WEB_APP specified, AWS Device Farm throws an ArgumentException error.
string
The upload's content type (for example, "application/octet-stream").
dict
Response Syntax
{
'upload': {
'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'|'APPIUM_JAVA_JUNIT_TEST_SPEC'|'APPIUM_JAVA_TESTNG_TEST_SPEC'|'APPIUM_PYTHON_TEST_SPEC'|'APPIUM_WEB_JAVA_JUNIT_TEST_SPEC'|'APPIUM_WEB_JAVA_TESTNG_TEST_SPEC'|'APPIUM_WEB_PYTHON_TEST_SPEC'|'INSTRUMENTATION_TEST_SPEC'|'XCTEST_UI_TEST_SPEC',
'status': 'INITIALIZED'|'PROCESSING'|'SUCCEEDED'|'FAILED',
'url': 'string',
'metadata': 'string',
'contentType': 'string',
'message': 'string',
'category': 'CURATED'|'PRIVATE'
}
}
Response Structure
(dict) --
Represents the result of a create upload request.
upload (dict) --
The newly created upload.
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.
category (string) --
The upload's category. Allowed values include:
CURATED: An upload managed by AWS Device Farm.
PRIVATE: An upload managed by the AWS Device Farm customer.
{'test': {'testSpecArn': 'string'}}
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_WEB_JAVA_JUNIT'|'APPIUM_WEB_JAVA_TESTNG'|'APPIUM_WEB_PYTHON'|'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_WEB_JAVA_JUNIT'|'APPIUM_WEB_JAVA_TESTNG'|'APPIUM_WEB_PYTHON'|'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_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
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_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.
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 the following test framework parameters and fixture settings:
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.4.16", "1.6.3", "latest", and "default".
“latest” will run the latest Appium version supported by Device Farm (1.6.3).
For “default”, Device Farm will choose a compatible version of Appium for the device. The current behavior is to run 1.4.16 on Android devices and iOS 9 and earlier, 1.6.3 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'
}
},
]
},
'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'
},
]
},
],
'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'
}
},
]
},
'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'
},
]
},
]
}
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.
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.
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.
{'job': {'videoCapture': 'boolean', 'videoEndpoint': 'string'}}
Gets information about a job.
See also: AWS API Documentation
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'|'WEB_PERFORMANCE_PROFILE'|'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'|'REMOTE_ACCESS_RECORD'|'REMOTE_ACCESS_REPLAY',
'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',
'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'
}
},
]
},
'instanceArn': 'string',
'deviceMinutes': {
'total': 123.0,
'metered': 123.0,
'unmetered': 123.0
},
'videoEndpoint': 'string',
'videoCapture': True|False
}
}
Response Structure
(dict) --
Represents the result of a get job request.
job (dict) --
An object containing information about the requested job.
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) --
The device (phone or tablet).
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.
instanceArn (string) --
The Amazon Resource Name (ARN) of the instance.
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.
videoEndpoint (string) --
The endpoint for streaming device video.
videoCapture (boolean) --
This value is set to true if video capture is enabled; otherwise, it is set to false.
{'run': {'testSpecArn': 'string'}}
Gets information about a run.
See also: AWS API Documentation
Request Syntax
client.get_run(
arn='string'
)
string
[REQUIRED]
The run's ARN.
dict
Response Syntax
{
'run': {
'arn': 'string',
'name': 'string',
'type': 'BUILTIN_FUZZ'|'BUILTIN_EXPLORER'|'WEB_PERFORMANCE_PROFILE'|'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'|'REMOTE_ACCESS_RECORD'|'REMOTE_ACCESS_REPLAY',
'platform': 'ANDROID'|'IOS',
'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',
'totalJobs': 123,
'completedJobs': 123,
'billingMethod': 'METERED'|'UNMETERED',
'deviceMinutes': {
'total': 123.0,
'metered': 123.0,
'unmetered': 123.0
},
'networkProfile': {
'arn': 'string',
'name': 'string',
'description': 'string',
'type': 'CURATED'|'PRIVATE',
'uplinkBandwidthBits': 123,
'downlinkBandwidthBits': 123,
'uplinkDelayMs': 123,
'downlinkDelayMs': 123,
'uplinkJitterMs': 123,
'downlinkJitterMs': 123,
'uplinkLossPercent': 123,
'downlinkLossPercent': 123
},
'parsingResultUrl': 'string',
'resultCode': 'PARSING_FAILED'|'VPC_ENDPOINT_SETUP_FAILED',
'seed': 123,
'appUpload': 'string',
'eventCount': 123,
'jobTimeoutMinutes': 123,
'devicePoolArn': 'string',
'locale': 'string',
'radios': {
'wifi': True|False,
'bluetooth': True|False,
'nfc': True|False,
'gps': True|False
},
'location': {
'latitude': 123.0,
'longitude': 123.0
},
'customerArtifactPaths': {
'iosPaths': [
'string',
],
'androidPaths': [
'string',
],
'deviceHostPaths': [
'string',
]
},
'webUrl': 'string',
'skipAppResign': True|False,
'testSpecArn': 'string'
}
}
Response Structure
(dict) --
Represents the result of a get run request.
run (dict) --
The run you wish to get results from.
arn (string) --
The run's ARN.
name (string) --
The run's name.
type (string) --
The run'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_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.
platform (string) --
The run's platform.
Allowed values include:
ANDROID: The Android platform.
IOS: The iOS platform.
created (datetime) --
When the run was created.
status (string) --
The run'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 run'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 run's start time.
stopped (datetime) --
The run's stop time.
counters (dict) --
The run'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 run's result.
totalJobs (integer) --
The total number of jobs for the run.
completedJobs (integer) --
The total number of completed jobs.
billingMethod (string) --
Specifies the billing method for a test run: metered or unmetered . If the parameter is not specified, the default value is metered .
deviceMinutes (dict) --
Represents the total (metered or unmetered) minutes used by the test run.
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.
networkProfile (dict) --
The network profile being used for a test run.
arn (string) --
The Amazon Resource Name (ARN) of the network profile.
name (string) --
The name of the network profile.
description (string) --
The description of the network profile.
type (string) --
The type of network profile. Valid values are listed below.
uplinkBandwidthBits (integer) --
The data throughput rate in bits per second, as an integer from 0 to 104857600.
downlinkBandwidthBits (integer) --
The data throughput rate in bits per second, as an integer from 0 to 104857600.
uplinkDelayMs (integer) --
Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
downlinkDelayMs (integer) --
Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
uplinkJitterMs (integer) --
Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
downlinkJitterMs (integer) --
Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
uplinkLossPercent (integer) --
Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
downlinkLossPercent (integer) --
Proportion of received packets that fail to arrive from 0 to 100 percent.
parsingResultUrl (string) --
Read-only URL for an object in S3 bucket where you can get the parsing results of the test package. If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points to.
resultCode (string) --
Supporting field for the result field. Set only if result is SKIPPED . PARSING_FAILED if the result is skipped because of test package parsing failure.
seed (integer) --
For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.
appUpload (string) --
An app to upload or that has been uploaded.
eventCount (integer) --
For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.
jobTimeoutMinutes (integer) --
The number of minutes the job will execute before it times out.
devicePoolArn (string) --
The ARN of the device pool for the run.
locale (string) --
Information about the locale that is used for the run.
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.
location (dict) --
Information about the location that is used for the run.
latitude (float) --
The latitude.
longitude (float) --
The longitude.
customerArtifactPaths (dict) --
Output CustomerArtifactPaths object for the test run.
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) --
webUrl (string) --
The Device Farm console URL for the recording of the run.
skipAppResign (boolean) --
When set to true , for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.
For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs .
testSpecArn (string) --
The ARN of the YAML-formatted test specification for the run.
{'upload': {'category': 'CURATED | PRIVATE',
'type': ['APPIUM_PYTHON_TEST_SPEC',
'APPIUM_WEB_PYTHON_TEST_SPEC',
'APPIUM_JAVA_JUNIT_TEST_SPEC',
'XCTEST_UI_TEST_SPEC',
'INSTRUMENTATION_TEST_SPEC',
'APPIUM_WEB_JAVA_JUNIT_TEST_SPEC',
'APPIUM_WEB_JAVA_TESTNG_TEST_SPEC',
'APPIUM_JAVA_TESTNG_TEST_SPEC']}}
Gets information about an upload.
See also: AWS API Documentation
Request Syntax
client.get_upload(
arn='string'
)
string
[REQUIRED]
The upload's ARN.
dict
Response Syntax
{
'upload': {
'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'|'APPIUM_JAVA_JUNIT_TEST_SPEC'|'APPIUM_JAVA_TESTNG_TEST_SPEC'|'APPIUM_PYTHON_TEST_SPEC'|'APPIUM_WEB_JAVA_JUNIT_TEST_SPEC'|'APPIUM_WEB_JAVA_TESTNG_TEST_SPEC'|'APPIUM_WEB_PYTHON_TEST_SPEC'|'INSTRUMENTATION_TEST_SPEC'|'XCTEST_UI_TEST_SPEC',
'status': 'INITIALIZED'|'PROCESSING'|'SUCCEEDED'|'FAILED',
'url': 'string',
'metadata': 'string',
'contentType': 'string',
'message': 'string',
'category': 'CURATED'|'PRIVATE'
}
}
Response Structure
(dict) --
Represents the result of a get upload request.
upload (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.
category (string) --
The upload's category. Allowed values include:
CURATED: An upload managed by AWS Device Farm.
PRIVATE: An upload managed by the AWS Device Farm customer.
{'appUpload': {'category': 'CURATED | PRIVATE',
'type': ['APPIUM_PYTHON_TEST_SPEC',
'APPIUM_WEB_PYTHON_TEST_SPEC',
'APPIUM_JAVA_JUNIT_TEST_SPEC',
'XCTEST_UI_TEST_SPEC',
'INSTRUMENTATION_TEST_SPEC',
'APPIUM_WEB_JAVA_JUNIT_TEST_SPEC',
'APPIUM_WEB_JAVA_TESTNG_TEST_SPEC',
'APPIUM_JAVA_TESTNG_TEST_SPEC']}}
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.
See also: AWS API Documentation
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'|'APPIUM_JAVA_JUNIT_TEST_SPEC'|'APPIUM_JAVA_TESTNG_TEST_SPEC'|'APPIUM_PYTHON_TEST_SPEC'|'APPIUM_WEB_JAVA_JUNIT_TEST_SPEC'|'APPIUM_WEB_JAVA_TESTNG_TEST_SPEC'|'APPIUM_WEB_PYTHON_TEST_SPEC'|'INSTRUMENTATION_TEST_SPEC'|'XCTEST_UI_TEST_SPEC',
'status': 'INITIALIZED'|'PROCESSING'|'SUCCEEDED'|'FAILED',
'url': 'string',
'metadata': 'string',
'contentType': 'string',
'message': 'string',
'category': 'CURATED'|'PRIVATE'
}
}
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 to upload or that has 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.
category (string) --
The upload's category. Allowed values include:
CURATED: An upload managed by AWS Device Farm.
PRIVATE: An upload managed by the AWS Device Farm customer.
{'artifacts': {'type': ['TESTSPEC_OUTPUT']}}
Gets information about artifacts.
See also: AWS API Documentation
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'|'CUSTOMER_ARTIFACT'|'CUSTOMER_ARTIFACT_LOG'|'TESTSPEC_OUTPUT',
'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.
{'jobs': {'videoCapture': 'boolean', 'videoEndpoint': 'string'}}
Gets information about jobs for a given test run.
See also: AWS API Documentation
Request Syntax
client.list_jobs(
arn='string',
nextToken='string'
)
string
[REQUIRED]
The run's Amazon Resource Name (ARN).
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'|'WEB_PERFORMANCE_PROFILE'|'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'|'REMOTE_ACCESS_RECORD'|'REMOTE_ACCESS_REPLAY',
'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',
'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'
}
},
]
},
'instanceArn': 'string',
'deviceMinutes': {
'total': 123.0,
'metered': 123.0,
'unmetered': 123.0
},
'videoEndpoint': 'string',
'videoCapture': True|False
},
],
'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) --
The device (phone or tablet).
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.
instanceArn (string) --
The Amazon Resource Name (ARN) of the instance.
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.
videoEndpoint (string) --
The endpoint for streaming device video.
videoCapture (boolean) --
This value is set to true if video capture is enabled; otherwise, it is set to false.
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.
{'runs': {'testSpecArn': 'string'}}
Gets information about runs, given an AWS Device Farm project ARN.
See also: AWS API Documentation
Request Syntax
client.list_runs(
arn='string',
nextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the project for which you want to list runs.
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
{
'runs': [
{
'arn': 'string',
'name': 'string',
'type': 'BUILTIN_FUZZ'|'BUILTIN_EXPLORER'|'WEB_PERFORMANCE_PROFILE'|'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'|'REMOTE_ACCESS_RECORD'|'REMOTE_ACCESS_REPLAY',
'platform': 'ANDROID'|'IOS',
'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',
'totalJobs': 123,
'completedJobs': 123,
'billingMethod': 'METERED'|'UNMETERED',
'deviceMinutes': {
'total': 123.0,
'metered': 123.0,
'unmetered': 123.0
},
'networkProfile': {
'arn': 'string',
'name': 'string',
'description': 'string',
'type': 'CURATED'|'PRIVATE',
'uplinkBandwidthBits': 123,
'downlinkBandwidthBits': 123,
'uplinkDelayMs': 123,
'downlinkDelayMs': 123,
'uplinkJitterMs': 123,
'downlinkJitterMs': 123,
'uplinkLossPercent': 123,
'downlinkLossPercent': 123
},
'parsingResultUrl': 'string',
'resultCode': 'PARSING_FAILED'|'VPC_ENDPOINT_SETUP_FAILED',
'seed': 123,
'appUpload': 'string',
'eventCount': 123,
'jobTimeoutMinutes': 123,
'devicePoolArn': 'string',
'locale': 'string',
'radios': {
'wifi': True|False,
'bluetooth': True|False,
'nfc': True|False,
'gps': True|False
},
'location': {
'latitude': 123.0,
'longitude': 123.0
},
'customerArtifactPaths': {
'iosPaths': [
'string',
],
'androidPaths': [
'string',
],
'deviceHostPaths': [
'string',
]
},
'webUrl': 'string',
'skipAppResign': True|False,
'testSpecArn': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Represents the result of a list runs request.
runs (list) --
Information about the runs.
(dict) --
Represents a test run on a set of devices with a given app package, test parameters, etc.
arn (string) --
The run's ARN.
name (string) --
The run's name.
type (string) --
The run'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_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.
platform (string) --
The run's platform.
Allowed values include:
ANDROID: The Android platform.
IOS: The iOS platform.
created (datetime) --
When the run was created.
status (string) --
The run'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 run'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 run's start time.
stopped (datetime) --
The run's stop time.
counters (dict) --
The run'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 run's result.
totalJobs (integer) --
The total number of jobs for the run.
completedJobs (integer) --
The total number of completed jobs.
billingMethod (string) --
Specifies the billing method for a test run: metered or unmetered . If the parameter is not specified, the default value is metered .
deviceMinutes (dict) --
Represents the total (metered or unmetered) minutes used by the test run.
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.
networkProfile (dict) --
The network profile being used for a test run.
arn (string) --
The Amazon Resource Name (ARN) of the network profile.
name (string) --
The name of the network profile.
description (string) --
The description of the network profile.
type (string) --
The type of network profile. Valid values are listed below.
uplinkBandwidthBits (integer) --
The data throughput rate in bits per second, as an integer from 0 to 104857600.
downlinkBandwidthBits (integer) --
The data throughput rate in bits per second, as an integer from 0 to 104857600.
uplinkDelayMs (integer) --
Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
downlinkDelayMs (integer) --
Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
uplinkJitterMs (integer) --
Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
downlinkJitterMs (integer) --
Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
uplinkLossPercent (integer) --
Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
downlinkLossPercent (integer) --
Proportion of received packets that fail to arrive from 0 to 100 percent.
parsingResultUrl (string) --
Read-only URL for an object in S3 bucket where you can get the parsing results of the test package. If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points to.
resultCode (string) --
Supporting field for the result field. Set only if result is SKIPPED . PARSING_FAILED if the result is skipped because of test package parsing failure.
seed (integer) --
For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.
appUpload (string) --
An app to upload or that has been uploaded.
eventCount (integer) --
For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.
jobTimeoutMinutes (integer) --
The number of minutes the job will execute before it times out.
devicePoolArn (string) --
The ARN of the device pool for the run.
locale (string) --
Information about the locale that is used for the run.
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.
location (dict) --
Information about the location that is used for the run.
latitude (float) --
The latitude.
longitude (float) --
The longitude.
customerArtifactPaths (dict) --
Output CustomerArtifactPaths object for the test run.
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) --
webUrl (string) --
The Device Farm console URL for the recording of the run.
skipAppResign (boolean) --
When set to true , for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.
For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs .
testSpecArn (string) --
The ARN of the YAML-formatted test specification for the run.
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.
{'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 | '
'APPIUM_JAVA_JUNIT_TEST_SPEC | APPIUM_JAVA_TESTNG_TEST_SPEC | '
'APPIUM_PYTHON_TEST_SPEC | APPIUM_WEB_JAVA_JUNIT_TEST_SPEC | '
'APPIUM_WEB_JAVA_TESTNG_TEST_SPEC | APPIUM_WEB_PYTHON_TEST_SPEC | '
'INSTRUMENTATION_TEST_SPEC | XCTEST_UI_TEST_SPEC'}
Response {'uploads': {'category': 'CURATED | PRIVATE',
'type': ['APPIUM_PYTHON_TEST_SPEC',
'APPIUM_WEB_PYTHON_TEST_SPEC',
'APPIUM_JAVA_JUNIT_TEST_SPEC',
'XCTEST_UI_TEST_SPEC',
'INSTRUMENTATION_TEST_SPEC',
'APPIUM_WEB_JAVA_JUNIT_TEST_SPEC',
'APPIUM_WEB_JAVA_TESTNG_TEST_SPEC',
'APPIUM_JAVA_TESTNG_TEST_SPEC']}}
Gets information about uploads, given an AWS Device Farm project ARN.
See also: AWS API Documentation
Request Syntax
client.list_uploads(
arn='string',
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'|'APPIUM_JAVA_JUNIT_TEST_SPEC'|'APPIUM_JAVA_TESTNG_TEST_SPEC'|'APPIUM_PYTHON_TEST_SPEC'|'APPIUM_WEB_JAVA_JUNIT_TEST_SPEC'|'APPIUM_WEB_JAVA_TESTNG_TEST_SPEC'|'APPIUM_WEB_PYTHON_TEST_SPEC'|'INSTRUMENTATION_TEST_SPEC'|'XCTEST_UI_TEST_SPEC',
nextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the project for which you want to list uploads.
string
The type of upload.
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.
APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.
APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload.
INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.
XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.
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
{
'uploads': [
{
'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'|'APPIUM_JAVA_JUNIT_TEST_SPEC'|'APPIUM_JAVA_TESTNG_TEST_SPEC'|'APPIUM_PYTHON_TEST_SPEC'|'APPIUM_WEB_JAVA_JUNIT_TEST_SPEC'|'APPIUM_WEB_JAVA_TESTNG_TEST_SPEC'|'APPIUM_WEB_PYTHON_TEST_SPEC'|'INSTRUMENTATION_TEST_SPEC'|'XCTEST_UI_TEST_SPEC',
'status': 'INITIALIZED'|'PROCESSING'|'SUCCEEDED'|'FAILED',
'url': 'string',
'metadata': 'string',
'contentType': 'string',
'message': 'string',
'category': 'CURATED'|'PRIVATE'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Represents the result of a list uploads request.
uploads (list) --
Information about the uploads.
(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.
category (string) --
The upload's category. Allowed values include:
CURATED: An upload managed by AWS Device Farm.
PRIVATE: An upload managed by the AWS Device Farm customer.
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.
{'executionConfiguration': {'videoCapture': 'boolean'},
'test': {'testSpecArn': 'string'}}
Response {'run': {'testSpecArn': 'string'}}
Schedules a run.
See also: AWS API Documentation
Request Syntax
client.schedule_run(
projectArn='string',
appArn='string',
devicePoolArn='string',
name='string',
test={
'type': 'BUILTIN_FUZZ'|'BUILTIN_EXPLORER'|'WEB_PERFORMANCE_PROFILE'|'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'|'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'
},
executionConfiguration={
'jobTimeoutMinutes': 123,
'accountsCleanup': True|False,
'appPackagesCleanup': True|False,
'videoCapture': True|False,
'skipAppResign': True|False
}
)
string
[REQUIRED]
The ARN of the project for the run to be scheduled.
string
The ARN of the app to schedule a run.
string
[REQUIRED]
The ARN of the device pool for the run to be scheduled.
string
The name for the run to be scheduled.
dict
[REQUIRED]
Information about the test for the run to be scheduled.
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_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.
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 the following test framework parameters and fixture settings:
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.4.16", "1.6.3", "latest", and "default".
“latest” will run the latest Appium version supported by Device Farm (1.6.3).
For “default”, Device Farm will choose a compatible version of Appium for the device. The current behavior is to run 1.4.16 on Android devices and iOS 9 and earlier, 1.6.3 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
Information about the settings for the run to be scheduled.
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
Specifies configuration information about a test run, such as the execution timeout (in minutes).
jobTimeoutMinutes (integer) --
The number of minutes a test run will execute before it times out.
accountsCleanup (boolean) --
True if account cleanup is enabled at the beginning of the test; otherwise, false.
appPackagesCleanup (boolean) --
True if app package cleanup is enabled at the beginning of the test; otherwise, false.
videoCapture (boolean) --
Set to true to enable video capture; otherwise, set to false. The default is true.
skipAppResign (boolean) --
When set to true , for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.
For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs .
dict
Response Syntax
{
'run': {
'arn': 'string',
'name': 'string',
'type': 'BUILTIN_FUZZ'|'BUILTIN_EXPLORER'|'WEB_PERFORMANCE_PROFILE'|'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'|'REMOTE_ACCESS_RECORD'|'REMOTE_ACCESS_REPLAY',
'platform': 'ANDROID'|'IOS',
'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',
'totalJobs': 123,
'completedJobs': 123,
'billingMethod': 'METERED'|'UNMETERED',
'deviceMinutes': {
'total': 123.0,
'metered': 123.0,
'unmetered': 123.0
},
'networkProfile': {
'arn': 'string',
'name': 'string',
'description': 'string',
'type': 'CURATED'|'PRIVATE',
'uplinkBandwidthBits': 123,
'downlinkBandwidthBits': 123,
'uplinkDelayMs': 123,
'downlinkDelayMs': 123,
'uplinkJitterMs': 123,
'downlinkJitterMs': 123,
'uplinkLossPercent': 123,
'downlinkLossPercent': 123
},
'parsingResultUrl': 'string',
'resultCode': 'PARSING_FAILED'|'VPC_ENDPOINT_SETUP_FAILED',
'seed': 123,
'appUpload': 'string',
'eventCount': 123,
'jobTimeoutMinutes': 123,
'devicePoolArn': 'string',
'locale': 'string',
'radios': {
'wifi': True|False,
'bluetooth': True|False,
'nfc': True|False,
'gps': True|False
},
'location': {
'latitude': 123.0,
'longitude': 123.0
},
'customerArtifactPaths': {
'iosPaths': [
'string',
],
'androidPaths': [
'string',
],
'deviceHostPaths': [
'string',
]
},
'webUrl': 'string',
'skipAppResign': True|False,
'testSpecArn': 'string'
}
}
Response Structure
(dict) --
Represents the result of a schedule run request.
run (dict) --
Information about the scheduled run.
arn (string) --
The run's ARN.
name (string) --
The run's name.
type (string) --
The run'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_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.
platform (string) --
The run's platform.
Allowed values include:
ANDROID: The Android platform.
IOS: The iOS platform.
created (datetime) --
When the run was created.
status (string) --
The run'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 run'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 run's start time.
stopped (datetime) --
The run's stop time.
counters (dict) --
The run'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 run's result.
totalJobs (integer) --
The total number of jobs for the run.
completedJobs (integer) --
The total number of completed jobs.
billingMethod (string) --
Specifies the billing method for a test run: metered or unmetered . If the parameter is not specified, the default value is metered .
deviceMinutes (dict) --
Represents the total (metered or unmetered) minutes used by the test run.
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.
networkProfile (dict) --
The network profile being used for a test run.
arn (string) --
The Amazon Resource Name (ARN) of the network profile.
name (string) --
The name of the network profile.
description (string) --
The description of the network profile.
type (string) --
The type of network profile. Valid values are listed below.
uplinkBandwidthBits (integer) --
The data throughput rate in bits per second, as an integer from 0 to 104857600.
downlinkBandwidthBits (integer) --
The data throughput rate in bits per second, as an integer from 0 to 104857600.
uplinkDelayMs (integer) --
Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
downlinkDelayMs (integer) --
Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
uplinkJitterMs (integer) --
Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
downlinkJitterMs (integer) --
Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
uplinkLossPercent (integer) --
Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
downlinkLossPercent (integer) --
Proportion of received packets that fail to arrive from 0 to 100 percent.
parsingResultUrl (string) --
Read-only URL for an object in S3 bucket where you can get the parsing results of the test package. If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points to.
resultCode (string) --
Supporting field for the result field. Set only if result is SKIPPED . PARSING_FAILED if the result is skipped because of test package parsing failure.
seed (integer) --
For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.
appUpload (string) --
An app to upload or that has been uploaded.
eventCount (integer) --
For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.
jobTimeoutMinutes (integer) --
The number of minutes the job will execute before it times out.
devicePoolArn (string) --
The ARN of the device pool for the run.
locale (string) --
Information about the locale that is used for the run.
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.
location (dict) --
Information about the location that is used for the run.
latitude (float) --
The latitude.
longitude (float) --
The longitude.
customerArtifactPaths (dict) --
Output CustomerArtifactPaths object for the test run.
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) --
webUrl (string) --
The Device Farm console URL for the recording of the run.
skipAppResign (boolean) --
When set to true , for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.
For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs .
testSpecArn (string) --
The ARN of the YAML-formatted test specification for the run.
{'run': {'testSpecArn': 'string'}}
Initiates a stop request for the current test run. AWS Device Farm will immediately stop the run on devices where tests have not started executing, and you will not be billed for these devices. On devices where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on those devices. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.
See also: AWS API Documentation
Request Syntax
client.stop_run(
arn='string'
)
string
[REQUIRED]
Represents the Amazon Resource Name (ARN) of the Device Farm run you wish to stop.
dict
Response Syntax
{
'run': {
'arn': 'string',
'name': 'string',
'type': 'BUILTIN_FUZZ'|'BUILTIN_EXPLORER'|'WEB_PERFORMANCE_PROFILE'|'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'|'REMOTE_ACCESS_RECORD'|'REMOTE_ACCESS_REPLAY',
'platform': 'ANDROID'|'IOS',
'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',
'totalJobs': 123,
'completedJobs': 123,
'billingMethod': 'METERED'|'UNMETERED',
'deviceMinutes': {
'total': 123.0,
'metered': 123.0,
'unmetered': 123.0
},
'networkProfile': {
'arn': 'string',
'name': 'string',
'description': 'string',
'type': 'CURATED'|'PRIVATE',
'uplinkBandwidthBits': 123,
'downlinkBandwidthBits': 123,
'uplinkDelayMs': 123,
'downlinkDelayMs': 123,
'uplinkJitterMs': 123,
'downlinkJitterMs': 123,
'uplinkLossPercent': 123,
'downlinkLossPercent': 123
},
'parsingResultUrl': 'string',
'resultCode': 'PARSING_FAILED'|'VPC_ENDPOINT_SETUP_FAILED',
'seed': 123,
'appUpload': 'string',
'eventCount': 123,
'jobTimeoutMinutes': 123,
'devicePoolArn': 'string',
'locale': 'string',
'radios': {
'wifi': True|False,
'bluetooth': True|False,
'nfc': True|False,
'gps': True|False
},
'location': {
'latitude': 123.0,
'longitude': 123.0
},
'customerArtifactPaths': {
'iosPaths': [
'string',
],
'androidPaths': [
'string',
],
'deviceHostPaths': [
'string',
]
},
'webUrl': 'string',
'skipAppResign': True|False,
'testSpecArn': 'string'
}
}
Response Structure
(dict) --
Represents the results of your stop run attempt.
run (dict) --
The run that was stopped.
arn (string) --
The run's ARN.
name (string) --
The run's name.
type (string) --
The run'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_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.
platform (string) --
The run's platform.
Allowed values include:
ANDROID: The Android platform.
IOS: The iOS platform.
created (datetime) --
When the run was created.
status (string) --
The run'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 run'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 run's start time.
stopped (datetime) --
The run's stop time.
counters (dict) --
The run'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 run's result.
totalJobs (integer) --
The total number of jobs for the run.
completedJobs (integer) --
The total number of completed jobs.
billingMethod (string) --
Specifies the billing method for a test run: metered or unmetered . If the parameter is not specified, the default value is metered .
deviceMinutes (dict) --
Represents the total (metered or unmetered) minutes used by the test run.
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.
networkProfile (dict) --
The network profile being used for a test run.
arn (string) --
The Amazon Resource Name (ARN) of the network profile.
name (string) --
The name of the network profile.
description (string) --
The description of the network profile.
type (string) --
The type of network profile. Valid values are listed below.
uplinkBandwidthBits (integer) --
The data throughput rate in bits per second, as an integer from 0 to 104857600.
downlinkBandwidthBits (integer) --
The data throughput rate in bits per second, as an integer from 0 to 104857600.
uplinkDelayMs (integer) --
Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
downlinkDelayMs (integer) --
Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
uplinkJitterMs (integer) --
Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
downlinkJitterMs (integer) --
Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
uplinkLossPercent (integer) --
Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
downlinkLossPercent (integer) --
Proportion of received packets that fail to arrive from 0 to 100 percent.
parsingResultUrl (string) --
Read-only URL for an object in S3 bucket where you can get the parsing results of the test package. If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points to.
resultCode (string) --
Supporting field for the result field. Set only if result is SKIPPED . PARSING_FAILED if the result is skipped because of test package parsing failure.
seed (integer) --
For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.
appUpload (string) --
An app to upload or that has been uploaded.
eventCount (integer) --
For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.
jobTimeoutMinutes (integer) --
The number of minutes the job will execute before it times out.
devicePoolArn (string) --
The ARN of the device pool for the run.
locale (string) --
Information about the locale that is used for the run.
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.
location (dict) --
Information about the location that is used for the run.
latitude (float) --
The latitude.
longitude (float) --
The longitude.
customerArtifactPaths (dict) --
Output CustomerArtifactPaths object for the test run.
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) --
webUrl (string) --
The Device Farm console URL for the recording of the run.
skipAppResign (boolean) --
When set to true , for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.
For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs .
testSpecArn (string) --
The ARN of the YAML-formatted test specification for the run.