amazonaws.com – devicefarm

OpenAPI apis-guru cloud

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 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 .

Homepage: https://api.apis.guru/v2/specs/amazonaws.com:devicefarm/2015-06-23.json
Provider: amazonaws.com:devicefarm / devicefarm
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/amazonaws.com/devicefarm/2015-06-23/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/amazonaws.com/devicefarm/2015-06-23/openapi.yaml

Tools (79)

Extracted live via the executor SDK.

xAmzTargetDeviceFarm20150623CreateDevicePool.createDevicePool

Creates a device pool.
xAmzTargetDeviceFarm20150623CreateInstanceProfile.createInstanceProfile

Creates a profile that can be applied to one or more private fleet device instances.
xAmzTargetDeviceFarm20150623CreateNetworkProfile.createNetworkProfile

Creates a network profile.
xAmzTargetDeviceFarm20150623CreateProject.createProject

Creates a project.
xAmzTargetDeviceFarm20150623CreateRemoteAccessSession.createRemoteAccessSession

Specifies and starts a remote access session.
xAmzTargetDeviceFarm20150623CreateTestGridProject.createTestGridProject

Creates a Selenium testing project. Projects are used to track TestGridSession [blocked] instances.
xAmzTargetDeviceFarm20150623CreateTestGridUrl.createTestGridUrl

Creates a signed, short-term URL that can be passed to a Selenium RemoteWebDriver constructor.
xAmzTargetDeviceFarm20150623CreateUpload.createUpload

Uploads an app or test scripts.
xAmzTargetDeviceFarm20150623CreateVpceConfiguration.createVpceConfiguration

Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.
xAmzTargetDeviceFarm20150623DeleteDevicePool.deleteDevicePool

Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.
xAmzTargetDeviceFarm20150623DeleteInstanceProfile.deleteInstanceProfile

Deletes a profile that can be applied to one or more private device instances.
xAmzTargetDeviceFarm20150623DeleteNetworkProfile.deleteNetworkProfile

Deletes a network profile.
xAmzTargetDeviceFarm20150623DeleteProject.deleteProject

Deletes an AWS Device Farm project, given the project ARN.

Deleting this resource does not stop an in-progress run.
xAmzTargetDeviceFarm20150623DeleteRemoteAccessSession.deleteRemoteAccessSession

Deletes a completed remote access session and its results.
xAmzTargetDeviceFarm20150623DeleteRun.deleteRun

Deletes the run, given the run ARN.

Deleting this resource does not stop an in-progress run.
xAmzTargetDeviceFarm20150623DeleteTestGridProject.deleteTestGridProject

Deletes a Selenium testing project and all content generated under it.

You cannot undo this operation.

You cannot delete a project if it has active sessions.
xAmzTargetDeviceFarm20150623DeleteUpload.deleteUpload

Deletes an upload given the upload ARN.
xAmzTargetDeviceFarm20150623DeleteVpceConfiguration.deleteVpceConfiguration

Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.
xAmzTargetDeviceFarm20150623GetAccountSettings.getAccountSettings

Returns the number of unmetered iOS or unmetered Android devices that have been purchased by the account.
xAmzTargetDeviceFarm20150623GetDevice.getDevice

Gets information about a unique device type.
xAmzTargetDeviceFarm20150623GetDeviceInstance.getDeviceInstance

Returns information about a device instance that belongs to a private device fleet.
xAmzTargetDeviceFarm20150623GetDevicePool.getDevicePool

Gets information about a device pool.
xAmzTargetDeviceFarm20150623GetDevicePoolCompatibility.getDevicePoolCompatibility

Gets information about compatibility with a device pool.
xAmzTargetDeviceFarm20150623GetInstanceProfile.getInstanceProfile

Returns information about the specified instance profile.
xAmzTargetDeviceFarm20150623GetJob.getJob

Gets information about a job.
xAmzTargetDeviceFarm20150623GetNetworkProfile.getNetworkProfile

Returns information about a network profile.
xAmzTargetDeviceFarm20150623GetOfferingStatus.getOfferingStatus

Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact .
xAmzTargetDeviceFarm20150623GetProject.getProject

Gets information about a project.
xAmzTargetDeviceFarm20150623GetRemoteAccessSession.getRemoteAccessSession

Returns a link to a currently running remote access session.
xAmzTargetDeviceFarm20150623GetRun.getRun

Gets information about a run.
xAmzTargetDeviceFarm20150623GetSuite.getSuite

Gets information about a suite.
xAmzTargetDeviceFarm20150623GetTest.getTest

Gets information about a test.
xAmzTargetDeviceFarm20150623GetTestGridProject.getTestGridProject

Retrieves information about a Selenium testing project.
xAmzTargetDeviceFarm20150623GetTestGridSession.getTestGridSession
A session is an instance of a browser created through a RemoteWebDriver with the URL from CreateTestGridUrlResult$url [blocked]. You can use the following to look up sessions:
- The session ARN (GetTestGridSessionRequest$sessionArn [blocked]).
- The project ARN and a session ID (GetTestGridSessionRequest$projectArn [blocked] and GetTestGridSessionRequest$sessionId [blocked]).
xAmzTargetDeviceFarm20150623GetUpload.getUpload

Gets information about an upload.
xAmzTargetDeviceFarm20150623GetVpceConfiguration.getVpceConfiguration

Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.
xAmzTargetDeviceFarm20150623InstallToRemoteAccessSession.installToRemoteAccessSession

Installs 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 must be in .ipa format.
xAmzTargetDeviceFarm20150623ListArtifacts.listArtifacts

Gets information about artifacts.
xAmzTargetDeviceFarm20150623ListDeviceInstances.listDeviceInstances

Returns information about the private device instances associated with one or more AWS accounts.
xAmzTargetDeviceFarm20150623ListDevicePools.listDevicePools

Gets information about device pools.
xAmzTargetDeviceFarm20150623ListDevices.listDevices

Gets information about unique device types.
xAmzTargetDeviceFarm20150623ListInstanceProfiles.listInstanceProfiles

Returns information about all the instance profiles in an AWS account.
xAmzTargetDeviceFarm20150623ListJobs.listJobs

Gets information about jobs for a given test run.
xAmzTargetDeviceFarm20150623ListNetworkProfiles.listNetworkProfiles

Returns the list of available network profiles.
xAmzTargetDeviceFarm20150623ListOfferingPromotions.listOfferingPromotions

Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a NotEligible error if the caller is not permitted to invoke the operation. Contact if you must be able to invoke this operation.
xAmzTargetDeviceFarm20150623ListOfferings.listOfferings

Returns 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 frequency for that offering. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact .
xAmzTargetDeviceFarm20150623ListOfferingTransactions.listOfferingTransactions

Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact .
xAmzTargetDeviceFarm20150623ListProjects.listProjects

Gets information about projects.
xAmzTargetDeviceFarm20150623ListRemoteAccessSessions.listRemoteAccessSessions

Returns a list of all currently running remote access sessions.
xAmzTargetDeviceFarm20150623ListRuns.listRuns

Gets information about runs, given an AWS Device Farm project ARN.
xAmzTargetDeviceFarm20150623ListSamples.listSamples

Gets information about samples, given an AWS Device Farm job ARN.
xAmzTargetDeviceFarm20150623ListSuites.listSuites

Gets information about test suites for a given job.
xAmzTargetDeviceFarm20150623ListTagsForResource.listTagsForResource

List the tags for an AWS Device Farm resource.
xAmzTargetDeviceFarm20150623ListTestGridProjects.listTestGridProjects

Gets a list of all Selenium testing projects in your account.
xAmzTargetDeviceFarm20150623ListTestGridSessionActions.listTestGridSessionActions

Returns a list of the actions taken in a TestGridSession [blocked].
xAmzTargetDeviceFarm20150623ListTestGridSessionArtifacts.listTestGridSessionArtifacts

Retrieves a list of artifacts created during the session.
xAmzTargetDeviceFarm20150623ListTestGridSessions.listTestGridSessions

Retrieves a list of sessions for a TestGridProject [blocked].
xAmzTargetDeviceFarm20150623ListTests.listTests

Gets information about tests in a given test suite.
xAmzTargetDeviceFarm20150623ListUniqueProblems.listUniqueProblems

Gets 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 suite. For example, if a call in your application consistently raises an exception (OutOfBoundsException in MyActivity.java:386), ListUniqueProblems returns a single entry instead of many individual entries for that exception.
xAmzTargetDeviceFarm20150623ListUploads.listUploads

Gets information about uploads, given an AWS Device Farm project ARN.
xAmzTargetDeviceFarm20150623ListVpceConfigurations.listVpceConfigurations

Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.
xAmzTargetDeviceFarm20150623PurchaseOffering.purchaseOffering

Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact .
xAmzTargetDeviceFarm20150623RenewOffering.renewOffering

Explicitly 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 the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact .
xAmzTargetDeviceFarm20150623ScheduleRun.scheduleRun

Schedules a run.
xAmzTargetDeviceFarm20150623StopJob.stopJob

Initiates 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 this device. On the device where tests have started, setup suite and teardown suite tests run to completion on the device. You are billed for setup, teardown, and any tests that were in progress or already completed.
xAmzTargetDeviceFarm20150623StopRemoteAccessSession.stopRemoteAccessSession

Ends a specified remote access session.
xAmzTargetDeviceFarm20150623StopRun.stopRun

Initiates 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 these devices. On devices where tests have started executing, setup suite and teardown suite tests run to completion on those devices. You are billed for setup, teardown, and any tests that were in progress or already completed.
xAmzTargetDeviceFarm20150623TagResource.tagResource

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.
xAmzTargetDeviceFarm20150623UntagResource.untagResource

Deletes the specified tags from a resource.
xAmzTargetDeviceFarm20150623UpdateDeviceInstance.updateDeviceInstance

Updates information about a private device instance.
xAmzTargetDeviceFarm20150623UpdateDevicePool.updateDevicePool

Modifies 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 updated as a whole (or not at all).
xAmzTargetDeviceFarm20150623UpdateInstanceProfile.updateInstanceProfile

Updates information about an existing private device instance profile.
xAmzTargetDeviceFarm20150623UpdateNetworkProfile.updateNetworkProfile

Updates the network profile.
xAmzTargetDeviceFarm20150623UpdateProject.updateProject

Modifies the specified project name, given the project ARN and a new name.
xAmzTargetDeviceFarm20150623UpdateTestGridProject.updateTestGridProject

Change details of a project.
xAmzTargetDeviceFarm20150623UpdateUpload.updateUpload

Updates an uploaded test spec.
xAmzTargetDeviceFarm20150623UpdateVpceConfiguration.updateVpceConfiguration

Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools