Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateRemoteAccessSession

Specifies and starts a remote access session.

Request Syntax


{
   "appArn": "string",
   "configuration": { 
      "auxiliaryApps": [ "string" ],
      "billingMethod": "string",
      "deviceProxy": { 
         "host": "string",
         "port": number
      },
      "vpceConfigurationArns": [ "string" ]
   },
   "deviceArn": "string",
   "instanceArn": "string",
   "interactionMode": "string",
   "name": "string",
   "projectArn": "string",
   "skipAppResign": boolean
}

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.

appArn

The Amazon Resource Name (ARN) of the app to create the remote access session.

Type: String

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

Pattern: ^arn:aws:devicefarm:.+

Required: No

configuration

The configuration information for the remote access session request.

Type: CreateRemoteAccessSessionConfiguration object

Required: No

deviceArn

The ARN of the device for which you want to create a remote access session.

Type: String

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

Pattern: ^arn:aws:devicefarm:.+

Required: Yes

instanceArn

The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.

Type: String

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

Pattern: ^arn:aws:devicefarm:.+

Required: No

interactionMode

This parameter has been deprecated.

The interaction mode of the remote access session. Changing the interactive mode of remote access sessions is no longer available.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Valid Values: INTERACTIVE | NO_VIDEO | VIDEO_ONLY

Required: No

name

The name of the remote access session to create.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

projectArn

The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.

Type: String

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

Pattern: ^arn:aws:devicefarm:.+

Required: Yes

skipAppResign

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information on how Device Farm modifies your uploads during tests, see Do you modify my app?

Type: Boolean

Required: No

Response Syntax


{
   "remoteAccessSession": { 
      "appUpload": "string",
      "arn": "string",
      "billingMethod": "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
      },
      "deviceProxy": { 
         "host": "string",
         "port": number
      },
      "deviceUdid": "string",
      "endpoint": "string",
      "endpoints": { 
         "interactiveEndpoint": "string",
         "remoteDriverEndpoint": "string"
      },
      "instanceArn": "string",
      "interactionMode": "string",
      "message": "string",
      "name": "string",
      "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.

remoteAccessSession

A container that describes the remote access session when the request to create a remote access session is sent.

Type: RemoteAccessSession object

Errors

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

ArgumentException

An invalid argument was specified.

message: Any additional information about the exception.

HTTP Status Code: 400

LimitExceededException

A limit was exceeded.

message: Any additional information about the exception.

HTTP Status Code: 400

NotFoundException

The specified entity was not found.

message: Any additional information about the exception.

HTTP Status Code: 400

ServiceAccountException

There was a problem with the service account.

message: Any additional information about the exception.

HTTP Status Code: 400