@aws-sdk/client-device-farm

Description

AWS SDK for JavaScript DeviceFarm Client for Node.js, Browser and React Native.

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.

  
  

Installing

To install this package, simply type add or install @aws-sdk/client-device-farm
using your favorite package manager:
- npm install @aws-sdk/client-device-farm
- yarn add @aws-sdk/client-device-farm
- pnpm add @aws-sdk/client-device-farm

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the DeviceFarmClient and
the commands you need, for example ListDevicesCommand:

``js
// ES5 example
const { DeviceFarmClient, ListDevicesCommand } = require("@aws-sdk/client-device-farm");
`

`ts
// ES6+ example
import { DeviceFarmClient, ListDevicesCommand } from "@aws-sdk/client-device-farm";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new DeviceFarmClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListDevicesCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-device-farm";
const client = new AWS.DeviceFarm({ region: "REGION" });

// async/await.
try {
const data = await client.listDevices(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listDevices(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listDevices(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-device-farm` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

CreateDevicePool

Command API Reference / Input / Output

CreateInstanceProfile

Command API Reference / Input / Output

CreateNetworkProfile

Command API Reference / Input / Output

CreateProject

Command API Reference / Input / Output

CreateRemoteAccessSession

Command API Reference / Input / Output

CreateTestGridProject

Command API Reference / Input / Output

CreateTestGridUrl

Command API Reference / Input / Output

CreateUpload

Command API Reference / Input / Output

CreateVPCEConfiguration

Command API Reference / Input / Output

DeleteDevicePool

Command API Reference / Input / Output

DeleteInstanceProfile

Command API Reference / Input / Output

DeleteNetworkProfile

Command API Reference / Input / Output

DeleteProject

Command API Reference / Input / Output

DeleteRemoteAccessSession

Command API Reference / Input / Output

DeleteRun

Command API Reference / Input / Output

DeleteTestGridProject

Command API Reference / Input / Output

DeleteUpload

Command API Reference / Input / Output

DeleteVPCEConfiguration

Command API Reference / Input / Output

GetAccountSettings

Command API Reference / Input / Output

GetDevice

Command API Reference / Input / Output

GetDeviceInstance

Command API Reference / Input / Output

GetDevicePool

Command API Reference / Input / Output

GetDevicePoolCompatibility

Command API Reference / Input / Output

GetInstanceProfile

Command API Reference / Input / Output

GetJob

Command API Reference / Input / Output

GetNetworkProfile

Command API Reference / Input / Output

GetOfferingStatus

Command API Reference / Input / Output

GetProject

Command API Reference / Input / Output

GetRemoteAccessSession

Command API Reference / Input / Output

GetRun

Command API Reference / Input / Output

GetSuite

Command API Reference / Input / Output

GetTest

Command API Reference / Input / Output

GetTestGridProject

Command API Reference / Input / Output

GetTestGridSession

Command API Reference / Input / Output

GetUpload

Command API Reference / Input / Output

GetVPCEConfiguration

Command API Reference / Input / Output

InstallToRemoteAccessSession

Command API Reference / Input / Output

ListArtifacts

Command API Reference / Input / Output

ListDeviceInstances

Command API Reference / Input / Output

ListDevicePools

Command API Reference / Input / Output

ListDevices

Command API Reference / Input / Output

ListInstanceProfiles

Command API Reference / Input / Output

ListJobs

Command API Reference / Input / Output

ListNetworkProfiles

Command API Reference / Input / Output

ListOfferingPromotions

Command API Reference / Input / Output

ListOfferings

Command API Reference / Input / Output

ListOfferingTransactions

Command API Reference / Input / Output

ListProjects

Command API Reference / Input / Output

ListRemoteAccessSessions

Command API Reference / Input / Output

ListRuns

Command API Reference / Input / Output

ListSamples

Command API Reference / Input / Output

ListSuites

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListTestGridProjects

Command API Reference / Input / Output

ListTestGridSessionActions

Command API Reference / Input / Output

ListTestGridSessionArtifacts

Command API Reference / Input / Output

ListTestGridSessions

Command API Reference / Input / Output

ListTests

Command API Reference / Input / Output

ListUniqueProblems

Command API Reference / Input / Output

ListUploads

Command API Reference / Input / Output

ListVPCEConfigurations

Command API Reference / Input / Output

PurchaseOffering

Command API Reference / Input / Output

RenewOffering

Command API Reference / Input / Output

ScheduleRun

Command API Reference / Input / Output

StopJob

Command API Reference / Input / Output

StopRemoteAccessSession

Command API Reference / Input / Output

StopRun

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateDeviceInstance

Command API Reference / Input / Output

UpdateDevicePool

Command API Reference / Input / Output

UpdateInstanceProfile

Command API Reference / Input / Output

UpdateNetworkProfile

Command API Reference / Input / Output

UpdateProject

Command API Reference / Input / Output

UpdateTestGridProject

Command API Reference / Input / Output

UpdateUpload

Command API Reference / Input / Output

UpdateVPCEConfiguration

Command API Reference / Input / Output