Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
version: 1.0.0
x-release: v4
title: 'AWS Device Farm #X Amz Target=DeviceFarm 20150623.CreateDevicePool #X Amz Target=DeviceFarm 20150623.CreateDevicePool #X Amz Target=DeviceFarm 20150623.ScheduleRun #X Amz Target=DeviceFarm 20150623.ScheduleRun #X Amz Target=DeviceFarm 20150623.ScheduleRun 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
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.ScheduleRun'
paths:
/#X-Amz-Target=DeviceFarm_20150623.ScheduleRun:
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: ScheduleRun
description: Schedules a run.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduleRunResult'
'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: IdempotencyException
content:
application/json:
schema:
$ref: '#/components/schemas/IdempotencyException'
'484':
description: ServiceAccountException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceAccountException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduleRunRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- DeviceFarm_20150623.ScheduleRun
tags:
- '#X Amz Target=DeviceFarm 20150623.ScheduleRun'
components:
parameters:
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
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-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
schemas:
Filter:
type: string
minLength: 0
maxLength: 8192
Message:
type: string
minLength: 0
maxLength: 16384
String:
type: string
TestParameters:
type: object
additionalProperties:
$ref: '#/components/schemas/String'
NonEmptyString:
type: string
pattern: .*\S.*
minLength: 1
maxLength: 4096
DeviceSelectionConfiguration:
type: object
required:
- filters
- maxDevices
properties:
filters:
allOf:
- $ref: '#/components/schemas/DeviceFilters'
- description: '<p>Used to dynamically select a set of devices for a test run. A filter is made up of an attribute, an operator, and one or more values.</p> <ul> <li> <p> <b>Attribute</b> </p> <p>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 filter 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> <b>Operator</b> </p> <p>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> <b>Values</b> </p> <p>An array of one or more filter values.</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> </li> </ul>'
maxDevices:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The maximum number of devices to be included in a test run.
description: Represents the device filters used in a test run and the maximum number of devices to be included in the run. It is passed in as the <code>deviceSelectionConfiguration</code> request parameter in <a>ScheduleRun</a>.
AccountsCleanup:
type: boolean
PercentInteger:
type: integer
minimum: 0
maximum: 100
Name:
type: string
minLength: 0
maxLength: 256
ScheduleRunTest:
type: object
required:
- type
properties:
type:
allOf:
- $ref: '#/components/schemas/TestType'
- description: <p>The test's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>BUILTIN_FUZZ</p> </li> <li> <p>BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT</p> </li> <li> <p>APPIUM_JAVA_TESTNG</p> </li> <li> <p>APPIUM_PYTHON</p> </li> <li> <p>APPIUM_NODE</p> </li> <li> <p>APPIUM_RUBY</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG</p> </li> <li> <p>APPIUM_WEB_PYTHON</p> </li> <li> <p>APPIUM_WEB_NODE</p> </li> <li> <p>APPIUM_WEB_RUBY</p> </li> <li> <p>CALABASH</p> </li> <li> <p>INSTRUMENTATION</p> </li> <li> <p>UIAUTOMATION</p> </li> <li> <p>UIAUTOMATOR</p> </li> <li> <p>XCTEST</p> </li> <li> <p>XCTEST_UI</p> </li> </ul>
testPackageArn:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The ARN of the uploaded test to be run.
testSpecArn:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The ARN of the YAML-formatted test specification.
filter:
allOf:
- $ref: '#/components/schemas/Filter'
- description: The test's filter.
parameters:
allOf:
- $ref: '#/components/schemas/TestParameters'
- description: '<p>The test''s parameters, such as test framework parameters and fixture settings. Parameters are represented by name-value pairs of strings.</p> <p>For all tests:</p> <ul> <li> <p> <code>app_performance_monitoring</code>: Performance monitoring is enabled by default. Set this parameter to false to disable it.</p> </li> </ul> <p>For Calabash tests:</p> <ul> <li> <p>profile: A cucumber profile (for example, <code>my_profile_name</code>).</p> </li> <li> <p>tags: You can limit execution to features or scenarios that have (or don''t have) certain tags (for example, @smoke or @smoke,~@wip).</p> </li> </ul> <p>For Appium tests (all types):</p> <ul> <li> <p>appium_version: The Appium version. Currently supported values are 1.6.5 (and later), latest, and default.</p> <ul> <li> <p>latest runs the latest Appium version supported by Device Farm (1.9.1).</p> </li> <li> <p>For default, Device Farm selects a compatible version of Appium for the device. The current behavior is to run 1.7.2 on Android devices and iOS 9 and earlier and 1.7.2 for iOS 10 and later.</p> </li> <li> <p>This behavior is subject to change.</p> </li> </ul> </li> </ul> <p>For fuzz tests (Android only):</p> <ul> <li> <p>event_count: The number of events, between 1 and 10000, that the UI fuzz test should perform.</p> </li> <li> <p>throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait between events.</p> </li> <li> <p>seed: A seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.</p> </li> </ul> <p>For Explorer tests:</p> <ul> <li> <p>username: A user name to use if the Explorer encounters a login form. If not supplied, no user name is inserted.</p> </li> <li> <p>password: A password to use if the Explorer encounters a login form. If not supplied, no password is inserted.</p> </li> </ul> <p>For Instrumentation:</p> <ul> <li> <p>filter: A test filter string. Examples:</p> <ul> <li> <p>Running a single test case: <code>com.android.abc.Test1</code> </p> </li> <li> <p>Running a single test: <code>com.android.abc.Test1#smoke</code> </p> </li> <li> <p>Running multiple tests: <code>com.android.abc.Test1,com.android.abc.Test2</code> </p> </li> </ul> </li> </ul> <p>For XCTest and XCTestUI:</p> <ul> <li> <p>filter: A test filter string. Examples:</p> <ul> <li> <p>Running a single test class: <code>LoginTests</code> </p> </li> <li> <p>Running a multiple test classes: <code>LoginTests,SmokeTests</code> </p> </li> <li> <p>Running a single test: <code>LoginTests/testValid</code> </p> </li> <li> <p>Running multiple tests: <code>LoginTests/testValid,LoginTests/testInvalid</code> </p> </li> </ul> </li> </ul> <p>For UIAutomator:</p> <ul> <li> <p>filter: A test filter string. Examples:</p> <ul> <li> <p>Running a single test case: <code>com.android.abc.Test1</code> </p> </li> <li> <p>Running a single test: <code>com.android.abc.Test1#smoke</code> </p> </li> <li> <p>Running multiple tests: <code>com.android.abc.Test1,com.android.abc.Test2</code> </p> </li> </ul> </li> </ul>'
description: Represents test settings. This data structure is passed in as the test parameter to ScheduleRun. For an example of the JSON request syntax, see <a>ScheduleRun</a>.
ExecutionStatus:
type: string
enum:
- PENDING
- PENDING_CONCURRENCY
- PENDING_DEVICE
- PROCESSING
- SCHEDULING
- PREPARING
- RUNNING
- COMPLETED
- STOPPING
AmazonResourceName:
type: string
pattern: ^arn:.+
minLength: 32
maxLength: 1011
ArgumentException: {}
ExecutionResult:
type: string
enum:
- PENDING
- PASSED
- WARNED
- FAILED
- SKIPPED
- ERRORED
- STOPPED
NetworkProfileType:
type: string
enum:
- CURATED
- PRIVATE
VpcSubnetIds:
type: array
items:
$ref: '#/components/schemas/SubnetId'
minItems: 1
maxItems: 8
LimitExceededException: {}
ScheduleRunRequest:
type: object
required:
- projectArn
- test
title: ScheduleRunRequest
properties:
projectArn:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The ARN of the project for the run to be scheduled.
appArn:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The ARN of an application package to run tests against, created with <a>CreateUpload</a>. See <a>ListUploads</a>.
devicePoolArn:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The ARN of the device pool for the run to be scheduled.
deviceSelectionConfiguration:
allOf:
- $ref: '#/components/schemas/DeviceSelectionConfiguration'
- description: <p>The filter criteria used to dynamically select a set of devices for a test run and the maximum number of devices to be included in the run.</p> <p>Either <b> <code>devicePoolArn</code> </b> or <b> <code>deviceSelectionConfiguration</code> </b> is required in a request.</p>
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name for the run to be scheduled.
test:
allOf:
- $ref: '#/components/schemas/ScheduleRunTest'
- description: Information about the test for the run to be scheduled.
configuration:
allOf:
- $ref: '#/components/schemas/ScheduleRunConfiguration'
- description: Information about the settings for the run to be scheduled.
executionConfiguration:
allOf:
- $ref: '#/components/schemas/ExecutionConfiguration'
- description: Specifies configuration information about a test run, such as the execution timeout (in minutes).
description: Represents a request to the schedule run operation.
SubnetId:
type: string
pattern: ^subnet-[0-9a-fA-F]{8,}$
minLength: 1
maxLength: 4096
Boolean:
type: boolean
SkipAppResign:
type: boolean
CustomerArtifactPaths:
type: object
properties:
iosPaths:
allOf:
- $ref: '#/components/schemas/IosPaths'
- description: Comma-separated list of paths on the iOS device where the artifacts generated by the customer's tests are pulled from.
androidPaths:
allOf:
- $ref: '#/components/schemas/AndroidPaths'
- description: Comma-separated list of paths on the Android device where the artifacts generated by the customer's tests are pulled from.
deviceHostPaths:
allOf:
- $ref: '#/components/schemas/DeviceHostPaths'
- description: Comma-separated list of paths in the test execution environment where the artifacts generated by the customer's tests are pulled from.
description: <p>A JSON object that specifies the paths where the artifacts generated by the customer's tests, on the device or in the test environment, are pulled from.</p> <p>Specify <code>deviceHostPaths</code> and optionally specify either <code>iosPaths</code> or <code>androidPaths</code>.</p> <p>For web app tests, you can specify both <code>iosPaths</code> and <code>androidPaths</code>.</p>
VpcSecurityGroupIds:
type: array
items:
$ref: '#/components/schemas/SecurityGroupId'
minItems: 1
maxItems: 5
SecurityGroupId:
type: string
pattern: ^sg-[0-9a-fA-F]{8,}$
minLength: 1
maxLength: 4096
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
Counters:
type: object
properties:
total:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The total number of entities.
passed:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of passed entities.
failed:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of failed entities.
warned:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of warned entities.
errored:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of errored entities.
stopped:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of stopped entities.
skipped:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of skipped entities.
description: Represents entity counters.
AmazonResourceNames:
type: array
items:
$ref: '#/components/schemas/AmazonResourceName'
Run:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The run's ARN.
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The run's name.
type:
allOf:
- $ref: '#/components/schemas/TestType'
- description: <p>The run's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>BUILTIN_FUZZ</p> </li> <li> <p>BUILTIN_EXPLORER</p> <note> <p>For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.</p> </note> </li> <li> <p>APPIUM_JAVA_JUNIT</p> </li> <li> <p>APPIUM_JAVA_TESTNG</p> </li> <li> <p>APPIUM_PYTHON</p> </li> <li> <p>APPIUM_NODE</p> </li> <li> <p>APPIUM_RUBY</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG</p> </li> <li> <p>APPIUM_WEB_PYTHON</p> </li> <li> <p>APPIUM_WEB_NODE</p> </li> <li> <p>APPIUM_WEB_RUBY</p> </li> <li> <p>CALABASH</p> </li> <li> <p>INSTRUMENTATION</p> </li> <li> <p>UIAUTOMATION</p> </li> <li> <p>UIAUTOMATOR</p> </li> <li> <p>XCTEST</p> </li> <li> <p>XCTEST_UI</p> </li> </ul>
platform:
allOf:
- $ref: '#/components/schemas/DevicePlatform'
- description: <p>The run's platform.</p> <p>Allowed values include:</p> <ul> <li> <p>ANDROID</p> </li> <li> <p>IOS</p> </li> </ul>
created:
allOf:
- $ref: '#/components/schemas/DateTime'
- description: When the run was created.
status:
allOf:
- $ref: '#/components/schemas/ExecutionStatus'
- description: <p>The run's status.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING</p> </li> <li> <p>PENDING_CONCURRENCY</p> </li> <li> <p>PENDING_DEVICE</p> </li> <li> <p>PROCESSING</p> </li> <li> <p>SCHEDULING</p> </li> <li> <p>PREPARING</p> </li> <li> <p>RUNNING</p> </li> <li> <p>COMPLETED</p> </li> <li> <p>STOPPING</p> </li> </ul>
result:
allOf:
- $ref: '#/components/schemas/ExecutionResult'
- description: <p>The run's result.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING</p> </li> <li> <p>PASSED</p> </li> <li> <p>WARNED</p> </li> <li> <p>FAILED</p> </li> <li> <p>SKIPPED</p> </li> <li> <p>ERRORED</p> </li> <li> <p>STOPPED</p> </li> </ul>
started:
allOf:
- $ref: '#/components/schemas/DateTime'
- description: The run's start time.
stopped:
allOf:
- $ref: '#/components/schemas/DateTime'
- description: The run's stop time.
counters:
allOf:
- $ref: '#/components/schemas/Counters'
- description: The run's result counters.
message:
allOf:
- $ref: '#/components/schemas/Message'
- description: A message about the run's result.
totalJobs:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The total number of jobs for the run.
completedJobs:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The total number of completed jobs.
billingMethod:
allOf:
- $ref: '#/components/schemas/BillingMethod'
- description: '<p>Specifies the billing method for a test run: <code>metered</code> or <code>unmetered</code>. If the parameter is not specified, the default value is <code>metered</code>.</p> <note> <p>If you have unmetered device slots, you must set this to <code>unmetered</code> to use them. Otherwise, the run is counted toward metered device minutes.</p> </note>'
deviceMinutes:
allOf:
- $ref: '#/components/schemas/DeviceMinutes'
- description: Represents the total (metered or unmetered) minutes used by the test run.
networkProfile:
allOf:
- $ref: '#/components/schemas/NetworkProfile'
- description: The network profile being used for a test run.
parsingResultUrl:
allOf:
- $ref: '#/components/schemas/String'
- description: Read-only URL for an object in an 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:
allOf:
- $ref: '#/components/schemas/ExecutionResultCode'
- description: Supporting field for the result field. Set only if <code>result</code> is <code>SKIPPED</code>. <code>PARSING_FAILED</code> if the result is skipped because of test package parsing failure.
seed:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 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:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: An app to upload or that has been uploaded.
eventCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.
jobTimeoutMinutes:
allOf:
- $ref: '#/components/schemas/JobTimeoutMinutes'
- description: The number of minutes the job executes before it times out.
devicePoolArn:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The ARN of the device pool for the run.
locale:
allOf:
- $ref: '#/components/schemas/String'
- description: Information about the locale that is used for the run.
radios:
allOf:
- $ref: '#/components/schemas/Radios'
- description: Information about the radio states for the run.
location:
allOf:
- $ref: '#/components/schemas/Location'
- description: Information about the location that is used for the run.
customerArtifactPaths:
allOf:
- $ref: '#/components/schemas/CustomerArtifactPaths'
- description: Output <code>CustomerArtifactPaths</code> object for the test run.
webUrl:
allOf:
- $ref: '#/components/schemas/String'
- description: The Device Farm console URL for the recording of the run.
skipAppResign:
allOf:
- $ref: '#/components/schemas/SkipAppResign'
- description: <p>When set to <code>true</code>, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.</p> <p>For more information about how Device Farm re-signs your apps, see <a href="http://aws.amazon.com/device-farm/faqs/">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>
testSpecArn:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The ARN of the YAML-formatted test specification for the run.
deviceSelectionResult:
allOf:
- $ref: '#/components/schemas/DeviceSelectionResult'
- description: The results of a device filter used to select the devices for a test run.
vpcConfig:
allOf:
- $ref: '#/components/schemas/VpcConfig'
- description: The VPC security groups and subnets that are attached to a project.
description: Represents a test run on a set of devices with a given app package, test parameters, and so on.
Radios:
type: object
properties:
wifi:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: True if Wi-Fi is enabled at the beginning of the test. Otherwise, false.
bluetooth:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: True if Bluetooth is enabled at the beginning of the test. Otherwise, false.
nfc:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: True if NFC is enabled at the beginning of the test. Otherwise, false.
gps:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: True if GPS is enabled at the beginning of the test. Otherwise, false.
description: Represents the set of radios and their states on a device. Examples of radios include Wi-Fi, GPS, Bluetooth, and NFC.
DateTime:
type: string
format: date-time
Long:
type: integer
IdempotencyException: {}
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
# --- truncated at 32 KB (45 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-device-farm/refs/heads/main/openapi/amazon-device-farm-x-amz-target-devicefarm-20150623-schedulerun-api-openapi.yml