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
TestGridin 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.
A container for account-level settings in AWS Device Farm.
Represents the output of a test. Examples of artifacts include logs and screenshots.
Represents the amount of CPU that an app is using on a physical device. Does not represent system-wide CPU usage.
Represents entity counters.
Represents a request to the create device pool operation.
Represents the result of a create device pool request.
Represents a request to the create project operation.
Represents the result of a create project request.
Configuration settings for a remote access session, including billing method.
Creates and submits a request to start a remote access session.
Represents the server response from a request to create a remote access session.
Represents a request to the create upload operation.
Represents the result of a create upload request.
A JSON object that specifies the paths where the artifacts generated by the customer's tests, on the device or in the test environment, are pulled from.
For web app tests, you can specify both
Represents a request to the delete device pool operation.
Represents the result of a delete device pool request.
Represents a request to the delete project operation.
Represents the result of a delete project request.
Represents the request to delete the specified remote access session.
The response from the server when a request is made to delete the remote access session.
Represents a request to the delete run operation.
Represents the result of a delete run request.
Represents a request to the delete upload operation.
Represents the result of a delete upload request.
Represents a device type that an app is tested against.
A client for the AWS Device Farm API.
Represents a device filter used to select a set of devices to be included in a test run. This data structure is passed in as the
It is also passed in as the
Represents the device instance.
Represents the total (metered or unmetered) minutes used by the resource to run tests. Contains the sum of minutes consumed by all children.
Represents a collection of device types.
Represents a device pool compatibility result.
Represents the device filters used in a test run and the maximum number of devices to be included in the run. It is passed in as the
Contains the run results requested by the device selection configuration and how many devices were returned. For an example of the JSON response syntax, see ScheduleRun.
Represents configuration information about a test run, such as the execution timeout (in minutes).
Represents the request sent to retrieve the account settings.
Represents the account settings return values from the
Represents a request to the get device pool compatibility operation.
Represents the result of describe device pool compatibility request.
Represents a request to the get device pool operation.
Represents the result of a get device pool request.
Represents a request to the get device request.
Represents the result of a get device request.
Represents a request to the get job operation.
Represents the result of a get job request.
Represents the request to retrieve the offering status for the specified customer or account.
Returns the status result for a device offering.
Represents a request to the get project operation.
Represents the result of a get project request.
Represents the request to get information about the specified remote access session.
Represents the response from the server that lists detailed information about the remote access session.
Represents a request to the get run operation.
Represents the result of a get run request.
Represents a request to the get suite operation.
Represents the result of a get suite request.
Represents a request to the get test operation.
Represents the result of a get test request.
Represents a request to the get upload operation.
Represents the result of a get upload request.
Represents information about incompatibility.
Represents the request to install an Android application (in .apk format) or an iOS application (in .ipa format) as part of a remote access session.
Represents the response from the server after AWS Device Farm makes a request to install to a remote access session.
Represents the instance profile.
Represents a device.
Represents a request to the list artifacts operation.
Represents the result of a list artifacts operation.
Represents the result of a list device pools request.
Represents the result of a list device pools request.
Represents the result of a list devices request.
Represents the result of a list devices operation.
Represents a request to the list jobs operation.
Represents the result of a list jobs request.
Represents the request to list the offering transaction history.
Returns the transaction log of the specified offerings.
Represents the request to list all offerings.
Represents the return values of the list of offerings.
Represents a request to the list projects operation.
Represents the result of a list projects request.
Represents the request to return information about the remote access session.
Represents the response from the server after AWS Device Farm makes a request to return information about the remote access session.
Represents a request to the list runs operation.
Represents the result of a list runs request.
Represents a request to the list samples operation.
Represents the result of a list samples request.
Represents a request to the list suites operation.
Represents the result of a list suites request.
Represents a request to the list tests operation.
Represents the result of a list tests request.
Represents a request to the list unique problems operation.
Represents the result of a list unique problems request.
Represents a request to the list uploads operation.
Represents the result of a list uploads request.
Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example, 47.6204, -122.3491).
Elevation is currently not supported.
A number that represents the monetary amount for an offering or transaction.
An array of settings that describes characteristics of a network profile.
Represents the metadata of a device offering.
Represents information about an offering promotion.
The status of the offering.
Represents the metadata of an offering transaction.
Represents a specific warning or failure.
Information about a problem detail.
Represents an operating-system neutral workspace for running and managing tests.
Represents a request for a purchase offering.
The result of the purchase offering (for example, success or failure).
Represents the set of radios and their states on a device. Examples of radios include Wi-Fi, GPS, Bluetooth, and NFC.
Specifies whether charges for devices are recurring.
Represents information about the remote access session.
A request that represents an offering renewal.
The result of a renewal offering.
Represents the screen resolution of a device in height and width, expressed in pixels.
Represents a condition for a device pool.
Represents a test run on a set of devices with a given app package, test parameters, and so on.
Represents a sample of performance data.
Represents the settings for a run. Includes things like location, radio states, auxiliary apps, and network profiles.
Represents a request to the schedule run operation.
Represents the result of a schedule run request.
Represents test settings. This data structure is passed in as the test parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.
Represents the request to stop the remote access session.
Represents the response from the server that describes the remote access session when AWS Device Farm stops the session.
Represents the request to stop a specific run.
Represents the results of your stop run attempt.
Represents a collection of one or more tests.
The metadata that you apply to a resource to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters. Tag values can have a maximum length of 256 characters.
Represents a condition that is evaluated.
A Selenium testing project. Projects are used to collect and collate sessions.
An action taken by a TestGridSession browser instance.
Artifacts are video and other files that are produced in the process of running a browser in an automated context.
Video elements might be broken up into multiple artifacts as they grow in size during creation.
Represents information about free trial device minutes for an AWS account.
A collection of one or more problems, grouped by their result.
Represents a request to the update device pool operation.
Represents the result of an update device pool request.
Represents a request to the update project operation.
Represents the result of an update project request.
An app or a set of one or more tests to upload or that have been uploaded.
Represents an Amazon Virtual Private Cloud (VPC) endpoint configuration.
Errors returned by CreateDevicePool
Errors returned by CreateInstanceProfile
Errors returned by CreateNetworkProfile
Errors returned by CreateProject
Errors returned by CreateRemoteAccessSession
Errors returned by CreateTestGridProject
Errors returned by CreateTestGridUrl
Errors returned by CreateUpload
Errors returned by CreateVPCEConfiguration
Errors returned by DeleteDevicePool
Errors returned by DeleteInstanceProfile
Errors returned by DeleteNetworkProfile
Errors returned by DeleteProject
Errors returned by DeleteRemoteAccessSession
Errors returned by DeleteRun
Errors returned by DeleteTestGridProject
Errors returned by DeleteUpload
Errors returned by DeleteVPCEConfiguration
Errors returned by GetAccountSettings
Errors returned by GetDevice
Errors returned by GetDeviceInstance
Errors returned by GetDevicePoolCompatibility
Errors returned by GetDevicePool
Errors returned by GetInstanceProfile
Errors returned by GetJob
Errors returned by GetNetworkProfile
Errors returned by GetOfferingStatus
Errors returned by GetProject
Errors returned by GetRemoteAccessSession
Errors returned by GetRun
Errors returned by GetSuite
Errors returned by GetTest
Errors returned by GetTestGridProject
Errors returned by GetTestGridSession
Errors returned by GetUpload
Errors returned by GetVPCEConfiguration
Errors returned by InstallToRemoteAccessSession
Errors returned by ListArtifacts
Errors returned by ListDeviceInstances
Errors returned by ListDevicePools
Errors returned by ListDevices
Errors returned by ListInstanceProfiles
Errors returned by ListJobs
Errors returned by ListNetworkProfiles
Errors returned by ListOfferingPromotions
Errors returned by ListOfferingTransactions
Errors returned by ListOfferings
Errors returned by ListProjects
Errors returned by ListRemoteAccessSessions
Errors returned by ListRuns
Errors returned by ListSamples
Errors returned by ListSuites
Errors returned by ListTagsForResource
Errors returned by ListTestGridProjects
Errors returned by ListTestGridSessionActions
Errors returned by ListTestGridSessionArtifacts
Errors returned by ListTestGridSessions
Errors returned by ListTests
Errors returned by ListUniqueProblems
Errors returned by ListUploads
Errors returned by ListVPCEConfigurations
Errors returned by PurchaseOffering
Errors returned by RenewOffering
Errors returned by ScheduleRun
Errors returned by StopJob
Errors returned by StopRemoteAccessSession
Errors returned by StopRun
Errors returned by TagResource
Errors returned by UntagResource
Errors returned by UpdateDeviceInstance
Errors returned by UpdateDevicePool
Errors returned by UpdateInstanceProfile
Errors returned by UpdateNetworkProfile
Errors returned by UpdateProject
Errors returned by UpdateTestGridProject
Errors returned by UpdateUpload
Errors returned by UpdateVPCEConfiguration
Trait representing the capabilities of the AWS Device Farm API. AWS Device Farm clients implement this trait.