openapi: 3.0.0
info:
version: 2015-06-23
x-release: v4
title: 'AWS Device Farm #X Amz Target=DeviceFarm 20150623.CreateDevicePool #X Amz Target=DeviceFarm 20150623.CreateDevicePool #X Amz Target=DeviceFarm 20150623.ListDevices API'
description: <p>Welcome to the AWS Device Farm API documentation, which contains APIs for:</p> <ul> <li> <p>Testing on desktop browsers</p> <p> Device Farm makes it possible for you to test your web applications on desktop browsers using Selenium. The APIs for desktop browser testing contain <code>TestGrid</code> in their names. For more information, see <a href="https://docs.aws.amazon.com/devicefarm/latest/testgrid/">Testing Web Applications on Selenium with Device Farm</a>.</p> </li> <li> <p>Testing on real mobile devices</p> <p>Device Farm makes it possible for you to test apps on physical phones, tablets, and other devices in the cloud. For more information, see the <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/">Device Farm Developer Guide</a>.</p> </li> </ul>
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: devicefarm
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/devicefarm-2015-06-23.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://devicefarm.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS Device Farm multi-region endpoint
- url: https://devicefarm.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS Device Farm multi-region endpoint
- url: http://devicefarm.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS Device Farm endpoint for China (Beijing) and China (Ningxia)
- url: https://devicefarm.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS Device Farm endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=DeviceFarm 20150623.ListDevices'
paths:
/#X-Amz-Target=DeviceFarm_20150623.ListDevices:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ListDevices
description: Gets information about unique device types.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListDevicesResult'
'480':
description: ArgumentException
content:
application/json:
schema:
$ref: '#/components/schemas/ArgumentException'
'481':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'482':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'483':
description: ServiceAccountException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceAccountException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListDevicesRequest'
parameters:
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- DeviceFarm_20150623.ListDevices
tags:
- '#X Amz Target=DeviceFarm 20150623.ListDevices'
components:
schemas:
Long:
type: integer
DevicePlatform:
type: string
enum:
- ANDROID
- IOS
InstanceLabels:
type: array
items:
$ref: '#/components/schemas/String'
String:
type: string
DeviceAvailability:
type: string
enum:
- TEMPORARY_NOT_AVAILABLE
- BUSY
- AVAILABLE
- HIGHLY_AVAILABLE
Integer:
type: integer
Message:
type: string
minLength: 0
maxLength: 16384
DeviceFilterValues:
type: array
items:
$ref: '#/components/schemas/String'
DeviceFormFactor:
type: string
enum:
- PHONE
- TABLET
PaginationToken:
type: string
minLength: 4
maxLength: 1024
LimitExceededException: {}
Boolean:
type: boolean
DeviceInstance:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The Amazon Resource Name (ARN) of the device instance.
deviceArn:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The ARN of the device.
labels:
allOf:
- $ref: '#/components/schemas/InstanceLabels'
- description: An array of strings that describe the device instance.
status:
allOf:
- $ref: '#/components/schemas/InstanceStatus'
- description: The status of the device instance. Valid values are listed here.
udid:
allOf:
- $ref: '#/components/schemas/String'
- description: Unique device identifier for the device instance.
instanceProfile:
allOf:
- $ref: '#/components/schemas/InstanceProfile'
- description: A object that contains information about the instance profile.
description: Represents the device instance.
ArgumentException: {}
DeviceFilters:
type: array
items:
$ref: '#/components/schemas/DeviceFilter'
DeviceFilterAttribute:
type: string
enum:
- ARN
- PLATFORM
- OS_VERSION
- MODEL
- AVAILABILITY
- FORM_FACTOR
- MANUFACTURER
- REMOTE_ACCESS_ENABLED
- REMOTE_DEBUG_ENABLED
- INSTANCE_ARN
- INSTANCE_LABELS
- FLEET_TYPE
Devices:
type: array
items:
$ref: '#/components/schemas/Device'
PackageIds:
type: array
items:
$ref: '#/components/schemas/String'
DeviceFilter:
type: object
required:
- attribute
- operator
- values
properties:
attribute:
allOf:
- $ref: '#/components/schemas/DeviceFilterAttribute'
- description: '<p>The aspect of a device such as platform or model used as the selection criteria in a device filter.</p> <p>The supported operators for each attribute are provided in the following list.</p> <dl> <dt>ARN</dt> <dd> <p>The Amazon Resource Name (ARN) of the device (for example, <code>arn:aws:devicefarm:us-west-2::device:12345Example</code>).</p> <p>Supported operators: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>PLATFORM</dt> <dd> <p>The device platform. Valid values are ANDROID or IOS.</p> <p>Supported operators: <code>EQUALS</code> </p> </dd> <dt>OS_VERSION</dt> <dd> <p>The operating system version (for example, 10.3.2).</p> <p>Supported operators: <code>EQUALS</code>, <code>GREATER_THAN</code>, <code>GREATER_THAN_OR_EQUALS</code>, <code>IN</code>, <code>LESS_THAN</code>, <code>LESS_THAN_OR_EQUALS</code>, <code>NOT_IN</code> </p> </dd> <dt>MODEL</dt> <dd> <p>The device model (for example, iPad 5th Gen).</p> <p>Supported operators: <code>CONTAINS</code>, <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>AVAILABILITY</dt> <dd> <p>The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.</p> <p>Supported operators: <code>EQUALS</code> </p> </dd> <dt>FORM_FACTOR</dt> <dd> <p>The device form factor. Valid values are PHONE or TABLET.</p> <p>Supported operators: <code>EQUALS</code> </p> </dd> <dt>MANUFACTURER</dt> <dd> <p>The device manufacturer (for example, Apple).</p> <p>Supported operators: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>REMOTE_ACCESS_ENABLED</dt> <dd> <p>Whether the device is enabled for remote access. Valid values are TRUE or FALSE.</p> <p>Supported operators: <code>EQUALS</code> </p> </dd> <dt>REMOTE_DEBUG_ENABLED</dt> <dd> <p>Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.</p> <p>Supported operators: <code>EQUALS</code> </p> <p>Because remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no longer supported</a>, this filter is ignored.</p> </dd> <dt>INSTANCE_ARN</dt> <dd> <p>The Amazon Resource Name (ARN) of the device instance.</p> <p>Supported operators: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>INSTANCE_LABELS</dt> <dd> <p>The label of the device instance.</p> <p>Supported operators: <code>CONTAINS</code> </p> </dd> <dt>FLEET_TYPE</dt> <dd> <p>The fleet type. Valid values are PUBLIC or PRIVATE.</p> <p>Supported operators: <code>EQUALS</code> </p> </dd> </dl>'
operator:
allOf:
- $ref: '#/components/schemas/RuleOperator'
- description: Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions.
values:
allOf:
- $ref: '#/components/schemas/DeviceFilterValues'
- description: <p>An array of one or more filter values used in a device filter.</p> <p class="title"> <b>Operator Values</b> </p> <ul> <li> <p>The IN and NOT_IN operators can take a values array that has more than one element.</p> </li> <li> <p>The other operators require an array with a single element.</p> </li> </ul> <p class="title"> <b>Attribute Values</b> </p> <ul> <li> <p>The PLATFORM attribute can be set to ANDROID or IOS.</p> </li> <li> <p>The AVAILABILITY attribute can be set to AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.</p> </li> <li> <p>The FORM_FACTOR attribute can be set to PHONE or TABLET.</p> </li> <li> <p>The FLEET_TYPE attribute can be set to PUBLIC or PRIVATE.</p> </li> </ul>
description: <p>Represents a device filter used to select a set of devices to be included in a test run. This data structure is passed in as the <code>deviceSelectionConfiguration</code> parameter to <code>ScheduleRun</code>. For an example of the JSON request syntax, see <a>ScheduleRun</a>.</p> <p>It is also passed in as the <code>filters</code> parameter to <code>ListDevices</code>. For an example of the JSON request syntax, see <a>ListDevices</a>.</p>
ServiceAccountException: {}
NotFoundException: {}
ListDevicesResult:
type: object
example: {}
properties:
devices:
allOf:
- $ref: '#/components/schemas/Devices'
- description: Information about the devices.
nextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: 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.
description: Represents the result of a list devices operation.
ListDevicesRequest:
type: object
title: ListDevicesRequest
properties:
arn:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The Amazon Resource Name (ARN) of the project.
nextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: 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.
filters:
allOf:
- $ref: '#/components/schemas/DeviceFilters'
- description: '<p>Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.</p> <ul> <li> <p>Attribute: The aspect of a device such as platform or model used as the selection criteria in a device filter.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The Amazon Resource Name (ARN) of the device (for example, <code>arn:aws:devicefarm:us-west-2::device:12345Example</code>).</p> </li> <li> <p>PLATFORM: The device platform. Valid values are ANDROID or IOS.</p> </li> <li> <p>OS_VERSION: The operating system version (for example, 10.3.2).</p> </li> <li> <p>MODEL: The device model (for example, iPad 5th Gen).</p> </li> <li> <p>AVAILABILITY: The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.</p> </li> <li> <p>FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET.</p> </li> <li> <p>MANUFACTURER: The device manufacturer (for example, Apple).</p> </li> <li> <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are TRUE or FALSE.</p> </li> <li> <p>REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE. Because remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no longer supported</a>, this attribute is ignored.</p> </li> <li> <p>INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.</p> </li> <li> <p>INSTANCE_LABELS: The label of the device instance.</p> </li> <li> <p>FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.</p> </li> </ul> </li> <li> <p>Operator: The filter operator.</p> <ul> <li> <p>The EQUALS operator is available for every attribute except INSTANCE_LABELS.</p> </li> <li> <p>The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.</p> </li> <li> <p>The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.</p> </li> <li> <p>The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.</p> </li> </ul> </li> <li> <p>Values: An array of one or more filter values.</p> <ul> <li> <p>The IN and NOT_IN operators take a values array that has one or more elements.</p> </li> <li> <p>The other operators require an array with a single element.</p> </li> <li> <p>In a request, the AVAILABILITY attribute takes the following values: AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.</p> </li> </ul> </li> </ul>'
description: Represents the result of a list devices request.
AmazonResourceName:
type: string
pattern: ^arn:.+
minLength: 32
maxLength: 1011
Double:
type: number
format: double
InstanceStatus:
type: string
enum:
- IN_USE
- PREPARING
- AVAILABLE
- NOT_AVAILABLE
DeviceInstances:
type: array
items:
$ref: '#/components/schemas/DeviceInstance'
Name:
type: string
minLength: 0
maxLength: 256
Device:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The device's ARN.
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The device's display name.
manufacturer:
allOf:
- $ref: '#/components/schemas/String'
- description: The device's manufacturer name.
model:
allOf:
- $ref: '#/components/schemas/String'
- description: The device's model name.
modelId:
allOf:
- $ref: '#/components/schemas/String'
- description: The device's model ID.
formFactor:
allOf:
- $ref: '#/components/schemas/DeviceFormFactor'
- description: <p>The device's form factor.</p> <p>Allowed values include:</p> <ul> <li> <p>PHONE</p> </li> <li> <p>TABLET</p> </li> </ul>
platform:
allOf:
- $ref: '#/components/schemas/DevicePlatform'
- description: <p>The device's platform.</p> <p>Allowed values include:</p> <ul> <li> <p>ANDROID</p> </li> <li> <p>IOS</p> </li> </ul>
os:
allOf:
- $ref: '#/components/schemas/String'
- description: The device's operating system type.
cpu:
allOf:
- $ref: '#/components/schemas/CPU'
- description: Information about the device's CPU.
resolution:
allOf:
- $ref: '#/components/schemas/Resolution'
- description: The resolution of the device.
heapSize:
allOf:
- $ref: '#/components/schemas/Long'
- description: The device's heap size, expressed in bytes.
memory:
allOf:
- $ref: '#/components/schemas/Long'
- description: The device's total memory size, expressed in bytes.
image:
allOf:
- $ref: '#/components/schemas/String'
- description: The device's image name.
carrier:
allOf:
- $ref: '#/components/schemas/String'
- description: The device's carrier.
radio:
allOf:
- $ref: '#/components/schemas/String'
- description: The device's radio.
remoteAccessEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Specifies whether remote access has been enabled for the specified device.
remoteDebugEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: <p>This flag is set to <code>true</code> if remote debugging is enabled for the device.</p> <p>Remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no longer supported</a>.</p>
fleetType:
allOf:
- $ref: '#/components/schemas/String'
- description: The type of fleet to which this device belongs. Possible values are PRIVATE and PUBLIC.
fleetName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the fleet to which this device belongs.
instances:
allOf:
- $ref: '#/components/schemas/DeviceInstances'
- description: The instances that belong to this device.
availability:
allOf:
- $ref: '#/components/schemas/DeviceAvailability'
- description: Indicates how likely a device is available for a test run. Currently available in the <a>ListDevices</a> and GetDevice API methods.
description: Represents a device type that an app is tested against.
Resolution:
type: object
properties:
width:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The screen resolution's width, expressed in pixels.
height:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The screen resolution's height, expressed in pixels.
description: Represents the screen resolution of a device in height and width, expressed in pixels.
RuleOperator:
type: string
enum:
- EQUALS
- LESS_THAN
- LESS_THAN_OR_EQUALS
- GREATER_THAN
- GREATER_THAN_OR_EQUALS
- IN
- NOT_IN
- CONTAINS
CPU:
type: object
properties:
frequency:
allOf:
- $ref: '#/components/schemas/String'
- description: The CPU's frequency.
architecture:
allOf:
- $ref: '#/components/schemas/String'
- description: The CPU's architecture (for example, x86 or ARM).
clock:
allOf:
- $ref: '#/components/schemas/Double'
- description: The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000.
description: Represents the amount of CPU that an app is using on a physical device. Does not represent system-wide CPU usage.
InstanceProfile:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The Amazon Resource Name (ARN) of the instance profile.
packageCleanup:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: When set to <code>true</code>, Device Farm removes app packages after a test run. The default value is <code>false</code> for private devices.
excludeAppPackagesFromCleanup:
allOf:
- $ref: '#/components/schemas/PackageIds'
- description: <p>An array of strings containing the list of app packages that should not be cleaned up from the device after a test run completes.</p> <p>The list of packages is considered only if you set <code>packageCleanup</code> to <code>true</code>.</p>
rebootAfterUse:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: When set to <code>true</code>, Device Farm reboots the instance after a test run. The default value is <code>true</code>.
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the instance profile.
description:
allOf:
- $ref: '#/components/schemas/Message'
- description: The description of the instance profile.
description: Represents the instance profile.
parameters:
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/devicefarm/
x-hasEquivalentPaths: true