GetRemoteAccessSession - AWS Device Farm Documentation


Returns a link to a currently running remote access session.

Request Syntax

{ "arn": "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.


The Amazon Resource Name (ARN) of the remote access session about which you want to get session information.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 1011.

Pattern: ^arn:.+

Required: Yes

Response Syntax

{ "remoteAccessSession": { "arn": "string", "billingMethod": "string", "clientId": "string", "created": number, "device": { "arn": "string", "availability": "string", "carrier": "string", "cpu": { "architecture": "string", "clock": number, "frequency": "string" }, "fleetName": "string", "fleetType": "string", "formFactor": "string", "heapSize": number, "image": "string", "instances": [ { "arn": "string", "deviceArn": "string", "instanceProfile": { "arn": "string", "description": "string", "excludeAppPackagesFromCleanup": [ "string" ], "name": "string", "packageCleanup": boolean, "rebootAfterUse": boolean }, "labels": [ "string" ], "status": "string", "udid": "string" } ], "manufacturer": "string", "memory": number, "model": "string", "modelId": "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", "instanceArn": "string", "interactionMode": "string", "message": "string", "name": "string", "remoteDebugEnabled": boolean, "remoteRecordAppArn": "string", "remoteRecordEnabled": boolean, "result": "string", "skipAppResign": boolean, "started": number, "status": "string", "stopped": number, "vpcConfig": { "securityGroupIds": [ "string" ], "subnetIds": [ "string" ], "vpcId": "string" } } }

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.


A container that lists detailed information about the remote access session.

Type: RemoteAccessSession object


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


An invalid argument was specified.

HTTP Status Code: 400


A limit was exceeded.

HTTP Status Code: 400


The specified entity was not found.

HTTP Status Code: 400


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: