CreateRemoteAccessSession
Specifies and starts a remote access session.
Request Syntax
{
"clientId": "string",
"configuration": {
"billingMethod": "string",
"vpceConfigurationArns": [ "string" ]
},
"deviceArn": "string",
"instanceArn": "string",
"interactionMode": "string",
"name": "string",
"projectArn": "string",
"remoteDebugEnabled": boolean,
"remoteRecordAppArn": "string",
"remoteRecordEnabled": boolean,
"skipAppResign": boolean,
"sshPublicKey": "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.
- clientId
-
Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same
clientIdvalue in each call toCreateRemoteAccessSession. This identifier is required only ifremoteDebugEnabledis set totrue.Remote debugging is no longer supported.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
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:.+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:.+Required: No
- interactionMode
-
The interaction mode of the remote access session. Valid values are:
-
INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode.
-
NO_VIDEO: You are connected to the device, but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode.
-
VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Valid Values:
INTERACTIVE | NO_VIDEO | VIDEO_ONLYRequired: 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:.+Required: Yes
- remoteDebugEnabled
-
Set to
trueif you want to access devices remotely for debugging in your remote access session.Remote debugging is no longer supported.
Type: Boolean
Required: No
- remoteRecordAppArn
-
The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 1011.
Pattern:
^arn:.+Required: No
- remoteRecordEnabled
-
Set to
trueto enable remote recording for the remote access session.Type: Boolean
Required: No
- 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
- sshPublicKey
-
Ignored. The public key of the
sshkey pair you want to use for connecting to remote devices in your remote debugging session. This key is required only ifremoteDebugEnabledis set totrue.Remote debugging is no longer supported.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Required: No
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.
- 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.
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:
