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 GetDevicePoolCompatibility API operation.

Syntax

Get-DFDevicePoolCompatibility
-CustomerArtifactPaths_AndroidPath <String[]>
-AppArn <String>
-Configuration_AuxiliaryApp <String[]>
-Configuration_BillingMethod <BillingMethod>
-Radios_Bluetooth <Boolean>
-CustomerArtifactPaths_DeviceHostPath <String[]>
-DevicePoolArn <String>
-Configuration_ExtraDataPackageArn <String>
-Test_Filter <String>
-Radios_Gp <Boolean>
-CustomerArtifactPaths_IosPath <String[]>
-Location_Latitude <Double>
-Configuration_Locale <String>
-Location_Longitude <Double>
-Configuration_NetworkProfileArn <String>
-Radios_Nfc <Boolean>
-Test_Parameter <Hashtable>
-Test_TestPackageArn <String>
-Test_TestSpecArn <String>
-TestType <TestType>
-Test_Type <TestType>
-Configuration_VpceConfigurationArn <String[]>
-Radios_Wifi <Boolean>
-Select <String>

Description

Gets information about compatibility with a device pool.

Parameters

-AppArn <String>
The ARN of the app that is associated with the specified device pool.
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 device pool's ARN.
Required?True
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
-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 '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DeviceFarm.Model.GetDevicePoolCompatibilityResponse). Specifying the name of a property of type Amazon.DeviceFarm.Model.GetDevicePoolCompatibilityResponse 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?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TestType <TestType>
The test type for the specified device pool.Allowed values include the following:
  • 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?False
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

This cmdlet returns an Amazon.DeviceFarm.Model.GetDevicePoolCompatibilityResponse object containing multiple properties. The object 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