2015/11/03 - AWS Device Farm - 6 new 10 updated api methods
Deletes an AWS Device Farm project, given the project ARN.
Note Deleting this resource does not stop an in-progress run.
Request Syntax
client.delete_project(
arn='string'
)
string
[REQUIRED]
Represents the Amazon Resource Name (ARN) of the Device Farm project you wish to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Represents the result of a delete project request.
Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).
Request Syntax
client.update_device_pool(
arn='string',
name='string',
description='string',
rules=[
{
'attribute': 'ARN'|'PLATFORM'|'FORM_FACTOR'|'MANUFACTURER',
'operator': 'EQUALS'|'LESS_THAN'|'GREATER_THAN'|'IN'|'NOT_IN',
'value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resourc Name (ARN) of the Device Farm device pool you wish to update.
string
A string representing the name of the device pool you wish to update.
string
A description of the device pool you wish to update.
list
Represents the rules you wish to modify for the device pool. Updating rules is optional; however, if you choose to update rules for your request, the update will replace the existing rules.
(dict) --
Represents a condition for a device pool.
attribute (string) --
The rule's attribute.
Allowed values include:
ARN: The ARN.
FORM_FACTOR: The form factor (for example, phone or tablet).
MANUFACTURER: The manufacturer.
PLATFORM: The platform (for example, Android or iOS).
operator (string) --
The rule's operator.
EQUALS: The equals operator.
GREATER_THAN: The greater-than operator.
IN: The in operator.
LESS_THAN: The less-than operator.
NOT_IN: The not-in operator.
value (string) --
The rule's value.
dict
Response Syntax
{
'devicePool': {
'arn': 'string',
'name': 'string',
'description': 'string',
'type': 'CURATED'|'PRIVATE',
'rules': [
{
'attribute': 'ARN'|'PLATFORM'|'FORM_FACTOR'|'MANUFACTURER',
'operator': 'EQUALS'|'LESS_THAN'|'GREATER_THAN'|'IN'|'NOT_IN',
'value': 'string'
},
]
}
}
Response Structure
(dict) --
Represents the result of an update device pool request.
devicePool (dict) --
Represents a collection of device types.
arn (string) --
The device pool's ARN.
name (string) --
The device pool's name.
description (string) --
The device pool's description.
type (string) --
The device pool's type.
Allowed values include:
CURATED: A device pool that is created and managed by AWS Device Farm.
PRIVATE: A device pool that is created and managed by the device pool developer.
rules (list) --
Information about the device pool's rules.
(dict) --
Represents a condition for a device pool.
attribute (string) --
The rule's attribute.
Allowed values include:
ARN: The ARN.
FORM_FACTOR: The form factor (for example, phone or tablet).
MANUFACTURER: The manufacturer.
PLATFORM: The platform (for example, Android or iOS).
operator (string) --
The rule's operator.
EQUALS: The equals operator.
GREATER_THAN: The greater-than operator.
IN: The in operator.
LESS_THAN: The less-than operator.
NOT_IN: The not-in operator.
value (string) --
The rule's value.
Deletes the run, given the run ARN.
Note Deleting this resource does not stop an in-progress run.
Request Syntax
client.delete_run(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) for the run you wish to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Represents the result of a delete run request.
Deletes an upload given the upload ARN.
Request Syntax
client.delete_upload(
arn='string'
)
string
[REQUIRED]
Represents the Amazon Resource Name (ARN) of the Device Farm upload you wish to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Represents the result of a delete upload request.
Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.
Request Syntax
client.delete_device_pool(
arn='string'
)
string
[REQUIRED]
Represents the Amazon Resource Name (ARN) of the Device Farm device pool you wish to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Represents the result of a delete device pool request.
Modifies the specified project name, given the project ARN and a new name.
Request Syntax
client.update_project(
arn='string',
name='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the project whose name you wish to update.
string
A string representing the new name of the project that you are updating.
dict
Response Syntax
{
'project': {
'arn': 'string',
'name': 'string',
'created': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Represents the result of an update project request.
project (dict) --
Represents an operating-system neutral workspace for running and managing tests.
arn (string) --
The project's ARN.
name (string) --
The project's name.
created (datetime) --
When the project was created.
{'job': {'deviceMinutes': {'metered': 'double',
'total': 'double',
'unmetered': 'double'}}}
Gets information about a job.
Request Syntax
client.get_job(
arn='string'
)
string
[REQUIRED]
The job's ARN.
dict
Response Syntax
{
'job': {
'arn': 'string',
'name': 'string',
'type': 'BUILTIN_FUZZ'|'BUILTIN_EXPLORER'|'APPIUM_JAVA_JUNIT'|'APPIUM_JAVA_TESTNG'|'CALABASH'|'INSTRUMENTATION'|'UIAUTOMATION'|'UIAUTOMATOR'|'XCTEST',
'created': datetime(2015, 1, 1),
'status': 'PENDING'|'PROCESSING'|'SCHEDULING'|'RUNNING'|'COMPLETED',
'result': 'PENDING'|'PASSED'|'WARNED'|'FAILED'|'SKIPPED'|'ERRORED'|'STOPPED',
'started': datetime(2015, 1, 1),
'stopped': datetime(2015, 1, 1),
'counters': {
'total': 123,
'passed': 123,
'failed': 123,
'warned': 123,
'errored': 123,
'stopped': 123,
'skipped': 123
},
'message': 'string',
'device': {
'arn': 'string',
'name': 'string',
'manufacturer': 'string',
'model': 'string',
'formFactor': 'PHONE'|'TABLET',
'platform': 'ANDROID'|'IOS',
'os': 'string',
'cpu': {
'frequency': 'string',
'architecture': 'string',
'clock': 123.0
},
'resolution': {
'width': 123,
'height': 123
},
'heapSize': 123,
'memory': 123,
'image': 'string',
'carrier': 'string',
'radio': 'string'
},
'deviceMinutes': {
'total': 123.0,
'metered': 123.0,
'unmetered': 123.0
}
}
}
Response Structure
(dict) --
Represents the result of a get job request.
job (dict) --
Represents a device.
arn (string) --
The job's ARN.
name (string) --
The job's name.
type (string) --
The job's type.
Allowed values include the following:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
created (datetime) --
When the job was created.
status (string) --
The job's status.
Allowed values include:
COMPLETED: A completed status.
PENDING: A pending status.
PROCESSING: A processing status.
RUNNING: A running status.
SCHEDULING: A scheduling status.
result (string) --
The job's result.
Allowed values include:
ERRORED: An error condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
STOPPED: A stopped condition.
PASSED: A passing condition.
PENDING: A pending condition.
WARNED: A warning condition.
started (datetime) --
The job's start time.
stopped (datetime) --
The job's stop time.
counters (dict) --
The job's result counters.
total (integer) --
The total number of entities.
passed (integer) --
The number of passed entities.
failed (integer) --
The number of failed entities.
warned (integer) --
The number of warned entities.
errored (integer) --
The number of errored entities.
stopped (integer) --
The number of stopped entities.
skipped (integer) --
The number of skipped entities.
message (string) --
A message about the job's result.
device (dict) --
Represents a device type that an app is tested against.
arn (string) --
The device's ARN.
name (string) --
The device's display name.
manufacturer (string) --
The device's manufacturer name.
model (string) --
The device's model name.
formFactor (string) --
The device's form factor.
Allowed values include:
PHONE: The phone form factor.
TABLET: The tablet form factor.
platform (string) --
The device's platform.
Allowed values include:
ANDROID: The Android platform.
IOS: The iOS platform.
os (string) --
The device's operating system type.
cpu (dict) --
Information about the device's CPU.
frequency (string) --
The CPU's frequency.
architecture (string) --
The CPU's architecture, for example x86 or ARM.
clock (float) --
The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000.
resolution (dict) --
Represents the screen resolution of a device in height and width, expressed in pixels.
width (integer) --
The screen resolution's width, expressed in pixels.
height (integer) --
The screen resolution's height, expressed in pixels.
heapSize (integer) --
The device's heap size, expressed in bytes.
memory (integer) --
The device's total memory size, expressed in bytes.
image (string) --
The device's image name.
carrier (string) --
The device's carrier.
radio (string) --
The device's radio.
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.
{'run': {'deviceMinutes': {'metered': 'double',
'total': 'double',
'unmetered': 'double'}}}
Gets information about a run.
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'|'APPIUM_JAVA_JUNIT'|'APPIUM_JAVA_TESTNG'|'CALABASH'|'INSTRUMENTATION'|'UIAUTOMATION'|'UIAUTOMATOR'|'XCTEST',
'platform': 'ANDROID'|'IOS',
'created': datetime(2015, 1, 1),
'status': 'PENDING'|'PROCESSING'|'SCHEDULING'|'RUNNING'|'COMPLETED',
'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
}
}
}
Response Structure
(dict) --
Represents the result of a get run request.
run (dict) --
Represents an app on a set of devices with a specific test and configuration.
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.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode 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:
COMPLETED: A completed status.
PENDING: A pending status.
PROCESSING: A processing status.
RUNNING: A running status.
SCHEDULING: A scheduling status.
result (string) --
The run's result.
Allowed values include:
ERRORED: An error condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
STOPPED: A stopped condition.
PASSED: A passing condition.
PENDING: A pending condition.
WARNED: A warning 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 unmetered .
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.
{'suite': {'deviceMinutes': {'metered': 'double',
'total': 'double',
'unmetered': 'double'}}}
Gets information about a suite.
Request Syntax
client.get_suite(
arn='string'
)
string
[REQUIRED]
The suite's ARN.
dict
Response Syntax
{
'suite': {
'arn': 'string',
'name': 'string',
'type': 'BUILTIN_FUZZ'|'BUILTIN_EXPLORER'|'APPIUM_JAVA_JUNIT'|'APPIUM_JAVA_TESTNG'|'CALABASH'|'INSTRUMENTATION'|'UIAUTOMATION'|'UIAUTOMATOR'|'XCTEST',
'created': datetime(2015, 1, 1),
'status': 'PENDING'|'PROCESSING'|'SCHEDULING'|'RUNNING'|'COMPLETED',
'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',
'deviceMinutes': {
'total': 123.0,
'metered': 123.0,
'unmetered': 123.0
}
}
}
Response Structure
(dict) --
Represents the result of a get suite request.
suite (dict) --
Represents a collection of one or more tests.
arn (string) --
The suite's ARN.
name (string) --
The suite's name.
type (string) --
The suite'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.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
created (datetime) --
When the suite was created.
status (string) --
The suite's status.
Allowed values include:
COMPLETED: A completed status.
PENDING: A pending status.
PROCESSING: A processing status.
RUNNING: A running status.
SCHEDULING: A scheduling status.
result (string) --
The suite's result.
Allowed values include:
ERRORED: An error condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
STOPPED: A stopped condition.
PASSED: A passing condition.
PENDING: A pending condition.
WARNED: A warning condition.
started (datetime) --
The suite's start time.
stopped (datetime) --
The suite's stop time.
counters (dict) --
The suite'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 suite's result.
deviceMinutes (dict) --
Represents the total (metered or unmetered) minutes used by the test suite.
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.
{'test': {'deviceMinutes': {'metered': 'double',
'total': 'double',
'unmetered': 'double'}}}
Gets information about a test.
Request Syntax
client.get_test(
arn='string'
)
string
[REQUIRED]
The test's ARN.
dict
Response Syntax
{
'test': {
'arn': 'string',
'name': 'string',
'type': 'BUILTIN_FUZZ'|'BUILTIN_EXPLORER'|'APPIUM_JAVA_JUNIT'|'APPIUM_JAVA_TESTNG'|'CALABASH'|'INSTRUMENTATION'|'UIAUTOMATION'|'UIAUTOMATOR'|'XCTEST',
'created': datetime(2015, 1, 1),
'status': 'PENDING'|'PROCESSING'|'SCHEDULING'|'RUNNING'|'COMPLETED',
'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',
'deviceMinutes': {
'total': 123.0,
'metered': 123.0,
'unmetered': 123.0
}
}
}
Response Structure
(dict) --
Represents the result of a get test request.
test (dict) --
Represents a condition that is evaluated.
arn (string) --
The test's ARN.
name (string) --
The test's name.
type (string) --
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.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
created (datetime) --
When the test was created.
status (string) --
The test's status.
Allowed values include:
COMPLETED: A completed status.
PENDING: A pending status.
PROCESSING: A processing status.
RUNNING: A running status.
SCHEDULING: A scheduling status.
result (string) --
The test's result.
Allowed values include:
ERRORED: An error condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
STOPPED: A stopped condition.
PASSED: A passing condition.
PENDING: A pending condition.
WARNED: A warning condition.
started (datetime) --
The test's start time.
stopped (datetime) --
The test's stop time.
counters (dict) --
The test'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 test's result.
deviceMinutes (dict) --
Represents the total (metered or unmetered) minutes used by the test.
total (float) --
When specified, represents the total minutes used by the resource to run tests.
metered (float) --
When specified, represents only the sum of metered minutes used by the resource to run tests.
unmetered (float) --
When specified, represents only the sum of unmetered minutes used by the resource to run tests.
{'artifacts': {'type': {'APPLICATION_CRASH_REPORT',
'EXPLORER_EVENT_LOG',
'EXPLORER_SUMMARY_LOG'}}}
Gets information about artifacts.
Request Syntax
client.list_artifacts(
arn='string',
type='SCREENSHOT'|'FILE'|'LOG',
nextToken='string'
)
string
[REQUIRED]
The Run, Job, Suite, or Test ARN.
string
[REQUIRED]
The artifacts' type.
Allowed values include:
FILE: The artifacts are files.
LOG: The artifacts are logs.
SCREENSHOT: The artifacts are screenshots.
string
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
dict
Response Syntax
{
'artifacts': [
{
'arn': 'string',
'name': 'string',
'type': 'UNKNOWN'|'SCREENSHOT'|'DEVICE_LOG'|'MESSAGE_LOG'|'RESULT_LOG'|'SERVICE_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'|'EXPLORER_EVENT_LOG'|'EXPLORER_SUMMARY_LOG'|'APPLICATION_CRASH_REPORT',
'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:
APPIUM_JAVA_OUTPUT: The Appium Java output type.
APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type.
APPIUM_SERVER_OUTPUT: The Appium server output type.
AUTOMATION_OUTPUT: The automation output type.
CALABASH_JSON_OUTPUT: The Calabash JSON output type.
CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type.
CALABASH_PRETTY_OUTPUT: The Calabash pretty output type.
CALABASH_STANDARD_OUTPUT: The Calabash standard output type.
DEVICE_LOG: The device log type.
EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by an Android fuzz test.
INSTRUMENTATION_OUTPUT: The instrumentation type.
MESSAGE_LOG: The message log type.
RESULT_LOG: The result log type.
SCREENSHOT: The screenshot type.
SERVICE_LOG: The service log type.
UNKNOWN: An unknown 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': {'deviceMinutes': {'metered': 'double',
'total': 'double',
'unmetered': 'double'}}}
Gets information about jobs.
Request Syntax
client.list_jobs(
arn='string',
nextToken='string'
)
string
[REQUIRED]
The jobs' ARNs.
string
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
dict
Response Syntax
{
'jobs': [
{
'arn': 'string',
'name': 'string',
'type': 'BUILTIN_FUZZ'|'BUILTIN_EXPLORER'|'APPIUM_JAVA_JUNIT'|'APPIUM_JAVA_TESTNG'|'CALABASH'|'INSTRUMENTATION'|'UIAUTOMATION'|'UIAUTOMATOR'|'XCTEST',
'created': datetime(2015, 1, 1),
'status': 'PENDING'|'PROCESSING'|'SCHEDULING'|'RUNNING'|'COMPLETED',
'result': 'PENDING'|'PASSED'|'WARNED'|'FAILED'|'SKIPPED'|'ERRORED'|'STOPPED',
'started': datetime(2015, 1, 1),
'stopped': datetime(2015, 1, 1),
'counters': {
'total': 123,
'passed': 123,
'failed': 123,
'warned': 123,
'errored': 123,
'stopped': 123,
'skipped': 123
},
'message': 'string',
'device': {
'arn': 'string',
'name': 'string',
'manufacturer': 'string',
'model': 'string',
'formFactor': 'PHONE'|'TABLET',
'platform': 'ANDROID'|'IOS',
'os': 'string',
'cpu': {
'frequency': 'string',
'architecture': 'string',
'clock': 123.0
},
'resolution': {
'width': 123,
'height': 123
},
'heapSize': 123,
'memory': 123,
'image': 'string',
'carrier': 'string',
'radio': 'string'
},
'deviceMinutes': {
'total': 123.0,
'metered': 123.0,
'unmetered': 123.0
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Represents the result of a list jobs request.
jobs (list) --
Information about the jobs.
(dict) --
Represents a device.
arn (string) --
The job's ARN.
name (string) --
The job's name.
type (string) --
The job's type.
Allowed values include the following:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
created (datetime) --
When the job was created.
status (string) --
The job's status.
Allowed values include:
COMPLETED: A completed status.
PENDING: A pending status.
PROCESSING: A processing status.
RUNNING: A running status.
SCHEDULING: A scheduling status.
result (string) --
The job's result.
Allowed values include:
ERRORED: An error condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
STOPPED: A stopped condition.
PASSED: A passing condition.
PENDING: A pending condition.
WARNED: A warning condition.
started (datetime) --
The job's start time.
stopped (datetime) --
The job's stop time.
counters (dict) --
The job's result counters.
total (integer) --
The total number of entities.
passed (integer) --
The number of passed entities.
failed (integer) --
The number of failed entities.
warned (integer) --
The number of warned entities.
errored (integer) --
The number of errored entities.
stopped (integer) --
The number of stopped entities.
skipped (integer) --
The number of skipped entities.
message (string) --
A message about the job's result.
device (dict) --
Represents a device type that an app is tested against.
arn (string) --
The device's ARN.
name (string) --
The device's display name.
manufacturer (string) --
The device's manufacturer name.
model (string) --
The device's model name.
formFactor (string) --
The device's form factor.
Allowed values include:
PHONE: The phone form factor.
TABLET: The tablet form factor.
platform (string) --
The device's platform.
Allowed values include:
ANDROID: The Android platform.
IOS: The iOS platform.
os (string) --
The device's operating system type.
cpu (dict) --
Information about the device's CPU.
frequency (string) --
The CPU's frequency.
architecture (string) --
The CPU's architecture, for example x86 or ARM.
clock (float) --
The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000.
resolution (dict) --
Represents the screen resolution of a device in height and width, expressed in pixels.
width (integer) --
The screen resolution's width, expressed in pixels.
height (integer) --
The screen resolution's height, expressed in pixels.
heapSize (integer) --
The device's heap size, expressed in bytes.
memory (integer) --
The device's total memory size, expressed in bytes.
image (string) --
The device's image name.
carrier (string) --
The device's carrier.
radio (string) --
The device's radio.
deviceMinutes (dict) --
Represents the total (metered or unmetered) minutes used by the job.
total (float) --
When specified, represents the total minutes used by the resource to run tests.
metered (float) --
When specified, represents only the sum of metered minutes used by the resource to run tests.
unmetered (float) --
When specified, represents only the sum of unmetered minutes used by the resource to run tests.
nextToken (string) --
If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
{'runs': {'deviceMinutes': {'metered': 'double',
'total': 'double',
'unmetered': 'double'}}}
Gets information about runs.
Request Syntax
client.list_runs(
arn='string',
nextToken='string'
)
string
[REQUIRED]
The runs' ARNs.
string
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
dict
Response Syntax
{
'runs': [
{
'arn': 'string',
'name': 'string',
'type': 'BUILTIN_FUZZ'|'BUILTIN_EXPLORER'|'APPIUM_JAVA_JUNIT'|'APPIUM_JAVA_TESTNG'|'CALABASH'|'INSTRUMENTATION'|'UIAUTOMATION'|'UIAUTOMATOR'|'XCTEST',
'platform': 'ANDROID'|'IOS',
'created': datetime(2015, 1, 1),
'status': 'PENDING'|'PROCESSING'|'SCHEDULING'|'RUNNING'|'COMPLETED',
'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
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Represents the result of a list runs request.
runs (list) --
Information about the runs.
(dict) --
Represents an app on a set of devices with a specific test and configuration.
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.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode 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:
COMPLETED: A completed status.
PENDING: A pending status.
PROCESSING: A processing status.
RUNNING: A running status.
SCHEDULING: A scheduling status.
result (string) --
The run's result.
Allowed values include:
ERRORED: An error condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
STOPPED: A stopped condition.
PASSED: A passing condition.
PENDING: A pending condition.
WARNED: A warning 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 unmetered .
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.
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.
{'suites': {'deviceMinutes': {'metered': 'double',
'total': 'double',
'unmetered': 'double'}}}
Gets information about suites.
Request Syntax
client.list_suites(
arn='string',
nextToken='string'
)
string
[REQUIRED]
The suites' ARNs.
string
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
dict
Response Syntax
{
'suites': [
{
'arn': 'string',
'name': 'string',
'type': 'BUILTIN_FUZZ'|'BUILTIN_EXPLORER'|'APPIUM_JAVA_JUNIT'|'APPIUM_JAVA_TESTNG'|'CALABASH'|'INSTRUMENTATION'|'UIAUTOMATION'|'UIAUTOMATOR'|'XCTEST',
'created': datetime(2015, 1, 1),
'status': 'PENDING'|'PROCESSING'|'SCHEDULING'|'RUNNING'|'COMPLETED',
'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',
'deviceMinutes': {
'total': 123.0,
'metered': 123.0,
'unmetered': 123.0
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Represents the result of a list suites request.
suites (list) --
Information about the suites.
(dict) --
Represents a collection of one or more tests.
arn (string) --
The suite's ARN.
name (string) --
The suite's name.
type (string) --
The suite'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.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
created (datetime) --
When the suite was created.
status (string) --
The suite's status.
Allowed values include:
COMPLETED: A completed status.
PENDING: A pending status.
PROCESSING: A processing status.
RUNNING: A running status.
SCHEDULING: A scheduling status.
result (string) --
The suite's result.
Allowed values include:
ERRORED: An error condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
STOPPED: A stopped condition.
PASSED: A passing condition.
PENDING: A pending condition.
WARNED: A warning condition.
started (datetime) --
The suite's start time.
stopped (datetime) --
The suite's stop time.
counters (dict) --
The suite'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 suite's result.
deviceMinutes (dict) --
Represents the total (metered or unmetered) minutes used by the test suite.
total (float) --
When specified, represents the total minutes used by the resource to run tests.
metered (float) --
When specified, represents only the sum of metered minutes used by the resource to run tests.
unmetered (float) --
When specified, represents only the sum of unmetered minutes used by the resource to run tests.
nextToken (string) --
If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
{'tests': {'deviceMinutes': {'metered': 'double',
'total': 'double',
'unmetered': 'double'}}}
Gets information about tests.
Request Syntax
client.list_tests(
arn='string',
nextToken='string'
)
string
[REQUIRED]
The tests' ARNs.
string
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
dict
Response Syntax
{
'tests': [
{
'arn': 'string',
'name': 'string',
'type': 'BUILTIN_FUZZ'|'BUILTIN_EXPLORER'|'APPIUM_JAVA_JUNIT'|'APPIUM_JAVA_TESTNG'|'CALABASH'|'INSTRUMENTATION'|'UIAUTOMATION'|'UIAUTOMATOR'|'XCTEST',
'created': datetime(2015, 1, 1),
'status': 'PENDING'|'PROCESSING'|'SCHEDULING'|'RUNNING'|'COMPLETED',
'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',
'deviceMinutes': {
'total': 123.0,
'metered': 123.0,
'unmetered': 123.0
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Represents the result of a list tests request.
tests (list) --
Information about the tests.
(dict) --
Represents a condition that is evaluated.
arn (string) --
The test's ARN.
name (string) --
The test's name.
type (string) --
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.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
created (datetime) --
When the test was created.
status (string) --
The test's status.
Allowed values include:
COMPLETED: A completed status.
PENDING: A pending status.
PROCESSING: A processing status.
RUNNING: A running status.
SCHEDULING: A scheduling status.
result (string) --
The test's result.
Allowed values include:
ERRORED: An error condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
STOPPED: A stopped condition.
PASSED: A passing condition.
PENDING: A pending condition.
WARNED: A warning condition.
started (datetime) --
The test's start time.
stopped (datetime) --
The test's stop time.
counters (dict) --
The test'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 test's result.
deviceMinutes (dict) --
Represents the total (metered or unmetered) minutes used by the test.
total (float) --
When specified, represents the total minutes used by the resource to run tests.
metered (float) --
When specified, represents only the sum of metered minutes used by the resource to run tests.
unmetered (float) --
When specified, represents only the sum of unmetered minutes used by the resource to run tests.
nextToken (string) --
If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
{'run': {'deviceMinutes': {'metered': 'double',
'total': 'double',
'unmetered': 'double'}}}
Schedules a run.
Request Syntax
client.schedule_run(
projectArn='string',
appArn='string',
devicePoolArn='string',
name='string',
test={
'type': 'BUILTIN_FUZZ'|'BUILTIN_EXPLORER'|'APPIUM_JAVA_JUNIT'|'APPIUM_JAVA_TESTNG'|'CALABASH'|'INSTRUMENTATION'|'UIAUTOMATION'|'UIAUTOMATOR'|'XCTEST',
'testPackageArn': 'string',
'filter': 'string',
'parameters': {
'string': 'string'
}
},
configuration={
'extraDataPackageArn': 'string',
'networkProfileArn': 'string',
'locale': 'string',
'location': {
'latitude': 123.0,
'longitude': 123.0
},
'radios': {
'wifi': True|False,
'bluetooth': True|False,
'nfc': True|False,
'gps': True|False
},
'auxiliaryApps': [
'string',
],
'billingMethod': 'METERED'|'UNMETERED'
}
)
string
[REQUIRED]
The ARN of the project for the run to be scheduled.
string
[REQUIRED]
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.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
testPackageArn (string) --
The ARN of the uploaded test that will be run.
filter (string) --
The test's filter.
parameters (dict) --
The test's parameters, such as test framework parameters and fixture settings.
(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.
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 unmetered .
dict
Response Syntax
{
'run': {
'arn': 'string',
'name': 'string',
'type': 'BUILTIN_FUZZ'|'BUILTIN_EXPLORER'|'APPIUM_JAVA_JUNIT'|'APPIUM_JAVA_TESTNG'|'CALABASH'|'INSTRUMENTATION'|'UIAUTOMATION'|'UIAUTOMATOR'|'XCTEST',
'platform': 'ANDROID'|'IOS',
'created': datetime(2015, 1, 1),
'status': 'PENDING'|'PROCESSING'|'SCHEDULING'|'RUNNING'|'COMPLETED',
'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
}
}
}
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.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode 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:
COMPLETED: A completed status.
PENDING: A pending status.
PROCESSING: A processing status.
RUNNING: A running status.
SCHEDULING: A scheduling status.
result (string) --
The run's result.
Allowed values include:
ERRORED: An error condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
STOPPED: A stopped condition.
PASSED: A passing condition.
PENDING: A pending condition.
WARNED: A warning 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 unmetered .
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.