RemoteAccessSession - AWS Device Farm Documentation

RemoteAccessSession

Represents information about the remote access session.

Contents

appUpload

The ARN for the app to be installed onto your device.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 1011.

Pattern: ^arn:aws:devicefarm:.+

Required: No

arn

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

Type: String

Length Constraints: Minimum length of 32. Maximum length of 1011.

Pattern: ^arn:aws:devicefarm:.+

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

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 session (including setup and teardown minutes).

Type: DeviceMinutes object

Required: No

deviceProxy

The device proxy configured for the remote access session.

Type: DeviceProxy object

Required: No

deviceUdid

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.

Type: String

Required: No

endpoint

The endpoint for the remote access session. This field is deprecated, and is replaced by the new endpoints.interactiveEndpoint field.

Type: String

Required: No

endpoints

Represents the remote endpoints for viewing and controlling a device during a remote access session.

Type: RemoteAccessEndpoints object

Required: No

instanceArn

The ARN of the instance.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 1011.

Pattern: ^arn:aws:devicefarm:.+

Required: No

interactionMode

This member has been deprecated.

The interaction mode of the remote access session. Changing the interactive mode of remote access sessions is no longer available.

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

result

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

  • PENDING.

  • PASSED.

  • WARNED.

  • FAILED.

  • SKIPPED.

  • ERRORED.

  • STOPPED.

Type: String

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

Required: No

skipAppResign

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

  • PENDING_CONCURRENCY.

  • PENDING_DEVICE.

  • PROCESSING.

  • SCHEDULING.

  • PREPARING.

  • RUNNING.

  • COMPLETED.

  • STOPPING.

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

vpcConfig

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

Type: VpcConfig object

Required: No

See Also

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