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

Class: Aws::DeviceFarm::Types::RemoteAccessSession

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

Overview

Represents information about the remote access session.

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the remote access session.

Returns:

  • (String)


3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3225

class RemoteAccessSession < Struct.new(
  :arn,
  :name,
  :created,
  :status,
  :result,
  :message,
  :started,
  :stopped,
  :device,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :host_address,
  :client_id,
  :billing_method,
  :device_minutes,
  :endpoint,
  :device_udid,
  :interaction_mode)
  include Aws::Structure
end

#billing_methodString

The billing method of the remote access session. Possible values include METERED or UNMETERED. For more information about metered devices, see AWS Device Farm terminology."

Returns:

  • (String)


3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3225

class RemoteAccessSession < Struct.new(
  :arn,
  :name,
  :created,
  :status,
  :result,
  :message,
  :started,
  :stopped,
  :device,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :host_address,
  :client_id,
  :billing_method,
  :device_minutes,
  :endpoint,
  :device_udid,
  :interaction_mode)
  include Aws::Structure
end

#client_idString

Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session.

Returns:

  • (String)


3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3225

class RemoteAccessSession < Struct.new(
  :arn,
  :name,
  :created,
  :status,
  :result,
  :message,
  :started,
  :stopped,
  :device,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :host_address,
  :client_id,
  :billing_method,
  :device_minutes,
  :endpoint,
  :device_udid,
  :interaction_mode)
  include Aws::Structure
end

#createdTime

The date and time the remote access session was created.

Returns:

  • (Time)


3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3225

class RemoteAccessSession < Struct.new(
  :arn,
  :name,
  :created,
  :status,
  :result,
  :message,
  :started,
  :stopped,
  :device,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :host_address,
  :client_id,
  :billing_method,
  :device_minutes,
  :endpoint,
  :device_udid,
  :interaction_mode)
  include Aws::Structure
end

#deviceTypes::Device

The device (phone or tablet) used in the remote access session.

Returns:



3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3225

class RemoteAccessSession < Struct.new(
  :arn,
  :name,
  :created,
  :status,
  :result,
  :message,
  :started,
  :stopped,
  :device,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :host_address,
  :client_id,
  :billing_method,
  :device_minutes,
  :endpoint,
  :device_udid,
  :interaction_mode)
  include Aws::Structure
end

#device_minutesTypes::DeviceMinutes

The number of minutes a device is used in a remote access sesssion (including setup and teardown minutes).



3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3225

class RemoteAccessSession < Struct.new(
  :arn,
  :name,
  :created,
  :status,
  :result,
  :message,
  :started,
  :stopped,
  :device,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :host_address,
  :client_id,
  :billing_method,
  :device_minutes,
  :endpoint,
  :device_udid,
  :interaction_mode)
  include Aws::Structure
end

#device_udidString

Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.

Returns:

  • (String)


3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3225

class RemoteAccessSession < Struct.new(
  :arn,
  :name,
  :created,
  :status,
  :result,
  :message,
  :started,
  :stopped,
  :device,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :host_address,
  :client_id,
  :billing_method,
  :device_minutes,
  :endpoint,
  :device_udid,
  :interaction_mode)
  include Aws::Structure
end

#endpointString

The endpoint for the remote access sesssion.

Returns:

  • (String)


3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3225

class RemoteAccessSession < Struct.new(
  :arn,
  :name,
  :created,
  :status,
  :result,
  :message,
  :started,
  :stopped,
  :device,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :host_address,
  :client_id,
  :billing_method,
  :device_minutes,
  :endpoint,
  :device_udid,
  :interaction_mode)
  include Aws::Structure
end

#host_addressString

IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging is enabled for the remote access session.

Returns:

  • (String)


3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3225

class RemoteAccessSession < Struct.new(
  :arn,
  :name,
  :created,
  :status,
  :result,
  :message,
  :started,
  :stopped,
  :device,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :host_address,
  :client_id,
  :billing_method,
  :device_minutes,
  :endpoint,
  :device_udid,
  :interaction_mode)
  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)


3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3225

class RemoteAccessSession < Struct.new(
  :arn,
  :name,
  :created,
  :status,
  :result,
  :message,
  :started,
  :stopped,
  :device,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :host_address,
  :client_id,
  :billing_method,
  :device_minutes,
  :endpoint,
  :device_udid,
  :interaction_mode)
  include Aws::Structure
end

#messageString

A message about the remote access session.

Returns:

  • (String)


3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3225

class RemoteAccessSession < Struct.new(
  :arn,
  :name,
  :created,
  :status,
  :result,
  :message,
  :started,
  :stopped,
  :device,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :host_address,
  :client_id,
  :billing_method,
  :device_minutes,
  :endpoint,
  :device_udid,
  :interaction_mode)
  include Aws::Structure
end

#nameString

The name of the remote access session.

Returns:

  • (String)


3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3225

class RemoteAccessSession < Struct.new(
  :arn,
  :name,
  :created,
  :status,
  :result,
  :message,
  :started,
  :stopped,
  :device,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :host_address,
  :client_id,
  :billing_method,
  :device_minutes,
  :endpoint,
  :device_udid,
  :interaction_mode)
  include Aws::Structure
end

#remote_debug_enabledBoolean

This flag is set to true if remote debugging is enabled for the remote access session.

Returns:

  • (Boolean)


3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3225

class RemoteAccessSession < Struct.new(
  :arn,
  :name,
  :created,
  :status,
  :result,
  :message,
  :started,
  :stopped,
  :device,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :host_address,
  :client_id,
  :billing_method,
  :device_minutes,
  :endpoint,
  :device_udid,
  :interaction_mode)
  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)


3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3225

class RemoteAccessSession < Struct.new(
  :arn,
  :name,
  :created,
  :status,
  :result,
  :message,
  :started,
  :stopped,
  :device,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :host_address,
  :client_id,
  :billing_method,
  :device_minutes,
  :endpoint,
  :device_udid,
  :interaction_mode)
  include Aws::Structure
end

#remote_record_enabledBoolean

This flag is set to true if remote recording is enabled for the remote access session.

Returns:

  • (Boolean)


3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3225

class RemoteAccessSession < Struct.new(
  :arn,
  :name,
  :created,
  :status,
  :result,
  :message,
  :started,
  :stopped,
  :device,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :host_address,
  :client_id,
  :billing_method,
  :device_minutes,
  :endpoint,
  :device_udid,
  :interaction_mode)
  include Aws::Structure
end

#resultString

The result of the remote access session. Can be any of the following:

  • PENDING: A pending condition.

  • PASSED: A passing condition.

  • WARNED: A warning condition.

  • FAILED: A failed condition.

  • SKIPPED: A skipped condition.

  • ERRORED: An error condition.

  • STOPPED: A stopped condition.

Returns:

  • (String)


3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3225

class RemoteAccessSession < Struct.new(
  :arn,
  :name,
  :created,
  :status,
  :result,
  :message,
  :started,
  :stopped,
  :device,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :host_address,
  :client_id,
  :billing_method,
  :device_minutes,
  :endpoint,
  :device_udid,
  :interaction_mode)
  include Aws::Structure
end

#startedTime

The date and time the remote access session was started.

Returns:

  • (Time)


3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3225

class RemoteAccessSession < Struct.new(
  :arn,
  :name,
  :created,
  :status,
  :result,
  :message,
  :started,
  :stopped,
  :device,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :host_address,
  :client_id,
  :billing_method,
  :device_minutes,
  :endpoint,
  :device_udid,
  :interaction_mode)
  include Aws::Structure
end

#statusString

The status of the remote access session. Can be any of the following:

  • PENDING: A pending status.

  • PENDING_CONCURRENCY: A pending concurrency status.

  • PENDING_DEVICE: A pending device status.

  • PROCESSING: A processing status.

  • SCHEDULING: A scheduling status.

  • PREPARING: A preparing status.

  • RUNNING: A running status.

  • COMPLETED: A completed status.

  • STOPPING: A stopping status.

Returns:

  • (String)


3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3225

class RemoteAccessSession < Struct.new(
  :arn,
  :name,
  :created,
  :status,
  :result,
  :message,
  :started,
  :stopped,
  :device,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :host_address,
  :client_id,
  :billing_method,
  :device_minutes,
  :endpoint,
  :device_udid,
  :interaction_mode)
  include Aws::Structure
end

#stoppedTime

The date and time the remote access session was stopped.

Returns:

  • (Time)


3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3225

class RemoteAccessSession < Struct.new(
  :arn,
  :name,
  :created,
  :status,
  :result,
  :message,
  :started,
  :stopped,
  :device,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :host_address,
  :client_id,
  :billing_method,
  :device_minutes,
  :endpoint,
  :device_udid,
  :interaction_mode)
  include Aws::Structure
end