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
  ssh_public_key: "SshPublicKey",
  remote_debug_enabled: false,
  name: "Name",
  client_id: "ClientId",
  configuration: {
    billing_method: "METERED", # accepts METERED, UNMETERED
  },
}

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 true.

Returns:

  • (String)


498
499
500
501
502
503
504
505
506
507
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 498

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

#configurationTypes::CreateRemoteAccessSessionConfiguration

The configuration information for the remote access session request.



498
499
500
501
502
503
504
505
506
507
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 498

class CreateRemoteAccessSessionRequest < Struct.new(
  :project_arn,
  :device_arn,
  :ssh_public_key,
  :remote_debug_enabled,
  :name,
  :client_id,
  :configuration)
  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)


498
499
500
501
502
503
504
505
506
507
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 498

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

#nameString

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

Returns:

  • (String)


498
499
500
501
502
503
504
505
506
507
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 498

class CreateRemoteAccessSessionRequest < Struct.new(
  :project_arn,
  :device_arn,
  :ssh_public_key,
  :remote_debug_enabled,
  :name,
  :client_id,
  :configuration)
  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)


498
499
500
501
502
503
504
505
506
507
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 498

class CreateRemoteAccessSessionRequest < Struct.new(
  :project_arn,
  :device_arn,
  :ssh_public_key,
  :remote_debug_enabled,
  :name,
  :client_id,
  :configuration)
  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)


498
499
500
501
502
503
504
505
506
507
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 498

class CreateRemoteAccessSessionRequest < Struct.new(
  :project_arn,
  :device_arn,
  :ssh_public_key,
  :remote_debug_enabled,
  :name,
  :client_id,
  :configuration)
  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)


498
499
500
501
502
503
504
505
506
507
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 498

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