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.


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

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

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. You do not need an instance profiles 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. Enter a name for your instance profile.

  6. (Optional) Enter a description for the profile.

                      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 cleared. The default value is false, meaning the app packages installed on the private device remains on the device after your session has ended.

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

    You can also choose to keep app packages on the private device after 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 is followed only when you set Package Cleanup to true.

Managing a Private Device Instance

You can request a new private device instance.

  1. Sign in to the Device Farm console.

  2. Choose Device Farm settings.

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

  3. (Optional) To request a new device instance, contact us.

    Private devices require additional setup with help from the Device Farm team.

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

                      Edit device instance
  5. (Optional) Choose an instance profile to attach it to the device instance.This can be helpful if you always want to exclude a package from cleanup, for example.

  6. (Optional) Choose Add new to add labels to the device instance so that you can categorize your device and find it more easily.

  7. Choose Save device instance.

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 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, in the Select devices step, choose Edit device pool or Create a new device pool.

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

  6. Choose the device, and then choose Confirm and start session.

                        Use private instances in a remote access session

Create a Device Pool and Add Rules

When you create a test run, you can create a device pool and select private devices during Select devices step.

  1. Sign in to the Device Farm console.

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

  3. On Select devices, 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 device pool
  6. Select the devices you want to include, and then choose Save device pool.

  7. (Optional) Choose Add rule, and then set values for Field, Operator, and Operand.

                      Add rules to choose private device instances

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

Next Steps

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


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