You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::DeviceFarm::Types::CreateRemoteAccessSessionRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb

Overview

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,
}

Creates and submits a request to start a remote access session.

Instance Attribute Summary collapse

Instance Attribute Details

#client_idString

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 is required only if remoteDebugEnabled is set to true.

Returns:

  • (String)


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 628

class CreateRemoteAccessSessionRequest < Struct.new(
  :project_arn,
  :device_arn,
  :instance_arn,
  :ssh_public_key,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :name,
  :client_id,
  :configuration,
  :interaction_mode,
  :skip_app_resign)
  include Aws::Structure
end

#configurationTypes::CreateRemoteAccessSessionConfiguration

The configuration information for the remote access session request.



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 628

class CreateRemoteAccessSessionRequest < Struct.new(
  :project_arn,
  :device_arn,
  :instance_arn,
  :ssh_public_key,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :name,
  :client_id,
  :configuration,
  :interaction_mode,
  :skip_app_resign)
  include Aws::Structure
end

#device_arnString

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

Returns:

  • (String)


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 628

class CreateRemoteAccessSessionRequest < Struct.new(
  :project_arn,
  :device_arn,
  :instance_arn,
  :ssh_public_key,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :name,
  :client_id,
  :configuration,
  :interaction_mode,
  :skip_app_resign)
  include Aws::Structure
end

#instance_arnString

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

Returns:

  • (String)


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 628

class CreateRemoteAccessSessionRequest < Struct.new(
  :project_arn,
  :device_arn,
  :instance_arn,
  :ssh_public_key,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :name,
  :client_id,
  :configuration,
  :interaction_mode,
  :skip_app_resign)
  include Aws::Structure
end

#interaction_modeString

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.

Returns:

  • (String)


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 628

class CreateRemoteAccessSessionRequest < Struct.new(
  :project_arn,
  :device_arn,
  :instance_arn,
  :ssh_public_key,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :name,
  :client_id,
  :configuration,
  :interaction_mode,
  :skip_app_resign)
  include Aws::Structure
end

#nameString

The name of the remote access session that you wish to create.

Returns:

  • (String)


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 628

class CreateRemoteAccessSessionRequest < Struct.new(
  :project_arn,
  :device_arn,
  :instance_arn,
  :ssh_public_key,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :name,
  :client_id,
  :configuration,
  :interaction_mode,
  :skip_app_resign)
  include Aws::Structure
end

#project_arnString

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

Returns:

  • (String)


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 628

class CreateRemoteAccessSessionRequest < Struct.new(
  :project_arn,
  :device_arn,
  :instance_arn,
  :ssh_public_key,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :name,
  :client_id,
  :configuration,
  :interaction_mode,
  :skip_app_resign)
  include Aws::Structure
end

#remote_debug_enabledBoolean

Set to true if you want to access devices remotely for debugging in your remote access session.

Returns:

  • (Boolean)


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 628

class CreateRemoteAccessSessionRequest < Struct.new(
  :project_arn,
  :device_arn,
  :instance_arn,
  :ssh_public_key,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :name,
  :client_id,
  :configuration,
  :interaction_mode,
  :skip_app_resign)
  include Aws::Structure
end

#remote_record_app_arnString

The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.

Returns:

  • (String)


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 628

class CreateRemoteAccessSessionRequest < Struct.new(
  :project_arn,
  :device_arn,
  :instance_arn,
  :ssh_public_key,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :name,
  :client_id,
  :configuration,
  :interaction_mode,
  :skip_app_resign)
  include Aws::Structure
end

#remote_record_enabledBoolean

Set to true to enable remote recording for the remote access session.

Returns:

  • (Boolean)


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 628

class CreateRemoteAccessSessionRequest < Struct.new(
  :project_arn,
  :device_arn,
  :instance_arn,
  :ssh_public_key,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :name,
  :client_id,
  :configuration,
  :interaction_mode,
  :skip_app_resign)
  include Aws::Structure
end

#skip_app_resignBoolean

When set to true, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.

For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.

Returns:

  • (Boolean)


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 628

class CreateRemoteAccessSessionRequest < Struct.new(
  :project_arn,
  :device_arn,
  :instance_arn,
  :ssh_public_key,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :name,
  :client_id,
  :configuration,
  :interaction_mode,
  :skip_app_resign)
  include Aws::Structure
end

#ssh_public_keyString

The public key of the ssh key pair you want to use for connecting to remote devices in your remote debugging session. This is only required if remoteDebugEnabled is set to true.

Returns:

  • (String)


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 628

class CreateRemoteAccessSessionRequest < Struct.new(
  :project_arn,
  :device_arn,
  :instance_arn,
  :ssh_public_key,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :name,
  :client_id,
  :configuration,
  :interaction_mode,
  :skip_app_resign)
  include Aws::Structure
end