AWS Device Farm
Developer Guide (API Version 2015-06-23)

Managing Private Devices in AWS Device Farm

A private device is a physical mobile device that AWS Device Farm deploys on your behalf in an Amazon data center. This device is exclusive to your account.

Note

Private devices are currently only available in the US West (Oregon) (us-west-2) AWS Region.

You can set up a private device fleet with one or more private devices dedicated to your AWS account. Once set up, you can create one or more profiles for these devices so that you can automate your test runs and consistently apply the same settings when working with these devices.

Creating an Instance Profile to Set Up Private Devices

You can create or modify an instance profile in Device Farm to control the behavior of private devices during a test run or a remote access session. Instance profiles are not required to start using your private devices.

  1. Sign in to the Device Farm console.

  2. Choose Device Farm settings.

  3. Choose Instance profiles.

  4. Choose Create a new instance profile.

  5. Type a name for your instance profile.

  6. Optionally, you can type a description for the profile to help manage it better.

    
                      Optional settings for instance profiles
  7. If you want to reboot the private device after use, choose Reboot After Use.

    The default value is true.

  8. If you want to keep all the app packages installed on the private device, leave Package Cleanup unchecked. The default value is false, meaning the app packages installed on the private device will remain on the device after your session has ended.

    If you want to remove all the app packages you installed after you complete your session, choose Package Cleanup.

    You can also choose to keep specific app packages on the private device after you complete each session. Choose Add new to specify a fully-qualified name of an app package that you want to leave on the device. For example, com.test.example. The exclusion list given here will be followed only when you set Package Cleanup to true.

Managing a Private Device Instance

You can request a new private device instance by going into Device Farm settings.

  1. Sign in to the Device Farm console.

  2. Choose Device Farm settings.

    Once you have a private device fleet, you will see the devices in your fleet listed here. You can quickly search or filter the list by typing search terms in the different columns.

  3. Optionally, you can choose to Request a new device instance by contacting us.

    Private devices require additional setup directly with the Device Farm team.

  4. After you request a new device instance, choose a device in the table to manage it.

    
                      Edit device instance dialog
  5. You can optionally attach any instance profile that you have created. This can be helpful if you always want to exclude a package from cleanup, for example.

    Choose an instance profile from the dropdown to attach it to the device instance.

  6. You can optionally add labels to the device instance so that you can categorize your device and find it more easily.

    Choose Add new to add a new label.

  7. Choose Save device instance when you're done.

Creating a Test Run or Starting a Remote Access Session Using a Private Device Instance

After you create a private device fleet, you can create a new test run or start a remote access session using one or more private devices.

  1. Sign in to the Device Farm console.

  2. Choose Create a new project, or open an existing project.

  3. Choose Create a new run or choose the Remote access tab.

  4. If you're creating a test run, choose Edit device pool or Create a new device pool in the Select devices step.

  5. Choose Private device instances only on the Select devices step.

  6. If you're starting a new remote access session, choose Private device instances only.

    
                      Use private instances in a remote access session

    Choose the device you want, and then choose Confirm and start session.

Create a New Device Pool and Add Rules

When you create a new test run, you can create a new device pool and select private devices during Step 3 (Select devices).

  1. Create a new test run by signing in to the Device Farm console.

  2. Choose your application and configure the test you want to run.

  3. On the Select devices step, choose Create a new device pool.

  4. Type a Name and an optional Description for your device pool.

  5. Choose Private Device Instances Only.

    
                      Create a new device pool
  6. Select the devices you want to include manually, and then choose Save device pool.

  7. Optionally, you can choose Add rule, and then specify a Field, Operator, and Operand.

    
                      Add rules to choose private device instances

    Device Farm selects all device instances where the rule is true, and then you can choose Save device pool.

Next Steps

After you set up private devices, you can do one of the following.

Note

You can delete an instance profile from either the Account settings or the Project settings pages in Device Farm.