Menu
AWS Device Farm
API Reference (API Version 2015-06-23)

Run

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

Contents

appUpload

An app to upload or that has been uploaded.

Type: String

Length Constraints: Minimum length of 32.

Required: No

arn

The run's ARN.

Type: String

Length Constraints: Minimum length of 32.

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.

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.

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 will execute 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 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: The Android platform.

  • IOS: The iOS platform.

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: A pending condition.

  • PASSED: A passing condition.

  • WARNED: A warning condition.

  • FAILED: A failed condition.

  • SKIPPED: A skipped condition.

  • ERRORED: An error condition.

  • STOPPED: A stopped condition.

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 will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.

For more information about how Device Farm re-signs your app(s), 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: A pending status.

  • PENDING_CONCURRENCY: A pending concurrency status.

  • PENDING_DEVICE: A pending device status.

  • PROCESSING: A processing status.

  • SCHEDULING: A scheduling status.

  • PREPARING: A preparing status.

  • RUNNING: A running status.

  • COMPLETED: A completed status.

  • STOPPING: A stopping status.

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

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: The built-in fuzz type.

  • BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

  • APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

  • APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

  • APPIUM_PYTHON: The Appium Python type.

  • APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.

  • APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.

  • APPIUM_WEB_PYTHON: The Appium Python type for Web apps.

  • CALABASH: The Calabash type.

  • INSTRUMENTATION: The Instrumentation type.

  • UIAUTOMATION: The uiautomation type.

  • UIAUTOMATOR: The uiautomator type.

  • XCTEST: The XCode test type.

  • XCTEST_UI: The XCode UI test type.

Type: String

Valid Values: BUILTIN_FUZZ | BUILTIN_EXPLORER | WEB_PERFORMANCE_PROFILE | APPIUM_JAVA_JUNIT | APPIUM_JAVA_TESTNG | APPIUM_PYTHON | APPIUM_WEB_JAVA_JUNIT | APPIUM_WEB_JAVA_TESTNG | APPIUM_WEB_PYTHON | CALABASH | INSTRUMENTATION | UIAUTOMATION | UIAUTOMATOR | XCTEST | XCTEST_UI | REMOTE_ACCESS_RECORD | REMOTE_ACCESS_REPLAY | CUSTOM

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:

On this page: