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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)

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

#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)

    The billing method of the remote access session.

#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)

    Unique identifier of your client for the remote access session.

#createdTime

The date and time the remote access session was created.

Returns:

  • (Time)

    The date and time the remote access session was created.

#deviceTypes::Device

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

Returns:

  • (Types::Device)

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

#device_minutesTypes::DeviceMinutes

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

Returns:

  • (Types::DeviceMinutes)

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

#device_udidString

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

Returns:

  • (String)

    Unique device identifier for the remote device.

#endpointString

The endpoint for the remote access sesssion.

Returns:

  • (String)

    The endpoint for the remote access sesssion.

#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)

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

#instance_arnString

The Amazon Resource Name (ARN) of the instance.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the instance.

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

    Possible values:

    • INTERACTIVE
    • NO_VIDEO
    • VIDEO_ONLY

Returns:

  • (String)

    The interaction mode of the remote access session.

#messageString

A message about the remote access session.

Returns:

  • (String)

    A message about the remote access session.

#nameString

The name of the remote access session.

Returns:

  • (String)

    The name of the remote access session.

#remote_debug_enabledBoolean

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

Returns:

  • (Boolean)

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

#remote_record_app_arnString

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

Returns:

  • (String)

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

#remote_record_enabledBoolean

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

Returns:

  • (Boolean)

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

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

    Possible values:

    • PENDING
    • PASSED
    • WARNED
    • FAILED
    • SKIPPED
    • ERRORED
    • STOPPED

Returns:

  • (String)

    The result of the remote access session.

#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)

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

#startedTime

The date and time the remote access session was started.

Returns:

  • (Time)

    The date and time the remote access session was started.

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

    Possible values:

    • PENDING
    • PENDING_CONCURRENCY
    • PENDING_DEVICE
    • PROCESSING
    • SCHEDULING
    • PREPARING
    • RUNNING
    • COMPLETED
    • STOPPING

Returns:

  • (String)

    The status of the remote access session.

#stoppedTime

The date and time the remote access session was stopped.

Returns:

  • (Time)

    The date and time the remote access session was stopped.