list_device_pools(**kwargs)¶Gets information about device pools.
See also: AWS API Documentation
Request Syntax
response = client.list_device_pools(
arn='string',
type='CURATED'|'PRIVATE',
nextToken='string'
)
[REQUIRED]
The project ARN.
The device pools' type.
Allowed values include:
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'|'FLEET_TYPE'|'OS_VERSION'|'MODEL'|'AVAILABILITY',
'operator': 'EQUALS'|'LESS_THAN'|'LESS_THAN_OR_EQUALS'|'GREATER_THAN'|'GREATER_THAN_OR_EQUALS'|'IN'|'NOT_IN'|'CONTAINS',
'value': 'string'
},
],
'maxDevices': 123
},
],
'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:
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\"" .
The supported operators for each attribute are provided in the following list.
APPIUM_VERSION
The Appium version for the test.
Supported operators: CONTAINS
ARN
The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example .
Supported operators: EQUALS , IN , NOT_IN
AVAILABILITY
The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
Supported operators: EQUALS
FLEET_TYPE
The fleet type. Valid values are PUBLIC or PRIVATE.
Supported operators: EQUALS
FORM_FACTOR
The device form factor. Valid values are PHONE or TABLET.
Supported operators: EQUALS , IN , NOT_IN
INSTANCE_ARN
The Amazon Resource Name (ARN) of the device instance.
Supported operators: IN , NOT_IN
INSTANCE_LABELS
The label of the device instance.
Supported operators: CONTAINS
MANUFACTURER
The device manufacturer (for example, Apple).
Supported operators: EQUALS , IN , NOT_IN
MODEL
The device model, such as Apple iPad Air 2 or Google Pixel.
Supported operators: CONTAINS , EQUALS , IN , NOT_IN
OS_VERSION
The operating system version (for example, 10.3.2).
Supported operators: EQUALS , GREATER_THAN , GREATER_THAN_OR_EQUALS , IN , LESS_THAN , LESS_THAN_OR_EQUALS , NOT_IN
PLATFORM
The device platform. Valid values are ANDROID or IOS.
Supported operators: EQUALS , IN , NOT_IN
REMOTE_ACCESS_ENABLED
Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
Supported operators: EQUALS
REMOTE_DEBUG_ENABLED
Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.
Supported operators: EQUALS
Because remote debugging is no longer supported, this filter is ignored.
operator (string) --
Specifies how Device Farm compares the rule's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.
value (string) --
The rule's value.
maxDevices (integer) --
The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.
By specifying the maximum number of devices, you can control the costs that you incur by running tests.
nextToken (string) --
If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.
Exceptions
DeviceFarm.Client.exceptions.ArgumentExceptionDeviceFarm.Client.exceptions.NotFoundExceptionDeviceFarm.Client.exceptions.LimitExceededExceptionDeviceFarm.Client.exceptions.ServiceAccountExceptionExamples
The following example returns information about the private device pools in a specific project.
response = client.list_device_pools(
type='PRIVATE',
# You can get the project ARN by using the list-projects CLI command.
arn='arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456',
)
print(response)
Expected Output:
{
'devicePools': [
{
'name': 'Top Devices',
'arn': 'arn:aws:devicefarm:us-west-2::devicepool:082d10e5-d7d7-48a5-ba5c-12345EXAMPLE',
'description': 'Top devices',
'rules': [
{
'value': '["arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE","arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE","arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE","arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE","arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE","arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE","arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE","arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE","arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE","arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE"]',
'attribute': 'ARN',
'operator': 'IN',
},
],
},
{
'name': 'My Android Device Pool',
'arn': 'arn:aws:devicefarm:us-west-2:123456789101:devicepool:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/bf96e75a-28f6-4e61-b6a7-12345EXAMPLE',
'description': 'Samsung Galaxy Android devices',
'rules': [
{
'value': '["arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE","arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE","arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE"]',
'attribute': 'ARN',
'operator': 'IN',
},
],
},
],
'ResponseMetadata': {
'...': '...',
},
}