AWS Device Farm
API Reference (API Version 2015-06-23)

RemoteAccessSession

Represents information about the remote access session.

Contents

arn

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

Type: String

Length Constraints: Minimum length of 32.

Required: No

billingMethod

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

Type: String

Valid Values: METERED | UNMETERED

Required: No

clientId

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Required: No

created

The date and time the remote access session was created.

Type: Timestamp

Required: No

device

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

Type: Device object

Required: No

deviceMinutes

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

Type: DeviceMinutes object

Required: No

deviceUdid

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

Type: String

Required: No

endpoint

The endpoint for the remote access sesssion.

Type: String

Required: No

hostAddress

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.

Type: String

Length Constraints: Maximum length of 1024.

Required: No

instanceArn

The Amazon Resource Name (ARN) of the instance.

Type: String

Length Constraints: Minimum length of 32.

Required: No

interactionMode

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Valid Values: INTERACTIVE | NO_VIDEO | VIDEO_ONLY

Required: No

message

A message about the remote access session.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 16384.

Required: No

name

The name of the remote access session.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

remoteDebugEnabled

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

Type: Boolean

Required: No

remoteRecordAppArn

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

Type: String

Length Constraints: Minimum length of 32.

Required: No

remoteRecordEnabled

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

Type: Boolean

Required: No

result

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.

Type: String

Valid Values: PENDING | PASSED | WARNED | FAILED | SKIPPED | ERRORED | STOPPED

Required: No

skipAppResign

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.

Type: Boolean

Required: No

started

The date and time the remote access session was started.

Type: Timestamp

Required: No

status

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.

Type: String

Valid Values: PENDING | PENDING_CONCURRENCY | PENDING_DEVICE | PROCESSING | SCHEDULING | PREPARING | RUNNING | COMPLETED | STOPPING

Required: No

stopped

The date and time the remote access session was stopped.

Type: Timestamp

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: