AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

Run

import "github.com/aws/aws-sdk-go/service/devicefarm"

type Run struct { AppUpload *string `locationName:"appUpload" min:"32" type:"string"` Arn *string `locationName:"arn" min:"32" type:"string"` BillingMethod *string `locationName:"billingMethod" type:"string" enum:"BillingMethod"` CompletedJobs *int64 `locationName:"completedJobs" type:"integer"` Counters *Counters `locationName:"counters" type:"structure"` Created *time.Time `locationName:"created" type:"timestamp"` CustomerArtifactPaths *CustomerArtifactPaths `locationName:"customerArtifactPaths" type:"structure"` DeviceMinutes *DeviceMinutes `locationName:"deviceMinutes" type:"structure"` DevicePoolArn *string `locationName:"devicePoolArn" min:"32" type:"string"` DeviceSelectionResult *DeviceSelectionResult `locationName:"deviceSelectionResult" type:"structure"` EventCount *int64 `locationName:"eventCount" type:"integer"` JobTimeoutMinutes *int64 `locationName:"jobTimeoutMinutes" type:"integer"` Locale *string `locationName:"locale" type:"string"` Location *Location `locationName:"location" type:"structure"` Message *string `locationName:"message" type:"string"` Name *string `locationName:"name" type:"string"` NetworkProfile *NetworkProfile `locationName:"networkProfile" type:"structure"` ParsingResultUrl *string `locationName:"parsingResultUrl" type:"string"` Platform *string `locationName:"platform" type:"string" enum:"DevicePlatform"` Radios *Radios `locationName:"radios" type:"structure"` Result *string `locationName:"result" type:"string" enum:"ExecutionResult"` ResultCode *string `locationName:"resultCode" type:"string" enum:"ExecutionResultCode"` Seed *int64 `locationName:"seed" type:"integer"` SkipAppResign *bool `locationName:"skipAppResign" type:"boolean"` Started *time.Time `locationName:"started" type:"timestamp"` Status *string `locationName:"status" type:"string" enum:"ExecutionStatus"` Stopped *time.Time `locationName:"stopped" type:"timestamp"` TestSpecArn *string `locationName:"testSpecArn" min:"32" type:"string"` TotalJobs *int64 `locationName:"totalJobs" type:"integer"` Type *string `locationName:"type" type:"string" enum:"TestType"` WebUrl *string `locationName:"webUrl" type:"string"` }

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

AppUpload

Type: *string

An app to upload or that has been uploaded.

Arn

Type: *string

The run's ARN.

BillingMethod

Type: *string

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

CompletedJobs

Type: *int64

The total number of completed jobs.

Counters

Represents entity counters.

Created

Type: *time.Time

When the run was created.

CustomerArtifactPaths

A JSON object specifying the paths where the artifacts generated by the customer's tests, on the device or in the test environment, will be pulled from.

Specify deviceHostPaths and optionally specify either iosPaths or androidPaths.

For web app tests, you can specify both iosPaths and androidPaths.

DeviceMinutes

Represents the total (metered or unmetered) minutes used by the resource to run tests. Contains the sum of minutes consumed by all children.

DevicePoolArn

Type: *string

The ARN of the device pool for the run.

DeviceSelectionResult

Contains the run results requested by the device selection configuration as well as how many devices were returned. For an example of the JSON response syntax, see ScheduleRun.

EventCount

Type: *int64

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

JobTimeoutMinutes

Type: *int64

The number of minutes the job will execute before it times out.

Locale

Type: *string

Information about the locale that is used for the run.

Location

Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example 47.6204, -122.3491).

Elevation is currently not supported.

Message

Type: *string

A message about the run's result.

Name

Type: *string

The run's name.

NetworkProfile

An array of settings that describes characteristics of a network profile.

ParsingResultUrl

Type: *string

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.

Platform

Type: *string

The run's platform.

Allowed values include:

  • ANDROID: The Android platform.

  • IOS: The iOS platform.

Radios

Represents the set of radios and their states on a device. Examples of radios include Wi-Fi, GPS, Bluetooth, and NFC.

Result

Type: *string

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.

ResultCode

Type: *string

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.

Seed

Type: *int64

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.

SkipAppResign

