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

Inherits:

Struct

• Object
• Struct
• Aws::DeviceFarm::Types::RemoteAccessSession

Includes:

Structure

Defined in:

lib/aws-sdk-devicefarm/types.rb

Overview

Represents information about the remote access session.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

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

• #billing_method ⇒ String

  The billing method of the remote access session.

• #client_id ⇒ String

  Unique identifier of your client for the remote access session.

• #created ⇒ Time

  The date and time the remote access session was created.

• #device ⇒ Types::Device

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

• #device_minutes ⇒ Types::DeviceMinutes

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

• #device_udid ⇒ String

  Unique device identifier for the remote device.

• #endpoint ⇒ String

  The endpoint for the remote access sesssion.

• #host_address ⇒ String

  IP address of the EC2 host where you need to connect to remotely debug devices.

• #instance_arn ⇒ String

  The ARN of the instance.

• #interaction_mode ⇒ String

  The interaction mode of the remote access session.

• #message ⇒ String

  A message about the remote access session.

• #name ⇒ String

  The name of the remote access session.

• #remote_debug_enabled ⇒ Boolean

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

• #remote_record_app_arn ⇒ String

  The ARN for the app to be recorded in the remote access session.

• #remote_record_enabled ⇒ Boolean

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

• #result ⇒ String

  The result of the remote access session.

• #skip_app_resign ⇒ Boolean

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

• #started ⇒ Time

  The date and time the remote access session was started.

• #status ⇒ String

  The status of the remote access session.

• #stopped ⇒ Time

  The date and time the remote access session was stopped.

• #vpc_config ⇒ Types::VpcConfig

  The VPC security groups and subnets that are attached to a project.

Instance Attribute Details

#arn ⇒ String

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

Returns:

• (String)

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

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

#billing_method ⇒ String

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

[1]: docs.aws.amazon.com/devicefarm/latest/developerguide/welcome.html#welcome-terminology

Returns:

• (String)

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

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

#client_id ⇒ String

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

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 4408

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

#created ⇒ Time

The date and time the remote access session was created.

Returns:

• (Time)

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

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

#device ⇒ Types::Device

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

Returns:

• (Types::Device)

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

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

#device_minutes ⇒ Types::DeviceMinutes

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

Returns:

• (Types::DeviceMinutes)

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

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

#device_udid ⇒ String

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

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 4408

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

#endpoint ⇒ String

The endpoint for the remote access sesssion.

Returns:

• (String)

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

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

#host_address ⇒ String

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.

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 4408

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

#instance_arn ⇒ String

The ARN of the instance.

Returns:

• (String)

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

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

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

#message ⇒ String

A message about the remote access session.

Returns:

• (String)

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

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

#name ⇒ String

The name of the remote access session.

Returns:

• (String)

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

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

#remote_debug_enabled ⇒ Boolean

This flag is set to ‘true` if remote debugging is enabled for the 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 4408

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

#remote_record_app_arn ⇒ String

The ARN for the app to be recorded in the remote access session.

Returns:

• (String)

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

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

#remote_record_enabled ⇒ Boolean

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

Returns:

• (Boolean)

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

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

#result ⇒ String

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

• PENDING.

• PASSED.

• WARNED.

• FAILED.

• SKIPPED.

• ERRORED.

• STOPPED.

Returns:

• (String)

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

class RemoteAccessSession < Struct.new(
  :arn,
  :name,
  :created,
  :status,
  :result,
  :message,
  :started,
  :stopped,
  :device,
  :instance_arn,
  :remote_debug_enabled,
  :remote_record_enabled,
  :remote_record_app_arn,
  :host_address,
  :client_id,
  :billing_method,
  :device_minutes,
  :endpoint,
  :device_udid,
  :interaction_mode,
  :skip_app_resign,
  :vpc_config)
  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 about how Device Farm re-signs your apps, see

Do you modify my app?][1

in the *AWS Device Farm FAQs*.

[1]: aws.amazon.com/device-farm/faqs/

Returns:

• (Boolean)

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

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

#started ⇒ Time

The date and time the remote access session was started.

Returns:

• (Time)

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

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

#status ⇒ String

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

• PENDING.

• PENDING_CONCURRENCY.

• PENDING_DEVICE.

• PROCESSING.

• SCHEDULING.

• PREPARING.

• RUNNING.

• COMPLETED.

• STOPPING.

Returns:

• (String)

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

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

#stopped ⇒ Time

The date and time the remote access session was stopped.

Returns:

• (Time)

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

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

#vpc_config ⇒ Types::VpcConfig

The VPC security groups and subnets that are attached to a project.

Returns:

• (Types::VpcConfig)

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

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