GetDevicePoolCommand

Suggest an Edit

Gets information about a device pool.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DeviceFarmClient, GetDevicePoolCommand } from "@aws-sdk/client-device-farm"; // ES Modules import
// const { DeviceFarmClient, GetDevicePoolCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import
const client = new DeviceFarmClient(config);
const input = { // GetDevicePoolRequest
  arn: "STRING_VALUE", // required
};
const command = new GetDevicePoolCommand(input);
const response = await client.send(command);
// { // GetDevicePoolResult
//   devicePool: { // DevicePool
//     arn: "STRING_VALUE",
//     name: "STRING_VALUE",
//     description: "STRING_VALUE",
//     type: "CURATED" || "PRIVATE",
//     rules: [ // Rules
//       { // Rule
//         attribute: "ARN" || "PLATFORM" || "FORM_FACTOR" || "MANUFACTURER" || "REMOTE_ACCESS_ENABLED" || "REMOTE_DEBUG_ENABLED" || "APPIUM_VERSION" || "INSTANCE_ARN" || "INSTANCE_LABELS" || "FLEET_TYPE" || "OS_VERSION" || "MODEL" || "AVAILABILITY",
//         operator: "EQUALS" || "LESS_THAN" || "LESS_THAN_OR_EQUALS" || "GREATER_THAN" || "GREATER_THAN_OR_EQUALS" || "IN" || "NOT_IN" || "CONTAINS",
//         value: "STRING_VALUE",
//       },
//     ],
//     maxDevices: Number("int"),
//   },
// };

Example Usage

 Loading code editor

GetDevicePoolCommand Input

See GetDevicePoolCommandInput for more details

Parameter
Type
Description
arn
Required
string | undefined

The device pool's ARN.

GetDevicePoolCommand Output

See GetDevicePoolCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
devicePool
DevicePool | undefined

An object that contains information about the requested device pool.

Throws

Name
Fault
Details
ArgumentException
client

An invalid argument was specified.

LimitExceededException
client

A limit was exceeded.

NotFoundException
client

The specified entity was not found.

ServiceAccountException
client

There was a problem with the service account.

DeviceFarmServiceException
Base exception class for all service exceptions from DeviceFarm service.