Expand description
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.
If you’re using the service, you’re probably looking for DeviceFarmClient and DeviceFarm.
Structs§
- Account
Settings A container for account-level settings in AWS Device Farm.
- Artifact
Represents the output of a test. Examples of artifacts include logs and screenshots.
- CPU
Represents the amount of CPU that an app is using on a physical device. Does not represent system-wide CPU usage.
- Counters
Represents entity counters.
- Create
Device Pool Request Represents a request to the create device pool operation.
- Create
Device Pool Result Represents the result of a create device pool request.
- Create
Instance Profile Request - Create
Instance Profile Result - Create
Network Profile Request - Create
Network Profile Result - Create
Project Request Represents a request to the create project operation.
- Create
Project Result Represents the result of a create project request.
- Create
Remote Access Session Configuration Configuration settings for a remote access session, including billing method.
- Create
Remote Access Session Request Creates and submits a request to start a remote access session.
- Create
Remote Access Session Result Represents the server response from a request to create a remote access session.
- Create
Test Grid Project Request - Create
Test Grid Project Result - Create
Test Grid UrlRequest - Create
Test Grid UrlResult - Create
Upload Request Represents a request to the create upload operation.
- Create
Upload Result Represents the result of a create upload request.
- CreateVPCE
Configuration Request - CreateVPCE
Configuration Result - Customer
Artifact Paths 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.
Specify
deviceHostPathsand optionally specify eitheriosPathsorandroidPaths.For web app tests, you can specify both
iosPathsandandroidPaths.- Delete
Device Pool Request Represents a request to the delete device pool operation.
- Delete
Device Pool Result Represents the result of a delete device pool request.
- Delete
Instance Profile Request - Delete
Instance Profile Result - Delete
Network Profile Request - Delete
Network Profile Result - Delete
Project Request Represents a request to the delete project operation.
- Delete
Project Result Represents the result of a delete project request.
- Delete
Remote Access Session Request Represents the request to delete the specified remote access session.
- Delete
Remote Access Session Result The response from the server when a request is made to delete the remote access session.
- Delete
RunRequest Represents a request to the delete run operation.
- Delete
RunResult Represents the result of a delete run request.
- Delete
Test Grid Project Request - Delete
Test Grid Project Result - Delete
Upload Request Represents a request to the delete upload operation.
- Delete
Upload Result Represents the result of a delete upload request.
- DeleteVPCE
Configuration Request - DeleteVPCE
Configuration Result - Device
Represents a device type that an app is tested against.
- Device
Farm Client - A client for the AWS Device Farm API.
- Device
Filter 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
deviceSelectionConfigurationparameter toScheduleRun. For an example of the JSON request syntax, see ScheduleRun.It is also passed in as the
filtersparameter toListDevices. For an example of the JSON request syntax, see ListDevices.- Device
Instance Represents the device instance.
- Device
Minutes Represents the total (metered or unmetered) minutes used by the resource to run tests. Contains the sum of minutes consumed by all children.
- Device
Pool Represents a collection of device types.
- Device
Pool Compatibility Result Represents a device pool compatibility result.
- Device
Selection Configuration 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
deviceSelectionConfigurationrequest parameter in ScheduleRun.- Device
Selection Result 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.
- Execution
Configuration Represents configuration information about a test run, such as the execution timeout (in minutes).
- GetAccount
Settings Request Represents the request sent to retrieve the account settings.
- GetAccount
Settings Result Represents the account settings return values from the
GetAccountSettingsrequest.- GetDevice
Instance Request - GetDevice
Instance Result - GetDevice
Pool Compatibility Request Represents a request to the get device pool compatibility operation.
- GetDevice
Pool Compatibility Result Represents the result of describe device pool compatibility request.
- GetDevice
Pool Request Represents a request to the get device pool operation.
- GetDevice
Pool Result Represents the result of a get device pool request.
- GetDevice
Request Represents a request to the get device request.
- GetDevice
Result Represents the result of a get device request.
- GetInstance
Profile Request - GetInstance
Profile Result - GetJob
Request Represents a request to the get job operation.
- GetJob
Result Represents the result of a get job request.
- GetNetwork
Profile Request - GetNetwork
Profile Result - GetOffering
Status Request Represents the request to retrieve the offering status for the specified customer or account.
- GetOffering
Status Result Returns the status result for a device offering.
- GetProject
Request Represents a request to the get project operation.
- GetProject
Result Represents the result of a get project request.
- GetRemote
Access Session Request Represents the request to get information about the specified remote access session.
- GetRemote
Access Session Result Represents the response from the server that lists detailed information about the remote access session.
- GetRun
Request Represents a request to the get run operation.
- GetRun
Result Represents the result of a get run request.
- GetSuite
Request Represents a request to the get suite operation.
- GetSuite
Result Represents the result of a get suite request.
- GetTest
Grid Project Request - GetTest
Grid Project Result - GetTest
Grid Session Request - GetTest
Grid Session Result - GetTest
Request Represents a request to the get test operation.
- GetTest
Result Represents the result of a get test request.
- GetUpload
Request Represents a request to the get upload operation.
- GetUpload
Result Represents the result of a get upload request.
- GetVPCE
Configuration Request - GetVPCE
Configuration Result - Incompatibility
Message Represents information about incompatibility.
- Install
ToRemote Access Session Request 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.
- Install
ToRemote Access Session Result Represents the response from the server after AWS Device Farm makes a request to install to a remote access session.
- Instance
Profile Represents the instance profile.
- Job
Represents a device.
- List
Artifacts Request Represents a request to the list artifacts operation.
- List
Artifacts Result Represents the result of a list artifacts operation.
- List
Device Instances Request - List
Device Instances Result - List
Device Pools Request Represents the result of a list device pools request.
- List
Device Pools Result Represents the result of a list device pools request.
- List
Devices Request Represents the result of a list devices request.
- List
Devices Result Represents the result of a list devices operation.
- List
Instance Profiles Request - List
Instance Profiles Result - List
Jobs Request Represents a request to the list jobs operation.
- List
Jobs Result Represents the result of a list jobs request.
- List
Network Profiles Request - List
Network Profiles Result - List
Offering Promotions Request - List
Offering Promotions Result - List
Offering Transactions Request Represents the request to list the offering transaction history.
- List
Offering Transactions Result Returns the transaction log of the specified offerings.
- List
Offerings Request Represents the request to list all offerings.
- List
Offerings Result Represents the return values of the list of offerings.
- List
Projects Request Represents a request to the list projects operation.
- List
Projects Result Represents the result of a list projects request.
- List
Remote Access Sessions Request Represents the request to return information about the remote access session.
- List
Remote Access Sessions Result Represents the response from the server after AWS Device Farm makes a request to return information about the remote access session.
- List
Runs Request Represents a request to the list runs operation.
- List
Runs Result Represents the result of a list runs request.
- List
Samples Request Represents a request to the list samples operation.
- List
Samples Result Represents the result of a list samples request.
- List
Suites Request Represents a request to the list suites operation.
- List
Suites Result Represents the result of a list suites request.
- List
Tags ForResource Request - List
Tags ForResource Response - List
Test Grid Projects Request - List
Test Grid Projects Result - List
Test Grid Session Actions Request - List
Test Grid Session Actions Result - List
Test Grid Session Artifacts Request - List
Test Grid Session Artifacts Result - List
Test Grid Sessions Request - List
Test Grid Sessions Result - List
Tests Request Represents a request to the list tests operation.
- List
Tests Result Represents the result of a list tests request.
- List
Unique Problems Request Represents a request to the list unique problems operation.
- List
Unique Problems Result Represents the result of a list unique problems request.
- List
Uploads Request Represents a request to the list uploads operation.
- List
Uploads Result Represents the result of a list uploads request.
- ListVPCE
Configurations Request - ListVPCE
Configurations Result - Location
Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example, 47.6204, -122.3491).
Elevation is currently not supported.
- Monetary
Amount A number that represents the monetary amount for an offering or transaction.
- Network
Profile An array of settings that describes characteristics of a network profile.
- Offering
Represents the metadata of a device offering.
- Offering
Promotion Represents information about an offering promotion.
- Offering
Status The status of the offering.
- Offering
Transaction Represents the metadata of an offering transaction.
- Problem
Represents a specific warning or failure.
- Problem
Detail Information about a problem detail.
- Project
Represents an operating-system neutral workspace for running and managing tests.
- Purchase
Offering Request Represents a request for a purchase offering.
- Purchase
Offering Result The result of the purchase offering (for example, success or failure).
- Radios
Represents the set of radios and their states on a device. Examples of radios include Wi-Fi, GPS, Bluetooth, and NFC.
- Recurring
Charge Specifies whether charges for devices are recurring.
- Remote
Access Session Represents information about the remote access session.
- Renew
Offering Request A request that represents an offering renewal.
- Renew
Offering Result The result of a renewal offering.
- Resolution
Represents the screen resolution of a device in height and width, expressed in pixels.
- Rule
Represents a condition for a device pool.
- Run
Represents a test run on a set of devices with a given app package, test parameters, and so on.
- Sample
Represents a sample of performance data.
- Schedule
RunConfiguration Represents the settings for a run. Includes things like location, radio states, auxiliary apps, and network profiles.
- Schedule
RunRequest Represents a request to the schedule run operation.
- Schedule
RunResult Represents the result of a schedule run request.
- Schedule
RunTest 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.
- Stop
JobRequest - Stop
JobResult - Stop
Remote Access Session Request Represents the request to stop the remote access session.
- Stop
Remote Access Session Result Represents the response from the server that describes the remote access session when AWS Device Farm stops the session.
- Stop
RunRequest Represents the request to stop a specific run.
- Stop
RunResult Represents the results of your stop run attempt.
- Suite
Represents a collection of one or more tests.
- Tag
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.
- TagResource
Request - TagResource
Response - Test
Represents a condition that is evaluated.
- Test
Grid Project A Selenium testing project. Projects are used to collect and collate sessions.
- Test
Grid Session A TestGridSession is a single instance of a browser launched from the URL provided by a call to CreateTestGridUrl.
- Test
Grid Session Action An action taken by a TestGridSession browser instance.
- Test
Grid Session Artifact 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.
- Trial
Minutes Represents information about free trial device minutes for an AWS account.
- Unique
Problem A collection of one or more problems, grouped by their result.
- Untag
Resource Request - Untag
Resource Response - Update
Device Instance Request - Update
Device Instance Result - Update
Device Pool Request Represents a request to the update device pool operation.
- Update
Device Pool Result Represents the result of an update device pool request.
- Update
Instance Profile Request - Update
Instance Profile Result - Update
Network Profile Request - Update
Network Profile Result - Update
Project Request Represents a request to the update project operation.
- Update
Project Result Represents the result of an update project request.
- Update
Test Grid Project Request - Update
Test Grid Project Result - Update
Upload Request - Update
Upload Result - UpdateVPCE
Configuration Request - UpdateVPCE
Configuration Result - Upload
An app or a set of one or more tests to upload or that have been uploaded.
- VPCE
Configuration Represents an Amazon Virtual Private Cloud (VPC) endpoint configuration.
Enums§
- Create
Device Pool Error - Errors returned by CreateDevicePool
- Create
Instance Profile Error - Errors returned by CreateInstanceProfile
- Create
Network Profile Error - Errors returned by CreateNetworkProfile
- Create
Project Error - Errors returned by CreateProject
- Create
Remote Access Session Error - Errors returned by CreateRemoteAccessSession
- Create
Test Grid Project Error - Errors returned by CreateTestGridProject
- Create
Test Grid UrlError - Errors returned by CreateTestGridUrl
- Create
Upload Error - Errors returned by CreateUpload
- CreateVPCE
Configuration Error - Errors returned by CreateVPCEConfiguration
- Delete
Device Pool Error - Errors returned by DeleteDevicePool
- Delete
Instance Profile Error - Errors returned by DeleteInstanceProfile
- Delete
Network Profile Error - Errors returned by DeleteNetworkProfile
- Delete
Project Error - Errors returned by DeleteProject
- Delete
Remote Access Session Error - Errors returned by DeleteRemoteAccessSession
- Delete
RunError - Errors returned by DeleteRun
- Delete
Test Grid Project Error - Errors returned by DeleteTestGridProject
- Delete
Upload Error - Errors returned by DeleteUpload
- DeleteVPCE
Configuration Error - Errors returned by DeleteVPCEConfiguration
- GetAccount
Settings Error - Errors returned by GetAccountSettings
- GetDevice
Error - Errors returned by GetDevice
- GetDevice
Instance Error - Errors returned by GetDeviceInstance
- GetDevice
Pool Compatibility Error - Errors returned by GetDevicePoolCompatibility
- GetDevice
Pool Error - Errors returned by GetDevicePool
- GetInstance
Profile Error - Errors returned by GetInstanceProfile
- GetJob
Error - Errors returned by GetJob
- GetNetwork
Profile Error - Errors returned by GetNetworkProfile
- GetOffering
Status Error - Errors returned by GetOfferingStatus
- GetProject
Error - Errors returned by GetProject
- GetRemote
Access Session Error - Errors returned by GetRemoteAccessSession
- GetRun
Error - Errors returned by GetRun
- GetSuite
Error - Errors returned by GetSuite
- GetTest
Error - Errors returned by GetTest
- GetTest
Grid Project Error - Errors returned by GetTestGridProject
- GetTest
Grid Session Error - Errors returned by GetTestGridSession
- GetUpload
Error - Errors returned by GetUpload
- GetVPCE
Configuration Error - Errors returned by GetVPCEConfiguration
- Install
ToRemote Access Session Error - Errors returned by InstallToRemoteAccessSession
- List
Artifacts Error - Errors returned by ListArtifacts
- List
Device Instances Error - Errors returned by ListDeviceInstances
- List
Device Pools Error - Errors returned by ListDevicePools
- List
Devices Error - Errors returned by ListDevices
- List
Instance Profiles Error - Errors returned by ListInstanceProfiles
- List
Jobs Error - Errors returned by ListJobs
- List
Network Profiles Error - Errors returned by ListNetworkProfiles
- List
Offering Promotions Error - Errors returned by ListOfferingPromotions
- List
Offering Transactions Error - Errors returned by ListOfferingTransactions
- List
Offerings Error - Errors returned by ListOfferings
- List
Projects Error - Errors returned by ListProjects
- List
Remote Access Sessions Error - Errors returned by ListRemoteAccessSessions
- List
Runs Error - Errors returned by ListRuns
- List
Samples Error - Errors returned by ListSamples
- List
Suites Error - Errors returned by ListSuites
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- List
Test Grid Projects Error - Errors returned by ListTestGridProjects
- List
Test Grid Session Actions Error - Errors returned by ListTestGridSessionActions
- List
Test Grid Session Artifacts Error - Errors returned by ListTestGridSessionArtifacts
- List
Test Grid Sessions Error - Errors returned by ListTestGridSessions
- List
Tests Error - Errors returned by ListTests
- List
Unique Problems Error - Errors returned by ListUniqueProblems
- List
Uploads Error - Errors returned by ListUploads
- ListVPCE
Configurations Error - Errors returned by ListVPCEConfigurations
- Purchase
Offering Error - Errors returned by PurchaseOffering
- Renew
Offering Error - Errors returned by RenewOffering
- Schedule
RunError - Errors returned by ScheduleRun
- Stop
JobError - Errors returned by StopJob
- Stop
Remote Access Session Error - Errors returned by StopRemoteAccessSession
- Stop
RunError - Errors returned by StopRun
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Device Instance Error - Errors returned by UpdateDeviceInstance
- Update
Device Pool Error - Errors returned by UpdateDevicePool
- Update
Instance Profile Error - Errors returned by UpdateInstanceProfile
- Update
Network Profile Error - Errors returned by UpdateNetworkProfile
- Update
Project Error - Errors returned by UpdateProject
- Update
Test Grid Project Error - Errors returned by UpdateTestGridProject
- Update
Upload Error - Errors returned by UpdateUpload
- UpdateVPCE
Configuration Error - Errors returned by UpdateVPCEConfiguration
Traits§
- Device
Farm - Trait representing the capabilities of the AWS Device Farm API. AWS Device Farm clients implement this trait.