Type: *bool

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? (https://aws.amazon.com/device-farm/faq/) in the AWS Device Farm FAQs.

Started

Type: *time.Time

The run's start time.

Status

Type: *string

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.

Stopped

Type: *time.Time

The run's stop time.

TestSpecArn

Type: *string

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

TotalJobs

Type: *int64

The total number of jobs for the run.

Type

Type: *string

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_NODE: The Appium Node.js type.

  • APPIUM_RUBY: The Appium Ruby 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.

  • APPIUM_WEB_NODE: The Appium Node.js type for web apps.

  • APPIUM_WEB_RUBY: The Appium Ruby 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.

WebUrl

Type: *string

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

Method

GoString

func (s Run) GoString() string

GoString returns the string representation

SetAppUpload

func (s *Run) SetAppUpload(v string) *Run

SetAppUpload sets the AppUpload field's value.

SetArn

func (s *Run) SetArn(v string) *Run

SetArn sets the Arn field's value.

SetBillingMethod

func (s *Run) SetBillingMethod(v string) *Run

SetBillingMethod sets the BillingMethod field's value.

SetCompletedJobs

func (s *Run) SetCompletedJobs(v int64) *Run

SetCompletedJobs sets the CompletedJobs field's value.

SetCounters

func (s *Run) SetCounters(v *Counters) *Run

SetCounters sets the Counters field's value.

SetCreated

func (s *Run) SetCreated(v time.Time) *Run

SetCreated sets the Created field's value.

SetCustomerArtifactPaths

func (s *Run) SetCustomerArtifactPaths(v *CustomerArtifactPaths) *Run

SetCustomerArtifactPaths sets the CustomerArtifactPaths field's value.

SetDeviceMinutes

func (s *Run) SetDeviceMinutes(v *DeviceMinutes) *Run

SetDeviceMinutes sets the DeviceMinutes field's value.

SetDevicePoolArn

func (s *Run) SetDevicePoolArn(v string) *Run

SetDevicePoolArn sets the DevicePoolArn field's value.

SetDeviceSelectionResult

func (s *Run) SetDeviceSelectionResult(v *DeviceSelectionResult) *Run

SetDeviceSelectionResult sets the DeviceSelectionResult field's value.

SetEventCount

func (s *Run) SetEventCount(v int64) *Run

SetEventCount sets the EventCount field's value.

SetJobTimeoutMinutes

func (s *Run) SetJobTimeoutMinutes(v int64) *Run

SetJobTimeoutMinutes sets the JobTimeoutMinutes field's value.

SetLocale

func (s *Run) SetLocale(v string) *Run

SetLocale sets the Locale field's value.

SetLocation

func (s *Run) SetLocation(v *Location) *Run

SetLocation sets the Location field's value.

SetMessage

func (s *Run) SetMessage(v string) *Run

SetMessage sets the Message field's value.

SetName

func (s *Run) SetName(v string) *Run

SetName sets the Name field's value.

SetNetworkProfile

func (s *Run) SetNetworkProfile(v *NetworkProfile) *Run

SetNetworkProfile sets the NetworkProfile field's value.

SetParsingResultUrl

func (s *Run) SetParsingResultUrl(v string) *Run

SetParsingResultUrl sets the ParsingResultUrl field's value.

SetPlatform

func (s *Run) SetPlatform(v string) *Run

SetPlatform sets the Platform field's value.

SetRadios

func (s *Run) SetRadios(v *Radios) *Run

SetRadios sets the Radios field's value.

SetResult

func (s *Run) SetResult(v string) *Run

SetResult sets the Result field's value.

SetResultCode

func (s *Run) SetResultCode(v string) *Run

SetResultCode sets the ResultCode field's value.

SetSeed

func (s *Run) SetSeed(v int64) *Run

SetSeed sets the Seed field's value.

SetSkipAppResign

func (s *Run) SetSkipAppResign(v bool) *Run

SetSkipAppResign sets the SkipAppResign field's value.

SetStarted

func (s *Run) SetStarted(v time.Time) *Run

SetStarted sets the Started field's value.

SetStatus

func (s *Run) SetStatus(v string) *Run

SetStatus sets the Status field's value.

SetStopped

func (s *Run) SetStopped(v time.Time) *Run

SetStopped sets the Stopped field's value.

SetTestSpecArn

func (s *Run) SetTestSpecArn(v string) *Run

SetTestSpecArn sets the TestSpecArn field's value.

SetTotalJobs

func (s *Run) SetTotalJobs(v int64) *Run

SetTotalJobs sets the TotalJobs field's value.

SetType

func (s *Run) SetType(v string) *Run

SetType sets the Type field's value.

SetWebUrl

func (s *Run) SetWebUrl(v string) *Run

SetWebUrl sets the WebUrl field's value.

String

func (s Run) String() string

String returns the string representation

On this page: