View Source aws_device_farm (aws v1.0.4)
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: https://docs.aws.amazon.com/devicefarm/latest/testgrid/.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: https://docs.aws.amazon.com/devicefarm/latest/developerguide/.
Summary
Functions
Creates a Selenium testing project.
RemoteWebDriver
constructor.Deletes a device pool given the pool ARN.
Deletes an AWS Device Farm project, given the project ARN.
Deletes the run, given the run ARN.
Deletes a Selenium testing project and all content generated under it.
Gets the current status and future status of all offerings purchased by an AWS account.
A session is an instance of a browser created through a RemoteWebDriver
with the URL from CreateTestGridUrlResult$url
.
Installs an application to the device in a remote access session.
Returns a list of offering promotions.
Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account.
Returns a list of products or offerings that the user can manage through the API.
TestGridSession
.TestGridProject
.Gets information about unique problems, such as exceptions or crashes.
Immediately purchases offerings for an AWS account.
Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate
of the next period.
Initiates a stop request for the current job.
Initiates a stop request for the current test run.
Associates the specified tags to a resource with the specified resourceArn
.
Modifies the name, description, and rules in a device pool given the attributes and the pool ARN.
Functions
Creates a Selenium testing project.
Projects are used to trackTestGridSession
instances.
RemoteWebDriver
constructor.
Deletes a device pool given the pool ARN.
Does not allow deletion of curated pools owned by the system.Deletes an AWS Device Farm project, given the project ARN.
Deleting this resource does not stop an in-progress run.Deletes the run, given the run ARN.
Deleting this resource does not stop an in-progress run.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.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 aNotEligible
error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com: mailto:aws-devicefarm-support@amazon.com.
A session is an instance of a browser created through a RemoteWebDriver
with the URL from CreateTestGridUrlResult$url
.
You can use the following to look up sessions:
The session ARN (
GetTestGridSessionRequest$sessionArn
).The project ARN and a session ID (
GetTestGridSessionRequest$projectArn
andGetTestGridSessionRequest$sessionId
).
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.Returns a list of offering promotions.
Each offering promotion record contains the ID and description of the promotion. The API returns aNotEligible
error if the caller is not permitted to invoke the operation. Contact aws-devicefarm-support@amazon.com: mailto:aws-devicefarm-support@amazon.com if you must be able to invoke this operation.
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 aNotEligible
error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com: mailto:aws-devicefarm-support@amazon.com.
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 aNotEligible
error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com: mailto:aws-devicefarm-support@amazon.com.
TestGridSession
.
TestGridProject
.
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.
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 aNotEligible
error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com: mailto:aws-devicefarm-support@amazon.com.
Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate
of the next period.
NotEligible
error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com: mailto:aws-devicefarm-support@amazon.com.
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.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.Associates the specified tags to a resource with the specified resourceArn
.
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).