AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Invokes the ScheduleRun operation against AWS Device Farm.

Syntax

Submit-DFTestRun
-ExecutionConfiguration_AccountsCleanup <Boolean>
-AppArn <String>
-ExecutionConfiguration_AppPackagesCleanup <Boolean>
-Configuration_AuxiliaryApp <String[]>
-Configuration_BillingMethod <BillingMethod>
-Radios_Bluetooth <Boolean>
-DevicePoolArn <String>
-Configuration_ExtraDataPackageArn <String>
-Test_Filter <String>
-Radios_Gp <Boolean>
-ExecutionConfiguration_JobTimeoutMinute <Int32>
-Location_Latitude <Double>
-Configuration_Locale <String>
-Location_Longitude <Double>
-Name <String>
-Configuration_NetworkProfileArn <String>
-Radios_Nfc <Boolean>
-Test_Parameter <Hashtable>
-ProjectArn <String>
-Test_TestPackageArn <String>
-Test_Type <TestType>
-Radios_Wifi <Boolean>
-Force <SwitchParameter>

Description

Schedules a run.

Parameters

-AppArn <String>
The ARN of the app to schedule a run.
Required?False
Position?Named
Accept pipeline input?False
-Configuration_AuxiliaryApp <String[]>
A list of auxiliary apps for the run.
Required?False
Position?Named
Accept pipeline input?False
-Configuration_BillingMethod <BillingMethod>
Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.
Required?False
Position?Named
Accept pipeline input?False
-Configuration_ExtraDataPackageArn <String>
The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm will extract to external data for Android or the app's sandbox for iOS.
Required?False
Position?Named
Accept pipeline input?False
-Configuration_Locale <String>
Information about the locale that is used for the run.
Required?False
Position?Named
Accept pipeline input?False
-Configuration_NetworkProfileArn <String>
Reserved for internal use.
Required?False
Position?Named
Accept pipeline input?False
-DevicePoolArn <String>
The ARN of the device pool for the run to be scheduled.
Required?False
Position?Named
Accept pipeline input?False
-ExecutionConfiguration_AccountsCleanup <Boolean>
True if account cleanup is enabled at the beginning of the test; otherwise, false.
Required?False
Position?Named
Accept pipeline input?False
-ExecutionConfiguration_AppPackagesCleanup <Boolean>
True if app package cleanup is enabled at the beginning of the test; otherwise, false.
Required?False
Position?Named
Accept pipeline input?False
-ExecutionConfiguration_JobTimeoutMinute <Int32>
The number of minutes a test run will execute before it times out.
Required?False
Position?Named
Accept pipeline input?False
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?False
-Location_Latitude <Double>
The latitude.
Required?False
Position?Named
Accept pipeline input?False
-Location_Longitude <Double>
The longitude.
Required?False
Position?Named
Accept pipeline input?False
-Name <String>
The name for the run to be scheduled.
Required?False
Position?Named
Accept pipeline input?False
-ProjectArn <String>
The ARN of the project for the run to be scheduled.
Required?False
Position?Named
Accept pipeline input?False
-Radios_Bluetooth <Boolean>
True if Bluetooth is enabled at the beginning of the test; otherwise, false.
Required?False
Position?Named
Accept pipeline input?False
-Radios_Gp <Boolean>
True if GPS is enabled at the beginning of the test; otherwise, false.
Required?False
Position?Named
Accept pipeline input?False
-Radios_Nfc <Boolean>
True if NFC is enabled at the beginning of the test; otherwise, false.
Required?False
Position?Named
Accept pipeline input?False
-Radios_Wifi <Boolean>
True if Wi-Fi is enabled at the beginning of the test; otherwise, false.
Required?False
Position?Named
Accept pipeline input?False
-Test_Filter <String>
The test's filter.
Required?False
Position?Named
Accept pipeline input?False
-Test_Parameter <Hashtable>
The test's parameters, such as the following test framework parameters and fixture settings:For Calabash tests:
  • profile: A cucumber profile, for example, "my_profile_name".
  • tags: You can limit execution to features or scenarios that have (or don't have) certain tags, for example, "@smoke" or "@smoke,~@wip".
For Appium tests (all types):
  • appium_version: The Appium version. Currently supported values are "1.4.16", "1.6.3", "latest", and "default".
    • “latest” will run the latest Appium version supported by Device Farm (1.6.3).
    • For “default”, Device Farm will choose a compatible version of Appium for the device. The current behavior is to run 1.4.16 on Android devices and iOS 9 and earlier, 1.6.3 for iOS 10 and later.
    • This behavior is subject to change.
For Fuzz tests (Android only):
  • event_count: The number of events, between 1 and 10000, that the UI fuzz test should perform.
  • throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait between events.
  • seed: A seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.
For Explorer tests:
  • username: A username to use if the Explorer encounters a login form. If not supplied, no username will be inserted.
  • password: A password to use if the Explorer encounters a login form. If not supplied, no password will be inserted.
For Instrumentation:
  • filter: A test filter string. Examples:
    • Running a single test case: "com.android.abc.Test1"
    • Running a single test: "com.android.abc.Test1#smoke"
    • Running multiple tests: "com.android.abc.Test1,com.android.abc.Test2"
For XCTest and XCTestUI:
  • filter: A test filter string. Examples:
    • Running a single test class: "LoginTests"
    • Running a multiple test classes: "LoginTests,SmokeTests"
    • Running a single test: "LoginTests/testValid"
    • Running multiple tests: "LoginTests/testValid,LoginTests/testInvalid"
For UIAutomator:
  • filter: A test filter string. Examples:
    • Running a single test case: "com.android.abc.Test1"
    • Running a single test: "com.android.abc.Test1#smoke"
    • Running multiple tests: "com.android.abc.Test1,com.android.abc.Test2"
Required?False
Position?Named
Accept pipeline input?False
-Test_TestPackageArn <String>
The ARN of the uploaded test that will be run.
Required?False
Position?Named
Accept pipeline input?False
-Test_Type <TestType>
The test'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.
Required?False
Position?Named
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

This cmdlet does not accept pipeline input.

Outputs

This cmdlet returns a Run object. The service call response (type Amazon.DeviceFarm.Model.ScheduleRunResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z