2017/03/13 - AWS Device Farm - 5 new 9 updated api methods
Changes Network shaping allows users to simulate network connections and conditions while testing their Android, iOS, and web apps with AWS Device Farm.
Deletes a network profile.
See also: AWS API Documentation
Request Syntax
client.delete_network_profile(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the network profile you want to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a network profile.
See also: AWS API Documentation
Request Syntax
client.create_network_profile(
projectArn='string',
name='string',
description='string',
type='CURATED'|'PRIVATE',
uplinkBandwidthBits=123,
downlinkBandwidthBits=123,
uplinkDelayMs=123,
downlinkDelayMs=123,
uplinkJitterMs=123,
downlinkJitterMs=123,
uplinkLossPercent=123,
downlinkLossPercent=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the project for which you want to create a network profile.
string
[REQUIRED]
The name you wish to specify for the new network profile.
string
The description of the network profile.
string
The type of network profile you wish to create. Valid values are listed below.
integer
The data throughput rate in bits per second, as an integer from 0 to 104857600.
integer
The data throughput rate in bits per second, as an integer from 0 to 104857600.
integer
Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
integer
Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
integer
Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
integer
Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
integer
Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
integer
Proportion of received packets that fail to arrive from 0 to 100 percent.
dict
Response Syntax
{
'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
}
}
Response Structure
(dict) --
networkProfile (dict) --
The network profile that is returned by the create network profile request.
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.
Updates the network profile with specific settings.
See also: AWS API Documentation
Request Syntax
client.update_network_profile(
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
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the project that you wish to update network profile settings.
string
The name of the network profile about which you are returning information.
string
The descriptoin of the network profile about which you are returning information.
string
The type of network profile you wish to return information about. Valid values are listed below.
integer
The data throughput rate in bits per second, as an integer from 0 to 104857600.
integer
The data throughput rate in bits per second, as an integer from 0 to 104857600.
integer
Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
integer
Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
integer
Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
integer
Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
integer
Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
integer
Proportion of received packets that fail to arrive from 0 to 100 percent.
dict
Response Syntax
{
'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
}
}
Response Structure
(dict) --
networkProfile (dict) --
A list of the available network profiles.
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.
Returns the list of available network profiles.
See also: AWS API Documentation
Request Syntax
client.list_network_profiles(
arn='string',
type='CURATED'|'PRIVATE',
nextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the project for which you want to list network profiles.
string
The type of network profile you wish to return information about. Valid values are listed below.
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
{
'networkProfiles': [
{
'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
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
networkProfiles (list) --
A list of the available network profiles.
(dict) --
An array of settings that describes characteristics of a network profile.
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.
nextToken (string) --
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
Returns information about a network profile.
See also: AWS API Documentation
Request Syntax
client.get_network_profile(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the network profile you want to return information about.
dict
Response Syntax
{
'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
}
}
Response Structure
(dict) --
networkProfile (dict) --
The network profile.
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.
{'defaultJobTimeoutMinutes': 'integer'}
Response {'project': {'defaultJobTimeoutMinutes': 'integer'}}
Creates a new project.
See also: AWS API Documentation
Request Syntax
client.create_project(
name='string',
defaultJobTimeoutMinutes=123
)
string
[REQUIRED]
The project's name.
integer
Sets the execution timeout value (in minutes) for a project. All test runs in this project will use the specified execution timeout value unless overridden when scheduling a run.
dict
Response Syntax
{
'project': {
'arn': 'string',
'name': 'string',
'defaultJobTimeoutMinutes': 123,
'created': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Represents the result of a create project request.
project (dict) --
The newly created project.
arn (string) --
The project's ARN.
name (string) --
The project's name.
defaultJobTimeoutMinutes (integer) --
The default number of minutes (at the project level) a test run will execute before it times out. Default value is 60 minutes.
created (datetime) --
When the project was created.
{'accountSettings': {'defaultJobTimeoutMinutes': 'integer',
'maxJobTimeoutMinutes': 'integer'}}
Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account.
See also: AWS API Documentation
Request Syntax
client.get_account_settings()
dict
Response Syntax
{
'accountSettings': {
'awsAccountNumber': 'string',
'unmeteredDevices': {
'string': 123
},
'unmeteredRemoteAccessDevices': {
'string': 123
},
'maxJobTimeoutMinutes': 123,
'defaultJobTimeoutMinutes': 123
}
}
Response Structure
(dict) --
Represents the account settings return values from the GetAccountSettings request.
accountSettings (dict) --
The account settings.
awsAccountNumber (string) --
The AWS account number specified in the AccountSettings container.
unmeteredDevices (dict) --
Returns the unmetered devices you have purchased or want to purchase.
(string) --
(integer) --
unmeteredRemoteAccessDevices (dict) --
Returns the unmetered remote access devices you have purchased or want to purchase.
(string) --
(integer) --
maxJobTimeoutMinutes (integer) --
The maximum number of minutes a test run will execute before it times out.
defaultJobTimeoutMinutes (integer) --
The default number of minutes (at the account level) a test run will execute before it times out. Default value is 60 minutes.
{'project': {'defaultJobTimeoutMinutes': 'integer'}}
Gets information about a project.
See also: AWS API Documentation
Request Syntax
client.get_project(
arn='string'
)
string
[REQUIRED]
The project's ARN.
dict
Response Syntax
{
'project': {
'arn': 'string',
'name': 'string',
'defaultJobTimeoutMinutes': 123,
'created': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Represents the result of a get project request.
project (dict) --
The project you wish to get information about.
arn (string) --
The project's ARN.
name (string) --
The project's name.
defaultJobTimeoutMinutes (integer) --
The default number of minutes (at the project level) a test run will execute before it times out. Default value is 60 minutes.
created (datetime) --
When the project was created.
{'run': {'networkProfile': {'arn': 'string',
'description': 'string',
'downlinkBandwidthBits': 'long',
'downlinkDelayMs': 'long',
'downlinkJitterMs': 'long',
'downlinkLossPercent': 'integer',
'name': 'string',
'type': 'CURATED | PRIVATE',
'uplinkBandwidthBits': 'long',
'uplinkDelayMs': 'long',
'uplinkJitterMs': 'long',
'uplinkLossPercent': 'integer'}}}
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'|'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',
'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
}
}
}
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.
{'projects': {'defaultJobTimeoutMinutes': 'integer'}}
Gets information about projects.
See also: AWS API Documentation
Request Syntax
client.list_projects(
arn='string',
nextToken='string'
)
string
Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm returns a list of all projects for the AWS account. You can also specify a project 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
{
'projects': [
{
'arn': 'string',
'name': 'string',
'defaultJobTimeoutMinutes': 123,
'created': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Represents the result of a list projects request.
projects (list) --
Information about the projects.
(dict) --
Represents an operating-system neutral workspace for running and managing tests.
arn (string) --
The project's ARN.
name (string) --
The project's name.
defaultJobTimeoutMinutes (integer) --
The default number of minutes (at the project level) a test run will execute before it times out. Default value is 60 minutes.
created (datetime) --
When the project was created.
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': {'networkProfile': {'arn': 'string',
'description': 'string',
'downlinkBandwidthBits': 'long',
'downlinkDelayMs': 'long',
'downlinkJitterMs': 'long',
'downlinkLossPercent': 'integer',
'name': 'string',
'type': 'CURATED | PRIVATE',
'uplinkBandwidthBits': 'long',
'uplinkDelayMs': 'long',
'uplinkJitterMs': 'long',
'uplinkLossPercent': 'integer'}}}
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'|'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',
'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
}
},
],
'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.
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.
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': {'jobTimeoutMinutes': 'integer'}}
Response {'run': {'networkProfile': {'arn': 'string',
'description': 'string',
'downlinkBandwidthBits': 'long',
'downlinkDelayMs': 'long',
'downlinkJitterMs': 'long',
'downlinkLossPercent': 'integer',
'name': 'string',
'type': 'CURATED | PRIVATE',
'uplinkBandwidthBits': 'long',
'uplinkDelayMs': 'long',
'uplinkJitterMs': 'long',
'uplinkLossPercent': 'integer'}}}
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'|'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',
'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'
},
executionConfiguration={
'jobTimeoutMinutes': 123
}
)
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.
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 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.
dict
Response Syntax
{
'run': {
'arn': 'string',
'name': 'string',
'type': 'BUILTIN_FUZZ'|'BUILTIN_EXPLORER'|'APPIUM_JAVA_JUNIT'|'APPIUM_JAVA_TESTNG'|'APPIUM_PYTHON'|'APPIUM_WEB_JAVA_JUNIT'|'APPIUM_WEB_JAVA_TESTNG'|'APPIUM_WEB_PYTHON'|'CALABASH'|'INSTRUMENTATION'|'UIAUTOMATION'|'UIAUTOMATOR'|'XCTEST'|'XCTEST_UI',
'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
}
}
}
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.
{'run': {'networkProfile': {'arn': 'string',
'description': 'string',
'downlinkBandwidthBits': 'long',
'downlinkDelayMs': 'long',
'downlinkJitterMs': 'long',
'downlinkLossPercent': 'integer',
'name': 'string',
'type': 'CURATED | PRIVATE',
'uplinkBandwidthBits': 'long',
'uplinkDelayMs': 'long',
'uplinkJitterMs': 'long',
'uplinkLossPercent': 'integer'}}}
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'|'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',
'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
}
}
}
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.
{'defaultJobTimeoutMinutes': 'integer'}
Response {'project': {'defaultJobTimeoutMinutes': 'integer'}}
Modifies the specified project name, given the project ARN and a new name.
See also: AWS API Documentation
Request Syntax
client.update_project(
arn='string',
name='string',
defaultJobTimeoutMinutes=123
)
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.
integer
The number of minutes a test run in the project will execute before it times out.
dict
Response Syntax
{
'project': {
'arn': 'string',
'name': 'string',
'defaultJobTimeoutMinutes': 123,
'created': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Represents the result of an update project request.
project (dict) --
The project you wish to update.
arn (string) --
The project's ARN.
name (string) --
The project's name.
defaultJobTimeoutMinutes (integer) --
The default number of minutes (at the project level) a test run will execute before it times out. Default value is 60 minutes.
created (datetime) --
When the project was created.