DeviceFarmClient

Suggest an Edit

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 .

Installation

NPM
npm install @aws-sdk/client-device-farm
Yarn
yarn add @aws-sdk/client-device-farm
pnpm
pnpm add @aws-sdk/client-device-farm

DeviceFarmClient Operations

Command
Summary
CreateDevicePoolCommand

Creates a device pool.

CreateInstanceProfileCommand

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

CreateNetworkProfileCommand

Creates a network profile.

CreateProjectCommand

Creates a project.

CreateRemoteAccessSessionCommand

Specifies and starts a remote access session.

CreateTestGridProjectCommand

Creates a Selenium testing project. Projects are used to track TestGridSession instances.

CreateTestGridUrlCommand

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

CreateUploadCommand

Uploads an app or test scripts.

CreateVPCEConfigurationCommand

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

DeleteDevicePoolCommand

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

DeleteInstanceProfileCommand

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

DeleteNetworkProfileCommand

Deletes a network profile.

DeleteProjectCommand

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

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

DeleteRemoteAccessSessionCommand

Deletes a completed remote access session and its results.

DeleteRunCommand

Deletes the run, given the run ARN.

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

DeleteTestGridProjectCommand

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.

DeleteUploadCommand

Deletes an upload given the upload ARN.

DeleteVPCEConfigurationCommand

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

GetAccountSettingsCommand

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

GetDeviceCommand

Gets information about a unique device type.

GetDeviceInstanceCommand

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

GetDevicePoolCommand

Gets information about a device pool.

GetDevicePoolCompatibilityCommand

Gets information about compatibility with a device pool.

GetInstanceProfileCommand

Returns information about the specified instance profile.

GetJobCommand

Gets information about a job.

GetNetworkProfileCommand

Returns information about a network profile.

GetOfferingStatusCommand

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 aws-devicefarm-supportamazon.com .

GetProjectCommand

Gets information about a project.

GetRemoteAccessSessionCommand

Returns a link to a currently running remote access session.

GetRunCommand

Gets information about a run.

GetSuiteCommand

Gets information about a suite.

GetTestCommand

Gets information about a test.

GetTestGridProjectCommand

Retrieves information about a Selenium testing project.

GetTestGridSessionCommand

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 and GetTestGridSessionRequest$sessionId).

GetUploadCommand

Gets information about an upload.

GetVPCEConfigurationCommand

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

InstallToRemoteAccessSessionCommand

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.

ListArtifactsCommand

Gets information about artifacts.

ListDeviceInstancesCommand

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

ListDevicePoolsCommand

Gets information about device pools.

ListDevicesCommand

Gets information about unique device types.

ListInstanceProfilesCommand

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

ListJobsCommand

Gets information about jobs for a given test run.

ListNetworkProfilesCommand

Returns the list of available network profiles.

ListOfferingPromotionsCommand

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 aws-devicefarm-supportamazon.com  if you must be able to invoke this operation.

ListOfferingTransactionsCommand

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 aws-devicefarm-supportamazon.com .

ListOfferingsCommand

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 aws-devicefarm-supportamazon.com .

ListProjectsCommand

Gets information about projects.

ListRemoteAccessSessionsCommand

Returns a list of all currently running remote access sessions.

ListRunsCommand

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

ListSamplesCommand

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

ListSuitesCommand

Gets information about test suites for a given job.

ListTagsForResourceCommand

List the tags for an AWS Device Farm resource.

ListTestGridProjectsCommand

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

ListTestGridSessionActionsCommand

Returns a list of the actions taken in a TestGridSession.

ListTestGridSessionArtifactsCommand

Retrieves a list of artifacts created during the session.

ListTestGridSessionsCommand

Retrieves a list of sessions for a TestGridProject.

ListTestsCommand

Gets information about tests in a given test suite.

ListUniqueProblemsCommand

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.

ListUploadsCommand

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

ListVPCEConfigurationsCommand

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

PurchaseOfferingCommand

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 aws-devicefarm-supportamazon.com .

RenewOfferingCommand

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 aws-devicefarm-supportamazon.com .

ScheduleRunCommand

Schedules a run.

StopJobCommand

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.

StopRemoteAccessSessionCommand

Ends a specified remote access session.

StopRunCommand

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.

TagResourceCommand

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.

UntagResourceCommand

Deletes the specified tags from a resource.

UpdateDeviceInstanceCommand

Updates information about a private device instance.

UpdateDevicePoolCommand

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

UpdateInstanceProfileCommand

Updates information about an existing private device instance profile.

UpdateNetworkProfileCommand

Updates the network profile.

UpdateProjectCommand

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

UpdateTestGridProjectCommand

Change details of a project.

UpdateUploadCommand

Updates an uploaded test spec.

UpdateVPCEConfigurationCommand

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

DeviceFarmClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: DeviceFarmClientConfig