Amazon Web Services, Inc.

AWS Device Farm

Welcome to the AWS Device Farm API documentation, which contains APIs for: Testing on desktop browsers Device Farm makes it possible for you to test your web…

IoT & devices#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Welcome to the AWS Device Farm API documentation, which contains APIs for:

Testing on desktop browsers
Device Farm makes it possible for you to test your web applications on desktop browsers using
Selenium. The APIs for desktop browser testing contain TestGrid in their names. For
more information, see Testing Web
Applications on Selenium with Device Farm .

Testing on real mobile devices
Device Farm makes it possible for you to test apps on physical phones, tablets, and other
devices in the cloud. For more information, see the Device Farm Developer Guide .

Endpoints 77

  • POSTCreate device pool/#X-Amz-Target=DeviceFarm_20150623.CreateDevicePoolCreates a device pool.
  • POSTCreate instance profile/#X-Amz-Target=DeviceFarm_20150623.CreateInstanceProfileCreates a profile that can be applied to one or more private fleet device instances.
  • POSTCreate network profile/#X-Amz-Target=DeviceFarm_20150623.CreateNetworkProfileCreates a network profile.
  • POSTCreate project/#X-Amz-Target=DeviceFarm_20150623.CreateProjectCreates a project.
  • POSTCreate remote access session/#X-Amz-Target=DeviceFarm_20150623.CreateRemoteAccessSessionSpecifies and starts a remote access session.
  • POSTCreate test grid project/#X-Amz-Target=DeviceFarm_20150623.CreateTestGridProjectCreates a Selenium testing project. Projects are used to track TestGridSession instances.
  • POSTCreate test grid url/#X-Amz-Target=DeviceFarm_20150623.CreateTestGridUrlCreates a signed, short-term URL that can be passed to a Selenium RemoteWebDriver constructor.
  • POSTCreate upload/#X-Amz-Target=DeviceFarm_20150623.CreateUploadUploads an app or test scripts.
  • POSTCreate vPCE configuration/#X-Amz-Target=DeviceFarm_20150623.CreateVPCEConfigurationCreates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.
  • POSTDelete device pool/#X-Amz-Target=DeviceFarm_20150623.DeleteDevicePoolDeletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.
  • POSTDelete instance profile/#X-Amz-Target=DeviceFarm_20150623.DeleteInstanceProfileDeletes a profile that can be applied to one or more private device instances.
  • POSTDelete network profile/#X-Amz-Target=DeviceFarm_20150623.DeleteNetworkProfileDeletes a network profile.
  • POSTDelete project/#X-Amz-Target=DeviceFarm_20150623.DeleteProjectDeletes an AWS Device Farm project, given the project ARN. You cannot delete a project if it has an active run or session. You cannot undo this operation.
  • POSTDelete remote access session/#X-Amz-Target=DeviceFarm_20150623.DeleteRemoteAccessSessionDeletes a completed remote access session and its results. You cannot delete a remote access session if it is still active. You cannot undo this operation.
  • POSTDelete run/#X-Amz-Target=DeviceFarm_20150623.DeleteRunDeletes the run, given the run ARN. You cannot delete a run if it is still active. You cannot undo this operation.
  • POSTDelete test grid project/#X-Amz-Target=DeviceFarm_20150623.DeleteTestGridProjectDeletes a Selenium testing project and all content generated under it. You cannot delete a project if it has active sessions. You cannot undo this operation.
  • POSTDelete upload/#X-Amz-Target=DeviceFarm_20150623.DeleteUploadDeletes an upload given the upload ARN.
  • POSTDelete vPCE configuration/#X-Amz-Target=DeviceFarm_20150623.DeleteVPCEConfigurationDeletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.
  • POSTGet account settings/#X-Amz-Target=DeviceFarm_20150623.GetAccountSettingsReturns the number of unmetered iOS or unmetered Android devices that have been purchased by the account.
  • POSTGet device/#X-Amz-Target=DeviceFarm_20150623.GetDeviceGets information about a unique device type.
  • POSTGet device instance/#X-Amz-Target=DeviceFarm_20150623.GetDeviceInstanceReturns information about a device instance that belongs to a private device fleet.
  • POSTGet device pool/#X-Amz-Target=DeviceFarm_20150623.GetDevicePoolGets information about a device pool.
  • POSTGet device pool compatibility/#X-Amz-Target=DeviceFarm_20150623.GetDevicePoolCompatibilityGets information about compatibility with a device pool.
  • POSTGet instance profile/#X-Amz-Target=DeviceFarm_20150623.GetInstanceProfileReturns information about the specified instance profile.
  • POSTGet job/#X-Amz-Target=DeviceFarm_20150623.GetJobGets information about a job.
  • POSTGet network profile/#X-Amz-Target=DeviceFarm_20150623.GetNetworkProfileReturns information about a network profile.
  • POSTGet offering status/#X-Amz-Target=DeviceFarm_20150623.GetOfferingStatusGets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and…
  • POSTGet project/#X-Amz-Target=DeviceFarm_20150623.GetProjectGets information about a project.
  • POSTGet remote access session/#X-Amz-Target=DeviceFarm_20150623.GetRemoteAccessSessionReturns a link to a currently running remote access session.
  • POSTGet run/#X-Amz-Target=DeviceFarm_20150623.GetRunGets information about a run.
  • POSTGet suite/#X-Amz-Target=DeviceFarm_20150623.GetSuiteGets information about a suite.
  • POSTGet test/#X-Amz-Target=DeviceFarm_20150623.GetTestGets information about a test.
  • POSTGet test grid project/#X-Amz-Target=DeviceFarm_20150623.GetTestGridProjectRetrieves information about a Selenium testing project.
  • POSTGet test grid session/#X-Amz-Target=DeviceFarm_20150623.GetTestGridSessionA session is an instance of a browser created through a RemoteWebDriver with the URL from CreateTestGridUrlResult . You can use the following to look up…
  • POSTGet upload/#X-Amz-Target=DeviceFarm_20150623.GetUploadGets information about an upload.
  • POSTGet vPCE configuration/#X-Amz-Target=DeviceFarm_20150623.GetVPCEConfigurationReturns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.
  • POSTInstall to remote access session/#X-Amz-Target=DeviceFarm_20150623.InstallToRemoteAccessSessionInstalls an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file…
  • POSTList artifacts/#X-Amz-Target=DeviceFarm_20150623.ListArtifactsGets information about artifacts.
  • POSTList device instances/#X-Amz-Target=DeviceFarm_20150623.ListDeviceInstancesReturns information about the private device instances associated with one or more AWS accounts.
  • POSTList device pools/#X-Amz-Target=DeviceFarm_20150623.ListDevicePoolsGets information about device pools.
  • POSTList devices/#X-Amz-Target=DeviceFarm_20150623.ListDevicesGets information about unique device types.
  • POSTList instance profiles/#X-Amz-Target=DeviceFarm_20150623.ListInstanceProfilesReturns information about all the instance profiles in an AWS account.
  • POSTList jobs/#X-Amz-Target=DeviceFarm_20150623.ListJobsGets information about jobs for a given test run.
  • POSTList network profiles/#X-Amz-Target=DeviceFarm_20150623.ListNetworkProfilesReturns the list of available network profiles.
  • POSTList offering promotions/#X-Amz-Target=DeviceFarm_20150623.ListOfferingPromotionsReturns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a NotEligible error if…
  • POSTList offering transactions/#X-Amz-Target=DeviceFarm_20150623.ListOfferingTransactionsReturns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending…
  • POSTList offerings/#X-Amz-Target=DeviceFarm_20150623.ListOfferingsReturns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the…
  • POSTList projects/#X-Amz-Target=DeviceFarm_20150623.ListProjectsGets information about projects.
  • POSTList remote access sessions/#X-Amz-Target=DeviceFarm_20150623.ListRemoteAccessSessionsReturns a list of all currently running remote access sessions.
  • POSTList runs/#X-Amz-Target=DeviceFarm_20150623.ListRunsGets information about runs, given an AWS Device Farm project ARN.
  • POSTList samples/#X-Amz-Target=DeviceFarm_20150623.ListSamplesGets information about samples, given an AWS Device Farm job ARN. Device Farm does not support performance data samples during test executions.
  • POSTList suites/#X-Amz-Target=DeviceFarm_20150623.ListSuitesGets information about test suites for a given job.
  • POSTList tags for resource/#X-Amz-Target=DeviceFarm_20150623.ListTagsForResourceList the tags for an AWS Device Farm resource.
  • POSTList test grid projects/#X-Amz-Target=DeviceFarm_20150623.ListTestGridProjectsGets a list of all Selenium testing projects in your account.
  • POSTList test grid session actions/#X-Amz-Target=DeviceFarm_20150623.ListTestGridSessionActionsReturns a list of the actions taken in a TestGridSession .
  • POSTList test grid session artifacts/#X-Amz-Target=DeviceFarm_20150623.ListTestGridSessionArtifactsRetrieves a list of artifacts created during the session.
  • POSTList test grid sessions/#X-Amz-Target=DeviceFarm_20150623.ListTestGridSessionsRetrieves a list of sessions for a TestGridProject .
  • POSTList tests/#X-Amz-Target=DeviceFarm_20150623.ListTestsGets information about tests in a given test suite.
  • POSTList unique problems/#X-Amz-Target=DeviceFarm_20150623.ListUniqueProblemsGets information about unique problems, such as exceptions or crashes. Unique problems are defined as a single instance of an error across a run, job, or…
  • POSTList uploads/#X-Amz-Target=DeviceFarm_20150623.ListUploadsGets information about uploads, given an AWS Device Farm project ARN.
  • POSTList vPCE configurations/#X-Amz-Target=DeviceFarm_20150623.ListVPCEConfigurationsReturns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.
  • POSTPurchase offering/#X-Amz-Target=DeviceFarm_20150623.PurchaseOfferingImmediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was…
  • POSTRenew offering/#X-Amz-Target=DeviceFarm_20150623.RenewOfferingExplicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period. The API returns a NotEligible error if…
  • POSTSchedule run/#X-Amz-Target=DeviceFarm_20150623.ScheduleRunSchedules a run.
  • POSTStop job/#X-Amz-Target=DeviceFarm_20150623.StopJobInitiates a stop request for the current job. AWS Device Farm immediately stops the job on the device where tests have not started. You are not billed for…
  • POSTStop remote access session/#X-Amz-Target=DeviceFarm_20150623.StopRemoteAccessSessionEnds a specified remote access session.
  • POSTStop run/#X-Amz-Target=DeviceFarm_20150623.StopRunInitiates a stop request for the current test run. AWS Device Farm immediately stops the run on devices where tests have not started. You are not billed for…
  • POSTTag resource/#X-Amz-Target=DeviceFarm_20150623.TagResourceAssociates the specified tags to a resource with the specified resourceArn . If existing tags on a resource are not specified in the request parameters, they…
  • POSTUntag resource/#X-Amz-Target=DeviceFarm_20150623.UntagResourceDeletes the specified tags from a resource.
  • POSTUpdate device instance/#X-Amz-Target=DeviceFarm_20150623.UpdateDeviceInstanceUpdates information about a private device instance.
  • POSTUpdate device pool/#X-Amz-Target=DeviceFarm_20150623.UpdateDevicePoolModifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be…
  • POSTUpdate instance profile/#X-Amz-Target=DeviceFarm_20150623.UpdateInstanceProfileUpdates information about an existing private device instance profile.
  • POSTUpdate network profile/#X-Amz-Target=DeviceFarm_20150623.UpdateNetworkProfileUpdates the network profile.
  • POSTUpdate project/#X-Amz-Target=DeviceFarm_20150623.UpdateProjectModifies the specified project name, given the project ARN and a new name.
  • POSTUpdate test grid project/#X-Amz-Target=DeviceFarm_20150623.UpdateTestGridProjectChange details of a project.
  • POSTUpdate upload/#X-Amz-Target=DeviceFarm_20150623.UpdateUploadUpdates an uploaded test spec.
  • POSTUpdate vPCE configuration/#X-Amz-Target=DeviceFarm_20150623.UpdateVPCEConfigurationUpdates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.

API details

Base URL
https://devicefarm.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
77 operations on 77 pathsPOST 77
Description format
AWS Smithy model, API version 2015-06-23

How to test the AWS Device Farm in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Device Farm collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create device pool” (POST /#X-Amz-Target=DeviceFarm_20150623.CreateDevicePool), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Device Farm?

Welcome to the AWS Device Farm API documentation, which contains APIs for: Testing on desktop browsers Device Farm makes it possible for you to test your web… It is listed under IoT & devices and has 77 endpoints.

Who publishes the AWS Device Farm?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Device Farm?

Requests go to https://devicefarm.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Device Farm?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Device Farm have?

77 operations on 77 paths (77 POST).

Is forking the AWS Device Farm free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.