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

Calls the AWS Device Farm ScheduleRun API operation.

Syntax

Submit-DFTestRun
-Name <String>
-ExecutionConfiguration_AccountsCleanup <Boolean>
-CustomerArtifactPaths_AndroidPath <String[]>
-AppArn <String>
-ExecutionConfiguration_AppPackagesCleanup <Boolean>
-Configuration_AuxiliaryApp <String[]>
-Configuration_BillingMethod <BillingMethod>
-Radios_Bluetooth <Boolean>
-CustomerArtifactPaths_DeviceHostPath <String[]>
-DevicePoolArn <String>
-Configuration_ExtraDataPackageArn <String>
-Test_Filter <String>
-DeviceSelectionConfiguration_Filter <DeviceFilter[]>
-Radios_Gp <Boolean>
-CustomerArtifactPaths_IosPath <String[]>
-ExecutionConfiguration_JobTimeoutMinute <Int32>
-Location_Latitude <Double>
-Configuration_Locale <String>
-Location_Longitude <Double>
-DeviceSelectionConfiguration_MaxDevice <Int32>
-Configuration_NetworkProfileArn <String>
-Radios_Nfc <Boolean>
-Test_Parameter <Hashtable>
-ProjectArn <String>
-ExecutionConfiguration_SkipAppResign <Boolean>
-Test_TestPackageArn <String>
-Test_TestSpecArn <String>
-Test_Type <TestType>
-ExecutionConfiguration_VideoCapture <Boolean>
-Configuration_VpceConfigurationArn <String[]>
-Radios_Wifi <Boolean>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonDeviceFarmConfig>

Description

Schedules a run.

Parameters

-AppArn <String>
The ARN of an application package to run tests against, created with CreateUpload. See ListUploads.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonDeviceFarmConfig>
Amazon.PowerShell.Cmdlets.DF.AmazonDeviceFarmClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_AuxiliaryApp <String[]>
A list of upload ARNs for app packages to be installed with your app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_AuxiliaryApps
-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.If you have purchased unmetered device slots, you must set this parameter to unmetered to make use of them. Otherwise, your run counts against your metered time.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_ExtraDataPackageArn <String>
The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm extracts to external data for Android or the app's sandbox for iOS.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_Locale <String>
Information about the locale that is used for the run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_NetworkProfileArn <String>
Reserved for internal use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_VpceConfigurationArn <String[]>
An array of ARNs for your VPC endpoint configurations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_VpceConfigurationArns
-CustomerArtifactPaths_AndroidPath <String[]>
Comma-separated list of paths on the Android device where the artifacts generated by the customer's tests are pulled from.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_CustomerArtifactPaths_AndroidPaths
-CustomerArtifactPaths_DeviceHostPath <String[]>
Comma-separated list of paths in the test execution environment where the artifacts generated by the customer's tests are pulled from.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_CustomerArtifactPaths_DeviceHostPaths
-CustomerArtifactPaths_IosPath <String[]>
Comma-separated list of paths on the iOS device where the artifacts generated by the customer's tests are pulled from.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_CustomerArtifactPaths_IosPaths
-DevicePoolArn <String>
The ARN of the device pool for the run to be scheduled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceSelectionConfiguration_Filter <DeviceFilter[]>
Used to dynamically select a set of devices for a test run. A filter is made up of an attribute, an operator, and one or more values.
  • AttributeThe aspect of a device such as platform or model used as the selection criteria in a device filter.Allowed values include:
    • ARN: The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example).
    • PLATFORM: The device platform. Valid values are ANDROID or IOS.
    • OS_VERSION: The operating system version (for example, 10.3.2).
    • MODEL: The device model (for example, iPad 5th Gen).
    • AVAILABILITY: The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
    • FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET.
    • MANUFACTURER: The device manufacturer (for example, Apple).
    • REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
    • REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE. Because remote debugging is no longer supported, this filter is ignored.
    • INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
    • INSTANCE_LABELS: The label of the device instance.
    • FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.
  • OperatorThe filter operator.
    • The EQUALS operator is available for every attribute except INSTANCE_LABELS.
    • The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.
    • The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.
    • The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.
  • ValuesAn array of one or more filter values.Operator Values
    • The IN and NOT_IN operators can take a values array that has more than one element.
    • The other operators require an array with a single element.
    Attribute Values
    • The PLATFORM attribute can be set to ANDROID or IOS.
    • The AVAILABILITY attribute can be set to AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
    • The FORM_FACTOR attribute can be set to PHONE or TABLET.
    • The FLEET_TYPE attribute can be set to PUBLIC or PRIVATE.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeviceSelectionConfiguration_Filters
