Run - AWS Device Farm Documentation
ContentsSee Also

Run

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

Contents

appUpload

An app to upload or that has been uploaded.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 1011.

Pattern: ^arn:.+

Required: No

arn

The run's ARN.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 1011.

Pattern: ^arn:.+

Required: No

billingMethod

Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.

Note

If you have unmetered device slots, you must set this to unmetered to use them. Otherwise, the run is counted toward metered device minutes.

Type: String

Valid Values: METERED | UNMETERED

Required: No

completedJobs

The total number of completed jobs.

Type: Integer

Required: No

counters

The run's result counters.

Type: Counters object

Required: No

created

When the run was created.

Type: Timestamp

Required: No

customerArtifactPaths

Output CustomerArtifactPaths object for the test run.

Type: CustomerArtifactPaths object

Required: No

deviceMinutes

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

Type: DeviceMinutes object

Required: No

devicePoolArn

The ARN of the device pool for the run.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 1011.

Pattern: ^arn:.+

Required: No

deviceSelectionResult

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

Type: DeviceSelectionResult object

Required: No

eventCount

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

Type: Integer

Required: No

jobTimeoutMinutes

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

Type: Integer

Required: No

locale

Information about the locale that is used for the run.

Type: String

Required: No

location

Information about the location that is used for the run.

Type: Location object

Required: No

message

A message about the run's result.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 16384.

Required: No

name

The run's name.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

networkProfile

The network profile being used for a test run.

Type: NetworkProfile object

Required: No

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.

Type: String

Required: No

platform

The run's platform.

Allowed values include:

  • ANDROID

  • IOS

Type: String

Valid Values: ANDROID | IOS

Required: No

radios

Information about the radio states for the run.

Type: Radios object

Required: No

result

The run's result.

Allowed values include:

  • PENDING

  • PASSED

  • WARNED

  • FAILED

  • SKIPPED

  • ERRORED

  • STOPPED

Type: String

Valid Values: PENDING | PASSED | WARNED | FAILED | SKIPPED | ERRORED | STOPPED

Required: No

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.

Type: String

Valid Values: PARSING_FAILED | VPC_ENDPOINT_SETUP_FAILED

Required: No

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.

Type: Integer

Required: No

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.

Type: Boolean

Required: No

started

The run's start time.

Type: Timestamp

Required: No

status

The run's status.

Allowed values include:

  • PENDING

  • PENDING_CONCURRENCY

  • PENDING_DEVICE

  • PROCESSING

  • SCHEDULING

  • PREPARING

  • RUNNING

  • COMPLETED

  • STOPPING

Type: String

Valid Values: PENDING | PENDING_CONCURRENCY | PENDING_DEVICE | PROCESSING | SCHEDULING | PREPARING | RUNNING | COMPLETED | STOPPING

Required: No

stopped

The run's stop time.

Type: Timestamp

Required: No

testSpecArn

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

Type: String

Length Constraints: Minimum length of 32. Maximum length of 1011.

Pattern: ^arn:.+

Required: No

totalJobs

The total number of jobs for the run.

Type: Integer

Required: No

type

The run's type.

Must be one of the following values:

  • BUILTIN_FUZZ

  • BUILTIN_EXPLORER

    Note

    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

Type: String

Valid Values: BUILTIN_FUZZ | BUILTIN_EXPLORER | WEB_PERFORMANCE_PROFILE | 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 | REMOTE_ACCESS_RECORD | REMOTE_ACCESS_REPLAY

Required: No

vpcConfig

The VPC security groups and subnets that are attached to a project.

Type: VpcConfig object

Required: No

webUrl

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

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: