class Aws::DeviceFarm::Types::CreateRemoteAccessSessionRequest
Creates and submits a request to start a remote access session.
@note When making an API call, you may pass CreateRemoteAccessSessionRequest
data as a hash: { project_arn: "AmazonResourceName", # required device_arn: "AmazonResourceName", # required instance_arn: "AmazonResourceName", ssh_public_key: "SshPublicKey", remote_debug_enabled: false, remote_record_enabled: false, remote_record_app_arn: "AmazonResourceName", name: "Name", client_id: "ClientId", configuration: { billing_method: "METERED", # accepts METERED, UNMETERED vpce_configuration_arns: ["AmazonResourceName"], }, interaction_mode: "INTERACTIVE", # accepts INTERACTIVE, NO_VIDEO, VIDEO_ONLY skip_app_resign: false, }
@!attribute [rw] project_arn
The Amazon Resource Name (ARN) of the project for which you want to create a remote access session. @return [String]
@!attribute [rw] device_arn
The ARN of the device for which you want to create a remote access session. @return [String]
@!attribute [rw] instance_arn
The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session. @return [String]
@!attribute [rw] ssh_public_key
Ignored. The public key of the `ssh` key pair you want to use for connecting to remote devices in your remote debugging session. This key is required only if `remoteDebugEnabled` is set to `true`. Remote debugging is [no longer supported][1]. [1]: https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html @return [String]
@!attribute [rw] remote_debug_enabled
Set to `true` if you want to access devices remotely for debugging in your remote access session. Remote debugging is [no longer supported][1]. [1]: https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html @return [Boolean]
@!attribute [rw] remote_record_enabled
Set to `true` to enable remote recording for the remote access session. @return [Boolean]
@!attribute [rw] remote_record_app_arn
The Amazon Resource Name (ARN) for the app to be recorded in the remote access session. @return [String]
@!attribute [rw] name
The name of the remote access session to create. @return [String]
@!attribute [rw] client_id
Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same `clientId` value in each call to `CreateRemoteAccessSession`. This identifier is required only if `remoteDebugEnabled` is set to `true`. Remote debugging is [no longer supported][1]. [1]: https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html @return [String]
@!attribute [rw] configuration
The configuration information for the remote access session request. @return [Types::CreateRemoteAccessSessionConfiguration]
@!attribute [rw] interaction_mode
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. @return [String]
@!attribute [rw] skip_app_resign
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?][1] [1]: https://aws.amazon.com/device-farm/faq/ @return [Boolean]
@see docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/CreateRemoteAccessSessionRequest AWS API Documentation
Constants
- SENSITIVE