{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-device-farm/refs/heads/main/json-schema/amazon-device-farm-run-schema.json", "title": "Run", "description": "Represents a test run on a set of devices with a given app package, test parameters, and so on.", "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": "
The run's type.
Must be one of the following values:
BUILTIN_FUZZ
BUILTIN_EXPLORER
For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT
APPIUM_JAVA_TESTNG
APPIUM_PYTHON
APPIUM_NODE
APPIUM_RUBY
APPIUM_WEB_JAVA_JUNIT
APPIUM_WEB_JAVA_TESTNG
APPIUM_WEB_PYTHON
APPIUM_WEB_NODE
APPIUM_WEB_RUBY
CALABASH
INSTRUMENTATION
UIAUTOMATION
UIAUTOMATOR
XCTEST
XCTEST_UI
The run's platform.
Allowed values include:
ANDROID
IOS
The run's status.
Allowed values include:
PENDING
PENDING_CONCURRENCY
PENDING_DEVICE
PROCESSING
SCHEDULING
PREPARING
RUNNING
COMPLETED
STOPPING
The run's result.
Allowed values include:
PENDING
PASSED
WARNED
FAILED
SKIPPED
ERRORED
STOPPED
Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.
If you have unmetered device slots, you must set this to unmetered to use them. Otherwise, the run is counted toward metered device minutes.
result is SKIPPED. PARSING_FAILED 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 CustomerArtifactPaths 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": "When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.
For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.
" } ] }, "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." } ] } } }