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

Inherits:

Struct

• Object
• Struct
• Aws::DeviceFarm::Types::CreateRemoteAccessSessionRequest

Includes:

Structure

Defined in:

lib/aws-sdk-devicefarm/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_id ⇒ String

  Unique identifier for the client.

• #configuration ⇒ Types::CreateRemoteAccessSessionConfiguration

  The configuration information for the remote access session request.

• #device_arn ⇒ String

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

• #instance_arn ⇒ String

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

• #interaction_mode ⇒ String

  The interaction mode of the remote access session.

• #name ⇒ String

  The name of the remote access session to create.

• #project_arn ⇒ String

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

• #remote_debug_enabled ⇒ Boolean

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

• #remote_record_app_arn ⇒ String

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

• #remote_record_enabled ⇒ Boolean

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

• #skip_app_resign ⇒ Boolean

  When set to ‘true`, for private devices, Device Farm does not sign your app again.

• #ssh_public_key ⇒ String

  Ignored.

Instance Attribute Details

#client_id ⇒ String

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]: docs.aws.amazon.com/devicefarm/latest/developerguide/history.html

Returns:

• (String)

# File 'lib/aws-sdk-devicefarm/types.rb', line 614

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)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ Types::CreateRemoteAccessSessionConfiguration

The configuration information for the remote access session request.

Returns:

• (Types::CreateRemoteAccessSessionConfiguration)

# File 'lib/aws-sdk-devicefarm/types.rb', line 614

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)
  SENSITIVE = []
  include Aws::Structure
end

#device_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-devicefarm/types.rb', line 614

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)
  SENSITIVE = []
  include Aws::Structure
end

#instance_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-devicefarm/types.rb', line 614

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)
  SENSITIVE = []
  include Aws::Structure
end

#interaction_mode ⇒ String

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)

# File 'lib/aws-sdk-devicefarm/types.rb', line 614

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)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the remote access session to create.

Returns:

• (String)

# File 'lib/aws-sdk-devicefarm/types.rb', line 614

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)
  SENSITIVE = []
  include Aws::Structure
end

#project_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-devicefarm/types.rb', line 614

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)
  SENSITIVE = []
  include Aws::Structure
end

#remote_debug_enabled ⇒ Boolean

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

Remote debugging is [no longer supported].

[1]: docs.aws.amazon.com/devicefarm/latest/developerguide/history.html

Returns:

• (Boolean)

# File 'lib/aws-sdk-devicefarm/types.rb', line 614

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)
  SENSITIVE = []
  include Aws::Structure
end

#remote_record_app_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-devicefarm/types.rb', line 614

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)
  SENSITIVE = []
  include Aws::Structure
end

#remote_record_enabled ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-devicefarm/types.rb', line 614

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)
  SENSITIVE = []
  include Aws::Structure
end

#skip_app_resign ⇒ Boolean

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]: aws.amazon.com/device-farm/faqs/

Returns:

• (Boolean)

# File 'lib/aws-sdk-devicefarm/types.rb', line 614

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)
  SENSITIVE = []
  include Aws::Structure
end

#ssh_public_key ⇒ String

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]: docs.aws.amazon.com/devicefarm/latest/developerguide/history.html

Returns:

• (String)

# File 'lib/aws-sdk-devicefarm/types.rb', line 614

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)
  SENSITIVE = []
  include Aws::Structure
end