Documentation

Represents a test run on a set of devices with a given app package, test parameters, and so on.

See: newRun smart constructor.

Create a value of Run with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:billingMethod:Run', run_billingMethod - 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.

$sel:skipAppResign:Run', run_skipAppResign - 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.

$sel:status:Run', run_status - The run's status.

Allowed values include:

• PENDING
• PENDING_CONCURRENCY
• PENDING_DEVICE
• PROCESSING
• SCHEDULING
• PREPARING
• RUNNING
• COMPLETED
• STOPPING

$sel:customerArtifactPaths:Run', run_customerArtifactPaths - Output CustomerArtifactPaths object for the test run.

$sel:eventCount:Run', run_eventCount - For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.

$sel:counters:Run', run_counters - The run's result counters.

$sel:platform:Run', run_platform - The run's platform.

Allowed values include:

• ANDROID
• IOS

$sel:seed:Run', run_seed - 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.

$sel:radios:Run', run_radios - Information about the radio states for the run.

$sel:arn:Run', run_arn - The run's ARN.

$sel:location:Run', run_location - Information about the location that is used for the run.

$sel:created:Run', run_created - When the run was created.

$sel:locale:Run', run_locale - Information about the locale that is used for the run.

$sel:testSpecArn:Run', run_testSpecArn - The ARN of the YAML-formatted test specification for the run.

$sel:stopped:Run', run_stopped - The run's stop time.

$sel:result:Run', run_result - The run's result.

Allowed values include:

• PENDING
• PASSED
• WARNED
• FAILED
• SKIPPED
• ERRORED
• STOPPED

$sel:jobTimeoutMinutes:Run', run_jobTimeoutMinutes - The number of minutes the job executes before it times out.

$sel:completedJobs:Run', run_completedJobs - The total number of completed jobs.

$sel:resultCode:Run', run_resultCode - 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.

$sel:name:Run', run_name - The run's name.

$sel:appUpload:Run', run_appUpload - An app to upload or that has been uploaded.

$sel:parsingResultUrl:Run', run_parsingResultUrl - 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.

$sel:networkProfile:Run', run_networkProfile - The network profile being used for a test run.

$sel:deviceMinutes:Run', run_deviceMinutes - Represents the total (metered or unmetered) minutes used by the test run.

$sel:type':Run', run_type - 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

$sel:message:Run', run_message - A message about the run's result.

$sel:webUrl:Run', run_webUrl - The Device Farm console URL for the recording of the run.

$sel:totalJobs:Run', run_totalJobs - The total number of jobs for the run.

$sel:devicePoolArn:Run', run_devicePoolArn - The ARN of the device pool for the run.

$sel:started:Run', run_started - The run's start time.

$sel:deviceSelectionResult:Run', run_deviceSelectionResult - The results of a device filter used to select the devices for a test run.

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.

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.

The run's status.

Allowed values include:

• PENDING
• PENDING_CONCURRENCY
• PENDING_DEVICE
• PROCESSING
• SCHEDULING
• PREPARING
• RUNNING
• COMPLETED
• STOPPING

Output CustomerArtifactPaths object for the test run.

For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.

The run's result counters.

The run's platform.

Allowed values include:

• ANDROID
• IOS

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.

Information about the radio states for the run.

The run's ARN.

Information about the location that is used for the run.

When the run was created.

Information about the locale that is used for the run.

The ARN of the YAML-formatted test specification for the run.

The run's stop time.

The run's result.

Allowed values include:

• PENDING
• PASSED
• WARNED
• FAILED
• SKIPPED
• ERRORED
• STOPPED

The number of minutes the job executes before it times out.

The total number of completed jobs.

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.

The run's name.

An app to upload or that has been uploaded.

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.

The network profile being used for a test run.

Represents the total (metered or unmetered) minutes used by the test run.

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

A message about the run's result.

The Device Farm console URL for the recording of the run.

The total number of jobs for the run.

The ARN of the device pool for the run.

The run's start time.

The results of a device filter used to select the devices for a test run.