2018/04/03 - AWS Device Farm - 8 new 19 updated api methods
Changes Added Private Device Management feature. Customers can now manage their private devices efficiently - view their status, set labels and apply profiles on them. Customers can also schedule automated tests and remote access sessions on individual instances in their private device fleet.
Creates a profile that can be applied to one or more private fleet device instances.
See also: AWS API Documentation
Request Syntax
client.create_instance_profile(
name='string',
description='string',
packageCleanup=True|False,
excludeAppPackagesFromCleanup=[
'string',
],
rebootAfterUse=True|False
)
string
[REQUIRED]
The name of your instance profile.
string
The description of your instance profile.
boolean
When set to true , Device Farm will remove app packages after a test run. The default value is false for private devices.
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) --
boolean
When set to true , Device Farm will reboot the instance after a test run. The default value is true .
dict
Response Syntax
{
'instanceProfile': {
'arn': 'string',
'packageCleanup': True|False,
'excludeAppPackagesFromCleanup': [
'string',
],
'rebootAfterUse': True|False,
'name': 'string',
'description': 'string'
}
}
Response Structure
(dict) --
instanceProfile (dict) --
An object containing information about your 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.
Returns information about all the instance profiles in an AWS account.
See also: AWS API Documentation
Request Syntax
client.list_instance_profiles(
maxResults=123,
nextToken='string'
)
integer
An integer specifying the maximum number of items you want to return in the API response.
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
{
'instanceProfiles': [
{
'arn': 'string',
'packageCleanup': True|False,
'excludeAppPackagesFromCleanup': [
'string',
],
'rebootAfterUse': True|False,
'name': 'string',
'description': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
instanceProfiles (list) --
An object containing information about your instance profiles.
(dict) --
Represents 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.
nextToken (string) --
An identifier that can be used in the next call to this operation to return the next set of items in the list.
Returns information about a device instance belonging to a private device fleet.
See also: AWS API Documentation
Request Syntax
client.get_device_instance(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the instance you're requesting information about.
dict
Response Syntax
{
'deviceInstance': {
'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'
}
}
}
Response Structure
(dict) --
deviceInstance (dict) --
An object containing information about your 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.
Updates information about an existing private device instance.
See also: AWS API Documentation
Request Syntax
client.update_device_instance(
arn='string',
profileArn='string',
labels=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the device instance.
string
The Amazon Resource Name (ARN) of the profile that you want to associate with the device instance.
list
An array of strings that you want to associate with the device instance.
(string) --
dict
Response Syntax
{
'deviceInstance': {
'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'
}
}
}
Response Structure
(dict) --
deviceInstance (dict) --
An object containing information about your 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.
Deletes a profile that can be applied to one or more private device instances.
See also: AWS API Documentation
Request Syntax
client.delete_instance_profile(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the instance profile you are requesting to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Returns information about the specified instance profile.
See also: AWS API Documentation
Request Syntax
client.get_instance_profile(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of your instance profile.
dict
Response Syntax
{
'instanceProfile': {
'arn': 'string',
'packageCleanup': True|False,
'excludeAppPackagesFromCleanup': [
'string',
],
'rebootAfterUse': True|False,
'name': 'string',
'description': 'string'
}
}
Response Structure
(dict) --
instanceProfile (dict) --
An object containing information about your 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.
Updates information about an existing private device instance profile.
See also: AWS API Documentation
Request Syntax
client.update_instance_profile(
arn='string',
name='string',
description='string',
packageCleanup=True|False,
excludeAppPackagesFromCleanup=[
'string',
],
rebootAfterUse=True|False
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the instance profile.
string
The updated name for your instance profile.
string
The updated description for your instance profile.
boolean
The updated choice for whether you want to specify package cleanup. The default value is false for private devices.
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) --
boolean
The updated choice for whether you want to reboot the device after use. The default value is true .
dict
Response Syntax
{
'instanceProfile': {
'arn': 'string',
'packageCleanup': True|False,
'excludeAppPackagesFromCleanup': [
'string',
],
'rebootAfterUse': True|False,
'name': 'string',
'description': 'string'
}
}
Response Structure
(dict) --
instanceProfile (dict) --
An object containing information about your 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.
Returns information about the private device instances associated with one or more AWS accounts.
See also: AWS API Documentation
Request Syntax
client.list_device_instances(
maxResults=123,
nextToken='string'
)
integer
An integer specifying the maximum number of items you want to return in the API response.
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
{
'deviceInstances': [
{
'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'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
deviceInstances (list) --
An object containing information about your device instances.
(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.
nextToken (string) --
An identifier that can be used in the next call to this operation to return the next set of items in the list.
{'rules': {'attribute': ['INSTANCE_LABELS', 'INSTANCE_ARN']}}
Response {'devicePool': {'rules': {'attribute': ['INSTANCE_LABELS', 'INSTANCE_ARN']}}}
Creates a device pool.
See also: AWS API Documentation
Request Syntax
client.create_device_pool(
projectArn='string',
name='string',
description='string',
rules=[
{
'attribute': 'ARN'|'PLATFORM'|'FORM_FACTOR'|'MANUFACTURER'|'REMOTE_ACCESS_ENABLED'|'REMOTE_DEBUG_ENABLED'|'APPIUM_VERSION'|'INSTANCE_ARN'|'INSTANCE_LABELS',
'operator': 'EQUALS'|'LESS_THAN'|'GREATER_THAN'|'IN'|'NOT_IN'|'CONTAINS',
'value': 'string'
},
]
)
string
[REQUIRED]
The ARN of the project for the device pool.
string
[REQUIRED]
The device pool's name.
string
The device pool's description.
list
[REQUIRED]
The device pool's rules.
(dict) --
Represents a condition for a device pool.
attribute (string) --
The rule's stringified attribute. For example, specify the value as "\"abc\"" .
Allowed values include:
ARN: The ARN.
FORM_FACTOR: The form factor (for example, phone or tablet).
MANUFACTURER: The manufacturer.
PLATFORM: The platform (for example, Android or iOS).
REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.
APPIUM_VERSION: The Appium version for the test.
INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
INSTANCE_LABELS: The label of the device instance.
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.
CONTAINS: The contains operator.
value (string) --
The rule's value.
dict
Response Syntax
{
'devicePool': {
'arn': 'string',
'name': 'string',
'description': 'string',
'type': 'CURATED'|'PRIVATE',
'rules': [
{
'attribute': 'ARN'|'PLATFORM'|'FORM_FACTOR'|'MANUFACTURER'|'REMOTE_ACCESS_ENABLED'|'REMOTE_DEBUG_ENABLED'|'APPIUM_VERSION'|'INSTANCE_ARN'|'INSTANCE_LABELS',
'operator': 'EQUALS'|'LESS_THAN'|'GREATER_THAN'|'IN'|'NOT_IN'|'CONTAINS',
'value': 'string'
},
]
}
}
Response Structure
(dict) --
Represents the result of a create device pool request.
devicePool (dict) --
The newly created device pool.
arn (string) --
The device pool's ARN.
name (string) --
The device pool's name.
description (string) --
The device pool's description.
type (string) --
The device pool's type.
Allowed values include:
CURATED: A device pool that is created and managed by AWS Device Farm.
PRIVATE: A device pool that is created and managed by the device pool developer.
rules (list) --
Information about the device pool's rules.
(dict) --
Represents a condition for a device pool.
attribute (string) --
The rule's stringified attribute. For example, specify the value as "\"abc\"" .
Allowed values include:
ARN: The ARN.
FORM_FACTOR: The form factor (for example, phone or tablet).
MANUFACTURER: The manufacturer.
PLATFORM: The platform (for example, Android or iOS).
REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.
APPIUM_VERSION: The Appium version for the test.
INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
INSTANCE_LABELS: The label of the device instance.
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.
CONTAINS: The contains operator.
value (string) --
The rule's value.
{'instanceArn': 'string', 'skipAppResign': 'boolean'}
Response {'remoteAccessSession': {'device': {'instances': [{'arn': 'string',
'deviceArn': 'string',
'instanceProfile': {'arn': 'string',
'description': 'string',
'excludeAppPackagesFromCleanup': ['string'],
'name': 'string',
'packageCleanup': 'boolean',
'rebootAfterUse': 'boolean'},
'labels': ['string'],
'status': 'IN_USE | '
'PREPARING | '
'AVAILABLE | '
'NOT_AVAILABLE',
'udid': 'string'}]},
'instanceArn': 'string',
'skipAppResign': 'boolean'}}
Specifies and starts a remote access session.
See also: AWS API Documentation
Request Syntax
client.create_remote_access_session(
projectArn='string',
deviceArn='string',
instanceArn='string',
sshPublicKey='string',
remoteDebugEnabled=True|False,
remoteRecordEnabled=True|False,
remoteRecordAppArn='string',
name='string',
clientId='string',
configuration={
'billingMethod': 'METERED'|'UNMETERED'
},
interactionMode='INTERACTIVE'|'NO_VIDEO'|'VIDEO_ONLY',
skipAppResign=True|False
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the device for which you want to create a remote access session.
string
The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.
string
The public key of the ssh key pair you want to use for connecting to remote devices in your remote debugging session. This is only required if remoteDebugEnabled is set to true .
boolean
Set to true if you want to access devices remotely for debugging in your remote access session.
boolean
Set to true to enable remote recording for the remote access session.
string
The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
string
The name of the remote access session that you wish to create.
string
Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same clientId value in each call to CreateRemoteAccessSession . This is required only if remoteDebugEnabled is set to true .
dict
The configuration information for the remote access session request.
billingMethod (string) --
The billing method for the remote access session.
string
The interaction mode of the remote access session. Valid values are:
INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode.
NO_VIDEO: You are connected to the device but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode.
VIDEO_ONLY: You can view the screen but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.
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
{
'remoteAccessSession': {
'arn': 'string',
'name': 'string',
'created': datetime(2015, 1, 1),
'status': 'PENDING'|'PENDING_CONCURRENCY'|'PENDING_DEVICE'|'PROCESSING'|'SCHEDULING'|'PREPARING'|'RUNNING'|'COMPLETED'|'STOPPING',
'result': 'PENDING'|'PASSED'|'WARNED'|'FAILED'|'SKIPPED'|'ERRORED'|'STOPPED',
'message': 'string',
'started': datetime(2015, 1, 1),
'stopped': datetime(2015, 1, 1),
'device': {
'arn': 'string',
'name': 'string',
'manufacturer': 'string',
'model': 'string',
'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',
'remoteDebugEnabled': True|False,
'remoteRecordEnabled': True|False,
'remoteRecordAppArn': 'string',
'hostAddress': 'string',
'clientId': 'string',
'billingMethod': 'METERED'|'UNMETERED',
'deviceMinutes': {
'total': 123.0,
'metered': 123.0,
'unmetered': 123.0
},
'endpoint': 'string',
'deviceUdid': 'string',
'interactionMode': 'INTERACTIVE'|'NO_VIDEO'|'VIDEO_ONLY',
'skipAppResign': True|False
}
}
Response Structure
(dict) --
Represents the server response from a request to create a remote access session.
remoteAccessSession (dict) --
A container that describes the remote access session when the request to create a remote access session is sent.
arn (string) --
The Amazon Resource Name (ARN) of the remote access session.
name (string) --
The name of the remote access session.
created (datetime) --
The date and time the remote access session was created.
status (string) --
The status of the remote access session. Can be any of the following:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
result (string) --
The result of the remote access session. Can be any of the following:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
message (string) --
A message about the remote access session.
started (datetime) --
The date and time the remote access session was started.
stopped (datetime) --
The date and time the remote access session was stopped.
device (dict) --
The device (phone or tablet) used in the remote access session.
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.
remoteDebugEnabled (boolean) --
This flag is set to true if remote debugging is enabled for the remote access session.
remoteRecordEnabled (boolean) --
This flag is set to true if remote recording is enabled for the remote access session.
remoteRecordAppArn (string) --
The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
hostAddress (string) --
IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging is enabled for the remote access session.
clientId (string) --
Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session.
billingMethod (string) --
The billing method of the remote access session. Possible values include METERED or UNMETERED . For more information about metered devices, see AWS Device Farm terminology ."
deviceMinutes (dict) --
The number of minutes a device is used in a remote access sesssion (including setup and teardown minutes).
total (float) --
When specified, represents the total minutes used by the resource to run tests.
metered (float) --
When specified, represents only the sum of metered minutes used by the resource to run tests.
unmetered (float) --
When specified, represents only the sum of unmetered minutes used by the resource to run tests.
endpoint (string) --
The endpoint for the remote access sesssion.
deviceUdid (string) --
Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.
interactionMode (string) --
The interaction mode of the remote access session. Valid values are:
INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode.
NO_VIDEO: You are connected to the device but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode.
VIDEO_ONLY: You can view the screen but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.
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 .
{'accountSettings': {'skipAppResign': 'boolean'}}
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,
'trialMinutes': {
'total': 123.0,
'remaining': 123.0
},
'maxSlots': {
'string': 123
},
'defaultJobTimeoutMinutes': 123,
'skipAppResign': True|False
}
}
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.
trialMinutes (dict) --
Information about an AWS account's usage of free trial device minutes.
total (float) --
The total number of free trial minutes that the account started with.
remaining (float) --
The number of free trial minutes remaining in the account.
maxSlots (dict) --
The maximum number of device slots that the AWS account can purchase. Each maximum is expressed as an offering-id:number pair, where the offering-id represents one of the IDs returned by the ListOfferings command.
(string) --
(integer) --
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.
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 .
{'device': {'instances': [{'arn': 'string',
'deviceArn': 'string',
'instanceProfile': {'arn': 'string',
'description': 'string',
'excludeAppPackagesFromCleanup': ['string'],
'name': 'string',
'packageCleanup': 'boolean',
'rebootAfterUse': 'boolean'},
'labels': ['string'],
'status': 'IN_USE | PREPARING | AVAILABLE | '
'NOT_AVAILABLE',
'udid': 'string'}]}}
Gets information about a unique device type.
See also: AWS API Documentation
Request Syntax
client.get_device(
arn='string'
)
string
[REQUIRED]
The device type's ARN.
dict
Response Syntax
{
'device': {
'arn': 'string',
'name': 'string',
'manufacturer': 'string',
'model': 'string',
'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'
}
},
]
}
}
Response Structure
(dict) --
Represents the result of a get device request.
device (dict) --
An object containing information about the requested device.
arn (string) --
The device's ARN.
name (string) --
The device's display name.
manufacturer (string) --
The device's manufacturer name.
model (string) --
The device's model name.
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.
{'devicePool': {'rules': {'attribute': ['INSTANCE_LABELS', 'INSTANCE_ARN']}}}
Gets information about a device pool.
See also: AWS API Documentation
Request Syntax
client.get_device_pool(
arn='string'
)
string
[REQUIRED]
The device pool's ARN.
dict
Response Syntax
{
'devicePool': {
'arn': 'string',
'name': 'string',
'description': 'string',
'type': 'CURATED'|'PRIVATE',
'rules': [
{
'attribute': 'ARN'|'PLATFORM'|'FORM_FACTOR'|'MANUFACTURER'|'REMOTE_ACCESS_ENABLED'|'REMOTE_DEBUG_ENABLED'|'APPIUM_VERSION'|'INSTANCE_ARN'|'INSTANCE_LABELS',
'operator': 'EQUALS'|'LESS_THAN'|'GREATER_THAN'|'IN'|'NOT_IN'|'CONTAINS',
'value': 'string'
},
]
}
}
Response Structure
(dict) --
Represents the result of a get device pool request.
devicePool (dict) --
An object containing information about the requested device pool.
arn (string) --
The device pool's ARN.
name (string) --
The device pool's name.
description (string) --
The device pool's description.
type (string) --
The device pool's type.
Allowed values include:
CURATED: A device pool that is created and managed by AWS Device Farm.
PRIVATE: A device pool that is created and managed by the device pool developer.
rules (list) --
Information about the device pool's rules.
(dict) --
Represents a condition for a device pool.
attribute (string) --
The rule's stringified attribute. For example, specify the value as "\"abc\"" .
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.
INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
INSTANCE_LABELS: The label of the device instance.
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.
CONTAINS: The contains operator.
value (string) --
The rule's value.
{'compatibleDevices': {'device': {'instances': [{'arn': 'string',
'deviceArn': 'string',
'instanceProfile': {'arn': 'string',
'description': 'string',
'excludeAppPackagesFromCleanup': ['string'],
'name': 'string',
'packageCleanup': 'boolean',
'rebootAfterUse': 'boolean'},
'labels': ['string'],
'status': 'IN_USE | PREPARING '
'| AVAILABLE | '
'NOT_AVAILABLE',
'udid': 'string'}]},
'incompatibilityMessages': {'type': ['INSTANCE_LABELS',
'INSTANCE_ARN']}},
'incompatibleDevices': {'device': {'instances': [{'arn': 'string',
'deviceArn': 'string',
'instanceProfile': {'arn': 'string',
'description': 'string',
'excludeAppPackagesFromCleanup': ['string'],
'name': 'string',
'packageCleanup': 'boolean',
'rebootAfterUse': 'boolean'},
'labels': ['string'],
'status': 'IN_USE | '
'PREPARING | '
'AVAILABLE | '
'NOT_AVAILABLE',
'udid': 'string'}]},
'incompatibilityMessages': {'type': ['INSTANCE_LABELS',
'INSTANCE_ARN']}}}
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',
'filter': 'string',
'parameters': {
'string': 'string'
}
}
)
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.
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
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'
},
]
},
],
'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'
},
]
},
]
}
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': {'device': {'instances': [{'arn': 'string',
'deviceArn': 'string',
'instanceProfile': {'arn': 'string',
'description': 'string',
'excludeAppPackagesFromCleanup': ['string'],
'name': 'string',
'packageCleanup': 'boolean',
'rebootAfterUse': 'boolean'},
'labels': ['string'],
'status': 'IN_USE | PREPARING | AVAILABLE | '
'NOT_AVAILABLE',
'udid': 'string'}]},
'instanceArn': '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
}
}
}
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.
{'remoteAccessSession': {'device': {'instances': [{'arn': 'string',
'deviceArn': 'string',
'instanceProfile': {'arn': 'string',
'description': 'string',
'excludeAppPackagesFromCleanup': ['string'],
'name': 'string',
'packageCleanup': 'boolean',
'rebootAfterUse': 'boolean'},
'labels': ['string'],
'status': 'IN_USE | '
'PREPARING | '
'AVAILABLE | '
'NOT_AVAILABLE',
'udid': 'string'}]},
'instanceArn': 'string',
'skipAppResign': 'boolean'}}
Returns a link to a currently running remote access session.
See also: AWS API Documentation
Request Syntax
client.get_remote_access_session(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the remote access session about which you want to get session information.
dict
Response Syntax
{
'remoteAccessSession': {
'arn': 'string',
'name': 'string',
'created': datetime(2015, 1, 1),
'status': 'PENDING'|'PENDING_CONCURRENCY'|'PENDING_DEVICE'|'PROCESSING'|'SCHEDULING'|'PREPARING'|'RUNNING'|'COMPLETED'|'STOPPING',
'result': 'PENDING'|'PASSED'|'WARNED'|'FAILED'|'SKIPPED'|'ERRORED'|'STOPPED',
'message': 'string',
'started': datetime(2015, 1, 1),
'stopped': datetime(2015, 1, 1),
'device': {
'arn': 'string',
'name': 'string',
'manufacturer': 'string',
'model': 'string',
'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',
'remoteDebugEnabled': True|False,
'remoteRecordEnabled': True|False,
'remoteRecordAppArn': 'string',
'hostAddress': 'string',
'clientId': 'string',
'billingMethod': 'METERED'|'UNMETERED',
'deviceMinutes': {
'total': 123.0,
'metered': 123.0,
'unmetered': 123.0
},
'endpoint': 'string',
'deviceUdid': 'string',
'interactionMode': 'INTERACTIVE'|'NO_VIDEO'|'VIDEO_ONLY',
'skipAppResign': True|False
}
}
Response Structure
(dict) --
Represents the response from the server that lists detailed information about the remote access session.
remoteAccessSession (dict) --
A container that lists detailed information about the remote access session.
arn (string) --
The Amazon Resource Name (ARN) of the remote access session.
name (string) --
The name of the remote access session.
created (datetime) --
The date and time the remote access session was created.
status (string) --
The status of the remote access session. Can be any of the following:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
result (string) --
The result of the remote access session. Can be any of the following:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
message (string) --
A message about the remote access session.
started (datetime) --
The date and time the remote access session was started.
stopped (datetime) --
The date and time the remote access session was stopped.
device (dict) --
The device (phone or tablet) used in the remote access session.
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.
remoteDebugEnabled (boolean) --
This flag is set to true if remote debugging is enabled for the remote access session.
remoteRecordEnabled (boolean) --
This flag is set to true if remote recording is enabled for the remote access session.
remoteRecordAppArn (string) --
The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
hostAddress (string) --
IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging is enabled for the remote access session.
clientId (string) --
Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session.
billingMethod (string) --
The billing method of the remote access session. Possible values include METERED or UNMETERED . For more information about metered devices, see AWS Device Farm terminology ."
deviceMinutes (dict) --
The number of minutes a device is used in a remote access sesssion (including setup and teardown minutes).
total (float) --
When specified, represents the total minutes used by the resource to run tests.
metered (float) --
When specified, represents only the sum of metered minutes used by the resource to run tests.
unmetered (float) --
When specified, represents only the sum of unmetered minutes used by the resource to run tests.
endpoint (string) --
The endpoint for the remote access sesssion.
deviceUdid (string) --
Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.
interactionMode (string) --
The interaction mode of the remote access session. Valid values are:
INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode.
NO_VIDEO: You are connected to the device but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode.
VIDEO_ONLY: You can view the screen but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.
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 .
{'run': {'skipAppResign': 'boolean'}}
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',
'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
}
}
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 .
{'devicePools': {'rules': {'attribute': ['INSTANCE_LABELS', 'INSTANCE_ARN']}}}
Gets information about device pools.
See also: AWS API Documentation
Request Syntax
client.list_device_pools(
arn='string',
type='CURATED'|'PRIVATE',
nextToken='string'
)
string
[REQUIRED]
The project ARN.
string
The device pools' type.
Allowed values include:
CURATED: A device pool that is created and managed by AWS Device Farm.
PRIVATE: A device pool that is created and managed by the device pool developer.
string
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
dict
Response Syntax
{
'devicePools': [
{
'arn': 'string',
'name': 'string',
'description': 'string',
'type': 'CURATED'|'PRIVATE',
'rules': [
{
'attribute': 'ARN'|'PLATFORM'|'FORM_FACTOR'|'MANUFACTURER'|'REMOTE_ACCESS_ENABLED'|'REMOTE_DEBUG_ENABLED'|'APPIUM_VERSION'|'INSTANCE_ARN'|'INSTANCE_LABELS',
'operator': 'EQUALS'|'LESS_THAN'|'GREATER_THAN'|'IN'|'NOT_IN'|'CONTAINS',
'value': 'string'
},
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Represents the result of a list device pools request.
devicePools (list) --
Information about the device pools.
(dict) --
Represents a collection of device types.
arn (string) --
The device pool's ARN.
name (string) --
The device pool's name.
description (string) --
The device pool's description.
type (string) --
The device pool's type.
Allowed values include:
CURATED: A device pool that is created and managed by AWS Device Farm.
PRIVATE: A device pool that is created and managed by the device pool developer.
rules (list) --
Information about the device pool's rules.
(dict) --
Represents a condition for a device pool.
attribute (string) --
The rule's stringified attribute. For example, specify the value as "\"abc\"" .
Allowed values include:
ARN: The ARN.
FORM_FACTOR: The form factor (for example, phone or tablet).
MANUFACTURER: The manufacturer.
PLATFORM: The platform (for example, Android or iOS).
REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.
APPIUM_VERSION: The Appium version for the test.
INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
INSTANCE_LABELS: The label of the device instance.
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.
CONTAINS: The contains operator.
value (string) --
The rule's value.
nextToken (string) --
If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
{'devices': {'instances': [{'arn': 'string',
'deviceArn': 'string',
'instanceProfile': {'arn': 'string',
'description': 'string',
'excludeAppPackagesFromCleanup': ['string'],
'name': 'string',
'packageCleanup': 'boolean',
'rebootAfterUse': 'boolean'},
'labels': ['string'],
'status': 'IN_USE | PREPARING | AVAILABLE | '
'NOT_AVAILABLE',
'udid': 'string'}]}}
Gets information about unique device types.
See also: AWS API Documentation
Request Syntax
client.list_devices(
arn='string',
nextToken='string'
)
string
The Amazon Resource Name (ARN) of the project.
string
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
dict
Response Syntax
{
'devices': [
{
'arn': 'string',
'name': 'string',
'manufacturer': 'string',
'model': 'string',
'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'
}
},
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Represents the result of a list devices operation.
devices (list) --
Information about the devices.
(dict) --
Represents a device type that an app is tested against.
arn (string) --
The device's ARN.
name (string) --
The device's display name.
manufacturer (string) --
The device's manufacturer name.
model (string) --
The device's model name.
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.
nextToken (string) --
If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
{'jobs': {'device': {'instances': [{'arn': 'string',
'deviceArn': 'string',
'instanceProfile': {'arn': 'string',
'description': 'string',
'excludeAppPackagesFromCleanup': ['string'],
'name': 'string',
'packageCleanup': 'boolean',
'rebootAfterUse': 'boolean'},
'labels': ['string'],
'status': 'IN_USE | PREPARING | AVAILABLE '
'| NOT_AVAILABLE',
'udid': 'string'}]},
'instanceArn': '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
}
},
],
'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.
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.
{'remoteAccessSessions': {'device': {'instances': [{'arn': 'string',
'deviceArn': 'string',
'instanceProfile': {'arn': 'string',
'description': 'string',
'excludeAppPackagesFromCleanup': ['string'],
'name': 'string',
'packageCleanup': 'boolean',
'rebootAfterUse': 'boolean'},
'labels': ['string'],
'status': 'IN_USE | '
'PREPARING | '
'AVAILABLE | '
'NOT_AVAILABLE',
'udid': 'string'}]},
'instanceArn': 'string',
'skipAppResign': 'boolean'}}
Returns a list of all currently running remote access sessions.
See also: AWS API Documentation
Request Syntax
client.list_remote_access_sessions(
arn='string',
nextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.
string
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
dict
Response Syntax
{
'remoteAccessSessions': [
{
'arn': 'string',
'name': 'string',
'created': datetime(2015, 1, 1),
'status': 'PENDING'|'PENDING_CONCURRENCY'|'PENDING_DEVICE'|'PROCESSING'|'SCHEDULING'|'PREPARING'|'RUNNING'|'COMPLETED'|'STOPPING',
'result': 'PENDING'|'PASSED'|'WARNED'|'FAILED'|'SKIPPED'|'ERRORED'|'STOPPED',
'message': 'string',
'started': datetime(2015, 1, 1),
'stopped': datetime(2015, 1, 1),
'device': {
'arn': 'string',
'name': 'string',
'manufacturer': 'string',
'model': 'string',
'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',
'remoteDebugEnabled': True|False,
'remoteRecordEnabled': True|False,
'remoteRecordAppArn': 'string',
'hostAddress': 'string',
'clientId': 'string',
'billingMethod': 'METERED'|'UNMETERED',
'deviceMinutes': {
'total': 123.0,
'metered': 123.0,
'unmetered': 123.0
},
'endpoint': 'string',
'deviceUdid': 'string',
'interactionMode': 'INTERACTIVE'|'NO_VIDEO'|'VIDEO_ONLY',
'skipAppResign': True|False
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Represents the response from the server after AWS Device Farm makes a request to return information about the remote access session.
remoteAccessSessions (list) --
A container representing the metadata from the service about each remote access session you are requesting.
(dict) --
Represents information about the remote access session.
arn (string) --
The Amazon Resource Name (ARN) of the remote access session.
name (string) --
The name of the remote access session.
created (datetime) --
The date and time the remote access session was created.
status (string) --
The status of the remote access session. Can be any of the following:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
result (string) --
The result of the remote access session. Can be any of the following:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
message (string) --
A message about the remote access session.
started (datetime) --
The date and time the remote access session was started.
stopped (datetime) --
The date and time the remote access session was stopped.
device (dict) --
The device (phone or tablet) used in the remote access session.
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.
remoteDebugEnabled (boolean) --
This flag is set to true if remote debugging is enabled for the remote access session.
remoteRecordEnabled (boolean) --
This flag is set to true if remote recording is enabled for the remote access session.
remoteRecordAppArn (string) --
The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
hostAddress (string) --
IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging is enabled for the remote access session.
clientId (string) --
Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session.
billingMethod (string) --
The billing method of the remote access session. Possible values include METERED or UNMETERED . For more information about metered devices, see AWS Device Farm terminology ."
deviceMinutes (dict) --
The number of minutes a device is used in a remote access sesssion (including setup and teardown minutes).
total (float) --
When specified, represents the total minutes used by the resource to run tests.
metered (float) --
When specified, represents only the sum of metered minutes used by the resource to run tests.
unmetered (float) --
When specified, represents only the sum of unmetered minutes used by the resource to run tests.
endpoint (string) --
The endpoint for the remote access sesssion.
deviceUdid (string) --
Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.
interactionMode (string) --
The interaction mode of the remote access session. Valid values are:
INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode.
NO_VIDEO: You are connected to the device but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode.
VIDEO_ONLY: You can view the screen but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.
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 .
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.
{'runs': {'skipAppResign': 'boolean'}}
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',
'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
},
],
'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 .
nextToken (string) --
If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
{'uniqueProblems': {'problems': {'device': {'instances': [{'arn': 'string',
'deviceArn': 'string',
'instanceProfile': {'arn': 'string',
'description': 'string',
'excludeAppPackagesFromCleanup': ['string'],
'name': 'string',
'packageCleanup': 'boolean',
'rebootAfterUse': 'boolean'},
'labels': ['string'],
'status': 'IN_USE | '
'PREPARING '
'| '
'AVAILABLE '
'| '
'NOT_AVAILABLE',
'udid': 'string'}]}}}}
Gets information about unique problems.
See also: AWS API Documentation
Request Syntax
client.list_unique_problems(
arn='string',
nextToken='string'
)
string
[REQUIRED]
The unique problems' ARNs.
string
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
dict
Response Syntax
{
'uniqueProblems': {
'string': [
{
'message': 'string',
'problems': [
{
'run': {
'arn': 'string',
'name': 'string'
},
'job': {
'arn': 'string',
'name': 'string'
},
'suite': {
'arn': 'string',
'name': 'string'
},
'test': {
'arn': 'string',
'name': 'string'
},
'device': {
'arn': 'string',
'name': 'string',
'manufacturer': 'string',
'model': 'string',
'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'
}
},
]
},
'result': 'PENDING'|'PASSED'|'WARNED'|'FAILED'|'SKIPPED'|'ERRORED'|'STOPPED',
'message': 'string'
},
]
},
]
},
'nextToken': 'string'
}
Response Structure
(dict) --
Represents the result of a list unique problems request.
uniqueProblems (dict) --
Information about the unique problems.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
(string) --
(list) --
(dict) --
A collection of one or more problems, grouped by their result.
message (string) --
A message about the unique problems' result.
problems (list) --
Information about the problems.
(dict) --
Represents a specific warning or failure.
run (dict) --
Information about the associated run.
arn (string) --
The problem detail's ARN.
name (string) --
The problem detail's name.
job (dict) --
Information about the associated job.
arn (string) --
The problem detail's ARN.
name (string) --
The problem detail's name.
suite (dict) --
Information about the associated suite.
arn (string) --
The problem detail's ARN.
name (string) --
The problem detail's name.
test (dict) --
Information about the associated test.
arn (string) --
The problem detail's ARN.
name (string) --
The problem detail's name.
device (dict) --
Information about the associated device.
arn (string) --
The device's ARN.
name (string) --
The device's display name.
manufacturer (string) --
The device's manufacturer name.
model (string) --
The device's model name.
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.
result (string) --
The problem's result.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
message (string) --
A message about the problem's result.
nextToken (string) --
If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
{'executionConfiguration': {'skipAppResign': 'boolean'}}
Response {'run': {'skipAppResign': 'boolean'}}
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',
'filter': 'string',
'parameters': {
'string': 'string'
}
},
configuration={
'extraDataPackageArn': 'string',
'networkProfileArn': 'string',
'locale': 'string',
'location': {
'latitude': 123.0,
'longitude': 123.0
},
'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,
'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.
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.
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.
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',
'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
}
}
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 .
{'remoteAccessSession': {'device': {'instances': [{'arn': 'string',
'deviceArn': 'string',
'instanceProfile': {'arn': 'string',
'description': 'string',
'excludeAppPackagesFromCleanup': ['string'],
'name': 'string',
'packageCleanup': 'boolean',
'rebootAfterUse': 'boolean'},
'labels': ['string'],
'status': 'IN_USE | '
'PREPARING | '
'AVAILABLE | '
'NOT_AVAILABLE',
'udid': 'string'}]},
'instanceArn': 'string',
'skipAppResign': 'boolean'}}
Ends a specified remote access session.
See also: AWS API Documentation
Request Syntax
client.stop_remote_access_session(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the remote access session you wish to stop.
dict
Response Syntax
{
'remoteAccessSession': {
'arn': 'string',
'name': 'string',
'created': datetime(2015, 1, 1),
'status': 'PENDING'|'PENDING_CONCURRENCY'|'PENDING_DEVICE'|'PROCESSING'|'SCHEDULING'|'PREPARING'|'RUNNING'|'COMPLETED'|'STOPPING',
'result': 'PENDING'|'PASSED'|'WARNED'|'FAILED'|'SKIPPED'|'ERRORED'|'STOPPED',
'message': 'string',
'started': datetime(2015, 1, 1),
'stopped': datetime(2015, 1, 1),
'device': {
'arn': 'string',
'name': 'string',
'manufacturer': 'string',
'model': 'string',
'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',
'remoteDebugEnabled': True|False,
'remoteRecordEnabled': True|False,
'remoteRecordAppArn': 'string',
'hostAddress': 'string',
'clientId': 'string',
'billingMethod': 'METERED'|'UNMETERED',
'deviceMinutes': {
'total': 123.0,
'metered': 123.0,
'unmetered': 123.0
},
'endpoint': 'string',
'deviceUdid': 'string',
'interactionMode': 'INTERACTIVE'|'NO_VIDEO'|'VIDEO_ONLY',
'skipAppResign': True|False
}
}
Response Structure
(dict) --
Represents the response from the server that describes the remote access session when AWS Device Farm stops the session.
remoteAccessSession (dict) --
A container representing the metadata from the service about the remote access session you are stopping.
arn (string) --
The Amazon Resource Name (ARN) of the remote access session.
name (string) --
The name of the remote access session.
created (datetime) --
The date and time the remote access session was created.
status (string) --
The status of the remote access session. Can be any of the following:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
result (string) --
The result of the remote access session. Can be any of the following:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
message (string) --
A message about the remote access session.
started (datetime) --
The date and time the remote access session was started.
stopped (datetime) --
The date and time the remote access session was stopped.
device (dict) --
The device (phone or tablet) used in the remote access session.
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.
remoteDebugEnabled (boolean) --
This flag is set to true if remote debugging is enabled for the remote access session.
remoteRecordEnabled (boolean) --
This flag is set to true if remote recording is enabled for the remote access session.
remoteRecordAppArn (string) --
The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
hostAddress (string) --
IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging is enabled for the remote access session.
clientId (string) --
Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session.
billingMethod (string) --
The billing method of the remote access session. Possible values include METERED or UNMETERED . For more information about metered devices, see AWS Device Farm terminology ."
deviceMinutes (dict) --
The number of minutes a device is used in a remote access sesssion (including setup and teardown minutes).
total (float) --
When specified, represents the total minutes used by the resource to run tests.
metered (float) --
When specified, represents only the sum of metered minutes used by the resource to run tests.
unmetered (float) --
When specified, represents only the sum of unmetered minutes used by the resource to run tests.
endpoint (string) --
The endpoint for the remote access sesssion.
deviceUdid (string) --
Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.
interactionMode (string) --
The interaction mode of the remote access session. Valid values are:
INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode.
NO_VIDEO: You are connected to the device but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode.
VIDEO_ONLY: You can view the screen but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.
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 .
{'run': {'skipAppResign': 'boolean'}}
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',
'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
}
}
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 .
{'rules': {'attribute': ['INSTANCE_LABELS', 'INSTANCE_ARN']}}
Response {'devicePool': {'rules': {'attribute': ['INSTANCE_LABELS', 'INSTANCE_ARN']}}}
Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).
See also: AWS API Documentation
Request Syntax
client.update_device_pool(
arn='string',
name='string',
description='string',
rules=[
{
'attribute': 'ARN'|'PLATFORM'|'FORM_FACTOR'|'MANUFACTURER'|'REMOTE_ACCESS_ENABLED'|'REMOTE_DEBUG_ENABLED'|'APPIUM_VERSION'|'INSTANCE_ARN'|'INSTANCE_LABELS',
'operator': 'EQUALS'|'LESS_THAN'|'GREATER_THAN'|'IN'|'NOT_IN'|'CONTAINS',
'value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resourc Name (ARN) of the Device Farm device pool you wish to update.
string
A string representing the name of the device pool you wish to update.
string
A description of the device pool you wish to update.
list
Represents the rules you wish to modify for the device pool. Updating rules is optional; however, if you choose to update rules for your request, the update will replace the existing rules.
(dict) --
Represents a condition for a device pool.
attribute (string) --
The rule's stringified attribute. For example, specify the value as "\"abc\"" .
Allowed values include:
ARN: The ARN.
FORM_FACTOR: The form factor (for example, phone or tablet).
MANUFACTURER: The manufacturer.
PLATFORM: The platform (for example, Android or iOS).
REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.
APPIUM_VERSION: The Appium version for the test.
INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
INSTANCE_LABELS: The label of the device instance.
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.
CONTAINS: The contains operator.
value (string) --
The rule's value.
dict
Response Syntax
{
'devicePool': {
'arn': 'string',
'name': 'string',
'description': 'string',
'type': 'CURATED'|'PRIVATE',
'rules': [
{
'attribute': 'ARN'|'PLATFORM'|'FORM_FACTOR'|'MANUFACTURER'|'REMOTE_ACCESS_ENABLED'|'REMOTE_DEBUG_ENABLED'|'APPIUM_VERSION'|'INSTANCE_ARN'|'INSTANCE_LABELS',
'operator': 'EQUALS'|'LESS_THAN'|'GREATER_THAN'|'IN'|'NOT_IN'|'CONTAINS',
'value': 'string'
},
]
}
}
Response Structure
(dict) --
Represents the result of an update device pool request.
devicePool (dict) --
The device pool you just updated.
arn (string) --
The device pool's ARN.
name (string) --
The device pool's name.
description (string) --
The device pool's description.
type (string) --
The device pool's type.
Allowed values include:
CURATED: A device pool that is created and managed by AWS Device Farm.
PRIVATE: A device pool that is created and managed by the device pool developer.
rules (list) --
Information about the device pool's rules.
(dict) --
Represents a condition for a device pool.
attribute (string) --
The rule's stringified attribute. For example, specify the value as "\"abc\"" .
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.
INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
INSTANCE_LABELS: The label of the device instance.
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.
CONTAINS: The contains operator.
value (string) --
The rule's value.