Menu
AWS Device Farm
API Reference (API Version 2015-06-23)

ListRemoteAccessSessions

Returns a list of all currently running remote access sessions.

Request Syntax

{
   "arn": "string",
   "nextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

arn

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

Type: String

Length Constraints: Minimum length of 32.

Required: Yes

nextToken

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.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.

Required: No

Response Syntax

{
   "nextToken": "string",
   "remoteAccessSessions": [ 
      { 
         "arn": "string",
         "billingMethod": "string",
         "clientId": "string",
         "created": number,
         "device": { 
            "arn": "string",
            "carrier": "string",
            "cpu": { 
               "architecture": "string",
               "clock": number,
               "frequency": "string"
            },
            "fleetName": "string",
            "fleetType": "string",
            "formFactor": "string",
            "heapSize": number,
            "image": "string",
            "manufacturer": "string",
            "memory": number,
            "model": "string",
            "name": "string",
            "os": "string",
            "platform": "string",
            "radio": "string",
            "remoteAccessEnabled": boolean,
            "remoteDebugEnabled": boolean,
            "resolution": { 
               "height": number,
               "width": number
            }
         },
         "deviceMinutes": { 
            "metered": number,
            "total": number,
            "unmetered": number
         },
         "deviceUdid": "string",
         "endpoint": "string",
         "hostAddress": "string",
         "message": "string",
         "name": "string",
         "remoteDebugEnabled": boolean,
         "result": "string",
         "started": number,
         "status": "string",
         "stopped": number
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

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.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.

remoteAccessSessions

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

Type: Array of RemoteAccessSession objects

Errors

For information about the errors that are common to all actions, see Common Errors.

ArgumentException

An invalid argument was specified.

HTTP Status Code: 400

LimitExceededException

A limit was exceeded.

HTTP Status Code: 400

NotFoundException

The specified entity was not found.

HTTP Status Code: 400

ServiceAccountException

There was a problem with the service account.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: