Specifies and starts a remote access session.
post/#X-Amz-Target=DeviceFarm_20150623.CreateRemoteAccessSession
Headers
X-Amz-Target'DeviceFarm_20150623.CreateRemoteAccessSession' required
Request body
projectArnstring required
The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.
deviceArnstring required
The ARN of the device for which you want to create a remote access session.
instanceArnstring
The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.
sshPublicKeystring
<p>Ignored. The public key of the <code>ssh</code> key pair you want to use for connecting to remote devices in your remote debugging session. This key is required only if <code>remoteDebugEnabled</code> is set to <code>true</code>.</p> <p>Remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no longer supported</a>.</p>
remoteDebugEnabledboolean
<p>Set to <code>true</code> if you want to access devices remotely for debugging in your remote access session.</p> <p>Remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no longer supported</a>.</p>
remoteRecordEnabledboolean
Set to <code>true</code> to enable remote recording for the remote access session.
remoteRecordAppArnstring
The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
namestring
The name of the remote access session to create.
clientIdstring
<p>Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same <code>clientId</code> value in each call to <code>CreateRemoteAccessSession</code>. This identifier is required only if <code>remoteDebugEnabled</code> is set to <code>true</code>.</p> <p>Remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no longer supported</a>.</p>
interactionMode'INTERACTIVE' | 'NO_VIDEO' | 'VIDEO_ONLY'
<p>The interaction mode of the remote access session. Valid values are:</p> <ul> <li> <p>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.</p> </li> <li> <p>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.</p> </li> <li> <p>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.</p> </li> </ul>
skipAppResignboolean
<p>When set to <code>true</code>, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.</p> <p>For more information on how Device Farm modifies your uploads during tests, see <a href="http://aws.amazon.com/device-farm/faqs/">Do you modify my app?</a> </p>
Response
Success
Example response
{
"remoteAccessSession": {}
}