ListRemoteAccessSessionsCommand

Suggest an Edit

Returns a list of all currently running remote access sessions.

Example Syntax

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

import { DeviceFarmClient, ListRemoteAccessSessionsCommand } from "@aws-sdk/client-device-farm"; // ES Modules import
// const { DeviceFarmClient, ListRemoteAccessSessionsCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import
const client = new DeviceFarmClient(config);
const input = { // ListRemoteAccessSessionsRequest
  arn: "STRING_VALUE", // required
  nextToken: "STRING_VALUE",
};
const command = new ListRemoteAccessSessionsCommand(input);
const response = await client.send(command);
// { // ListRemoteAccessSessionsResult
//   remoteAccessSessions: [ // RemoteAccessSessions
//     { // RemoteAccessSession
//       arn: "STRING_VALUE",
//       name: "STRING_VALUE",
//       created: new Date("TIMESTAMP"),
//       status: "PENDING" || "PENDING_CONCURRENCY" || "PENDING_DEVICE" || "PROCESSING" || "SCHEDULING" || "PREPARING" || "RUNNING" || "COMPLETED" || "STOPPING",
//       result: "PENDING" || "PASSED" || "WARNED" || "FAILED" || "SKIPPED" || "ERRORED" || "STOPPED",
//       message: "STRING_VALUE",
//       started: new Date("TIMESTAMP"),
//       stopped: new Date("TIMESTAMP"),
//       device: { // Device
//         arn: "STRING_VALUE",
//         name: "STRING_VALUE",
//         manufacturer: "STRING_VALUE",
//         model: "STRING_VALUE",
//         modelId: "STRING_VALUE",
//         formFactor: "PHONE" || "TABLET",
//         platform: "ANDROID" || "IOS",
//         os: "STRING_VALUE",
//         cpu: { // CPU
//           frequency: "STRING_VALUE",
//           architecture: "STRING_VALUE",
//           clock: Number("double"),
//         },
//         resolution: { // Resolution
//           width: Number("int"),
//           height: Number("int"),
//         },
//         heapSize: Number("long"),
//         memory: Number("long"),
//         image: "STRING_VALUE",
//         carrier: "STRING_VALUE",
//         radio: "STRING_VALUE",
//         remoteAccessEnabled: true || false,
//         remoteDebugEnabled: true || false,
//         fleetType: "STRING_VALUE",
//         fleetName: "STRING_VALUE",
//         instances: [ // DeviceInstances
//           { // DeviceInstance
//             arn: "STRING_VALUE",
//             deviceArn: "STRING_VALUE",
//             labels: [ // InstanceLabels
//               "STRING_VALUE",
//             ],
//             status: "IN_USE" || "PREPARING" || "AVAILABLE" || "NOT_AVAILABLE",
//             udid: "STRING_VALUE",
//             instanceProfile: { // InstanceProfile
//               arn: "STRING_VALUE",
//               packageCleanup: true || false,
//               excludeAppPackagesFromCleanup: [ // PackageIds
//                 "STRING_VALUE",
//               ],
//               rebootAfterUse: true || false,
//               name: "STRING_VALUE",
//               description: "STRING_VALUE",
//             },
//           },
//         ],
//         availability: "TEMPORARY_NOT_AVAILABLE" || "BUSY" || "AVAILABLE" || "HIGHLY_AVAILABLE",
//       },
//       instanceArn: "STRING_VALUE",
//       remoteDebugEnabled: true || false,
//       remoteRecordEnabled: true || false,
//       remoteRecordAppArn: "STRING_VALUE",
//       hostAddress: "STRING_VALUE",
//       clientId: "STRING_VALUE",
//       billingMethod: "METERED" || "UNMETERED",
//       deviceMinutes: { // DeviceMinutes
//         total: Number("double"),
//         metered: Number("double"),
//         unmetered: Number("double"),
//       },
//       endpoint: "STRING_VALUE",
//       deviceUdid: "STRING_VALUE",
//       interactionMode: "INTERACTIVE" || "NO_VIDEO" || "VIDEO_ONLY",
//       skipAppResign: true || false,
//       vpcConfig: { // VpcConfig
//         securityGroupIds: [ // VpcSecurityGroupIds // required
//           "STRING_VALUE",
//         ],
//         subnetIds: [ // VpcSubnetIds // required
//           "STRING_VALUE",
//         ],
//         vpcId: "STRING_VALUE", // required
//       },
//       deviceProxy: { // DeviceProxy
//         host: "STRING_VALUE", // required
//         port: Number("int"), // required
//       },
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

Example Usage

 Loading code editor

ListRemoteAccessSessionsCommand Input

See ListRemoteAccessSessionsCommandInput for more details

Parameter
Type
Description
arn
Required
string | undefined

The Amazon Resource Name (ARN) of the project about which you are requesting information.

nextToken
string | undefined

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

ListRemoteAccessSessionsCommand Output

See ListRemoteAccessSessionsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
nextToken
string | undefined

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

remoteAccessSessions
RemoteAccessSession[] | undefined

A container that represents the metadata from the service about each remote access session you are requesting.

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.