-DeviceSelectionConfiguration_MaxDevice <Int32>
The maximum number of devices to be included in a test run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeviceSelectionConfiguration_MaxDevices
-ExecutionConfiguration_AccountsCleanup <Boolean>
True if account cleanup is enabled at the beginning of the test. Otherwise, false.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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?True (ByPropertyName)
-ExecutionConfiguration_JobTimeoutMinute <Int32>
The number of minutes a test run executes before it times out.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExecutionConfiguration_JobTimeoutMinutes
-ExecutionConfiguration_SkipAppResign <Boolean>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExecutionConfiguration_VideoCapture <Boolean>
Set to true to enable video capture. Otherwise, set to false. The default is true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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?True (ByPropertyName)
-Location_Latitude <Double>
The latitude.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Location_Latitude
-Location_Longitude <Double>
The longitude.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Location_Longitude
-Name <String>
The name for the run to be scheduled.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProjectArn <String>
The ARN of the project for the run to be scheduled.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Radios_Bluetooth <Boolean>
True if Bluetooth is enabled at the beginning of the test. Otherwise, false.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Radios_Bluetooth
-Radios_Gp <Boolean>
True if GPS is enabled at the beginning of the test. Otherwise, false.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Radios_Gps
-Radios_Nfc <Boolean>
True if NFC is enabled at the beginning of the test. Otherwise, false.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Radios_Nfc
-Radios_Wifi <Boolean>
True if Wi-Fi is enabled at the beginning of the test. Otherwise, false.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Radios_Wifi
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Run'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DeviceFarm.Model.ScheduleRunResponse). Specifying the name of a property of type Amazon.DeviceFarm.Model.ScheduleRunResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Test_Filter <String>
The test's filter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Test_Parameter <Hashtable>
The test's parameters, such as test framework parameters and fixture settings. Parameters are represented by name-value pairs of strings.For all tests:
  • app_performance_monitoring: Performance monitoring is enabled by default. Set this parameter to false to disable it.
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.6.5 (and later), latest, and default.
    • latest runs the latest Appium version supported by Device Farm (1.9.1).
    • For default, Device Farm selects a compatible version of Appium for the device. The current behavior is to run 1.7.2 on Android devices and iOS 9 and earlier and 1.7.2 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 user name to use if the Explorer encounters a login form. If not supplied, no user name is inserted.
  • password: A password to use if the Explorer encounters a login form. If not supplied, no password is 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?True (ByPropertyName)
AliasesTest_Parameters
-Test_TestPackageArn <String>
The ARN of the uploaded test to be run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Test_TestSpecArn <String>
The ARN of the YAML-formatted test specification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Test_Type <TestType>
The test's type.Must be one of the following values:
  • BUILTIN_FUZZ
  • BUILTIN_EXPLORER. 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
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)

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?True (ByPropertyName)
AliasesAK
-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?True (ByValue, ByPropertyName)
-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?True (ByPropertyName)
-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?True (ByValue, ByPropertyName)
-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.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?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-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?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-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?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.DeviceFarm.Model.Run or Amazon.DeviceFarm.Model.ScheduleRunResponse
This cmdlet returns an Amazon.DeviceFarm.Model.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.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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