Menu
Sign In to the Console
AWS Device Farm
API Reference (API Version 2015-06-23)

AWS Documentation » AWS Device Farm Documentation » API Reference » Actions » ScheduleRun

ScheduleRun

Schedules a run.

Request Syntax

{
   "appArn": "string",
   "configuration": { 
      "auxiliaryApps": [ "string" ],
      "billingMethod": "string",
      "customerArtifactPaths": { 
         "androidPaths": [ "string" ],
         "deviceHostPaths": [ "string" ],
         "iosPaths": [ "string" ]
      },
      "extraDataPackageArn": "string",
      "locale": "string",
      "location": { 
         "latitude": number,
         "longitude": number
      },
      "networkProfileArn": "string",
      "radios": { 
         "bluetooth": boolean,
         "gps": boolean,
         "nfc": boolean,
         "wifi": boolean
      }
   },
   "devicePoolArn": "string",
   "executionConfiguration": { 
      "accountsCleanup": boolean,
      "appPackagesCleanup": boolean,
      "jobTimeoutMinutes": number
   },
   "name": "string",
   "projectArn": "string",
   "test": { 
      "filter": "string",
      "parameters": { 
         "string" : "string" 
      },
      "testPackageArn": "string",
      "type": "string"
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

appArn

The ARN of the app to schedule a run.

Type: String

Length Constraints: Minimum length of 32.

Required: No

configuration

Information about the settings for the run to be scheduled.

Type: ScheduleRunConfiguration object

Required: No

devicePoolArn

The ARN of the device pool for the run to be scheduled.

Type: String

Length Constraints: Minimum length of 32.

Required: Yes

executionConfiguration

Specifies configuration information about a test run, such as the execution timeout (in minutes).

Type: ExecutionConfiguration object

Required: No

name

The name for the run to be scheduled.

Type: String

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

Required: No

projectArn

The ARN of the project for the run to be scheduled.

Type: String

Length Constraints: Minimum length of 32.

Required: Yes

test

Information about the test for the run to be scheduled.

Type: ScheduleRunTest object

Required: Yes

Response Syntax

{
   "run": { 
      "appUpload": "string",
      "arn": "string",
      "billingMethod": "string",
      "completedJobs": number,
      "counters": { 
         "errored": number,
         "failed": number,
         "passed": number,
         "skipped": number,
         "stopped": number,
         "total": number,
         "warned": number
      },
      "created": number,
      "customerArtifactPaths": { 
         "androidPaths": [ "string" ],
         "deviceHostPaths": [ "string" ],
         "iosPaths": [ "string" ]
      },
      "deviceMinutes": { 
         "metered": number,
         "total": number,
         "unmetered": number
      },
      "devicePoolArn": "string",
      "eventCount": number,
      "jobTimeoutMinutes": number,
      "locale": "string",
      "location": { 
         "latitude": number,
         "longitude": number
      },
      "message": "string",
      "name": "string",
      "networkProfile": { 
         "arn": "string",
         "description": "string",
         "downlinkBandwidthBits": number,
         "downlinkDelayMs": number,
         "downlinkJitterMs": number,
         "downlinkLossPercent": number,
         "name": "string",
         "type": "string",
         "uplinkBandwidthBits": number,
         "uplinkDelayMs": number,
         "uplinkJitterMs": number,
         "uplinkLossPercent": number
      },
      "parsingResultUrl": "string",
      "platform": "string",
      "radios": { 
         "bluetooth": boolean,
         "gps": boolean,
         "nfc": boolean,
         "wifi": boolean
      },
      "result": "string",
      "resultCode": "string",
      "seed": number,
      "started": number,
      "status": "string",
      "stopped": number,
      "totalJobs": number,
      "type": "string",
      "webUrl": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

run

Information about the scheduled run.

Type: Run object

Errors

For information about the errors that are common to all actions, see Common Errors.

ArgumentException

An invalid argument was specified.

HTTP Status Code: 400

IdempotencyException

An entity with the same name already exists.

HTTP Status Code: 400

LimitExceededException

A limit was exceeded.

HTTP Status Code: 400

NotFoundException

The specified entity was not found.

HTTP Status Code: 400

ServiceAccountException

There was a problem with the service account.

HTTP Status Code: 400

See Also

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