Amazonka.DeviceFarm.Types.RemoteAccessSession

Documentation

data RemoteAccessSession

Represents information about the remote access session.

See: newRemoteAccessSession smart constructor.

Constructors

RemoteAccessSession'

Fields

• arn :: Maybe Text

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

• billingMethod :: Maybe 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.

• clientId :: Maybe Text

  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.

• created :: Maybe POSIX

  The date and time the remote access session was created.

• device :: Maybe Device

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

• deviceMinutes :: Maybe DeviceMinutes

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

• deviceUdid :: Maybe Text

  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.

• endpoint :: Maybe Text

  The endpoint for the remote access sesssion.

• hostAddress :: Maybe Text

  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.

• instanceArn :: Maybe Text

  The ARN of the instance.

• interactionMode :: Maybe 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.
• message :: Maybe Text

  A message about the remote access session.

• name :: Maybe Text

  The name of the remote access session.

• remoteDebugEnabled :: Maybe Bool

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

  Remote debugging is no longer supported.

• remoteRecordAppArn :: Maybe Text

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

• remoteRecordEnabled :: Maybe Bool

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

• result :: Maybe ExecutionResult

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

  • PENDING.
  • PASSED.
  • WARNED.
  • FAILED.
  • SKIPPED.
  • ERRORED.
  • STOPPED.
• skipAppResign :: Maybe Bool

  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.

• started :: Maybe POSIX

  The date and time the remote access session was started.

• status :: Maybe ExecutionStatus

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

  • PENDING.
  • PENDING_CONCURRENCY.
  • PENDING_DEVICE.
  • PROCESSING.
  • SCHEDULING.
  • PREPARING.
  • RUNNING.
  • COMPLETED.
  • STOPPING.
• stopped :: Maybe POSIX

  The date and time the remote access session was stopped.

• vpcConfig :: Maybe VpcConfig

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

Instances

FromJSON RemoteAccessSession

Defined in Amazonka.DeviceFarm.Types.RemoteAccessSession

Methods

parseJSON :: Value -> Parser RemoteAccessSession

parseJSONList :: Value -> Parser [RemoteAccessSession]

Generic RemoteAccessSession

Defined in Amazonka.DeviceFarm.Types.RemoteAccessSession

Associated Types

type Rep RemoteAccessSession :: Type -> Type

Methods

from :: RemoteAccessSession -> Rep RemoteAccessSession x

to :: Rep RemoteAccessSession x -> RemoteAccessSession

Read RemoteAccessSession

Defined in Amazonka.DeviceFarm.Types.RemoteAccessSession

Methods

readsPrec :: Int -> ReadS RemoteAccessSession

readList :: ReadS [RemoteAccessSession]

readPrec :: ReadPrec RemoteAccessSession

readListPrec :: ReadPrec [RemoteAccessSession]

Show RemoteAccessSession

Defined in Amazonka.DeviceFarm.Types.RemoteAccessSession

Methods

showsPrec :: Int -> RemoteAccessSession -> ShowS

show :: RemoteAccessSession -> String

showList :: [RemoteAccessSession] -> ShowS

NFData RemoteAccessSession

Defined in Amazonka.DeviceFarm.Types.RemoteAccessSession

Methods

rnf :: RemoteAccessSession -> ()

Eq RemoteAccessSession

Defined in Amazonka.DeviceFarm.Types.RemoteAccessSession

Methods

(==) :: RemoteAccessSession -> RemoteAccessSession -> Bool

(/=) :: RemoteAccessSession -> RemoteAccessSession -> Bool

Hashable RemoteAccessSession

Defined in Amazonka.DeviceFarm.Types.RemoteAccessSession

Methods

hashWithSalt :: Int -> RemoteAccessSession -> Int

hash :: RemoteAccessSession -> Int

type Rep RemoteAccessSession

Defined in Amazonka.DeviceFarm.Types.RemoteAccessSession

type Rep RemoteAccessSession = D1 ('MetaData "RemoteAccessSession" "Amazonka.DeviceFarm.Types.RemoteAccessSession" "amazonka-devicefarm-2.0-2e4KvZvQ9bT8TNjEPvmW9Q" 'False) (C1 ('MetaCons "RemoteAccessSession'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "billingMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BillingMethod))) :*: (S1 ('MetaSel ('Just "clientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "device") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Device))))) :*: ((S1 ('MetaSel ('Just "deviceMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeviceMinutes)) :*: (S1 ('MetaSel ('Just "deviceUdid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "hostAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "instanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "interactionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InteractionMode)))))) :*: (((S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "remoteDebugEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "remoteRecordAppArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "remoteRecordEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "result") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionResult)) :*: (S1 ('MetaSel ('Just "skipAppResign") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "started") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionStatus)) :*: (S1 ('MetaSel ('Just "stopped") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig))))))))

newRemoteAccessSession :: RemoteAccessSession

Create a value of RemoteAccessSession with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

RemoteAccessSession, remoteAccessSession_arn - The Amazon Resource Name (ARN) of the remote access session.

$sel:billingMethod:RemoteAccessSession', remoteAccessSession_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.

$sel:clientId:RemoteAccessSession', remoteAccessSession_clientId - 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.

$sel:created:RemoteAccessSession', remoteAccessSession_created - The date and time the remote access session was created.

$sel:device:RemoteAccessSession', remoteAccessSession_device - The device (phone or tablet) used in the remote access session.

$sel:deviceMinutes:RemoteAccessSession', remoteAccessSession_deviceMinutes - The number of minutes a device is used in a remote access session (including setup and teardown minutes).

$sel:deviceUdid:RemoteAccessSession', remoteAccessSession_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.

$sel:endpoint:RemoteAccessSession', remoteAccessSession_endpoint - The endpoint for the remote access sesssion.

$sel:hostAddress:RemoteAccessSession', remoteAccessSession_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.

Remote debugging is no longer supported.

$sel:instanceArn:RemoteAccessSession', remoteAccessSession_instanceArn - The ARN of the instance.

$sel:interactionMode:RemoteAccessSession', remoteAccessSession_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.

$sel:message:RemoteAccessSession', remoteAccessSession_message - A message about the remote access session.

RemoteAccessSession, remoteAccessSession_name - The name of the remote access session.

RemoteAccessSession, remoteAccessSession_remoteDebugEnabled - This flag is set to true if remote debugging is enabled for the remote access session.

Remote debugging is no longer supported.

$sel:remoteRecordAppArn:RemoteAccessSession', remoteAccessSession_remoteRecordAppArn - The ARN for the app to be recorded in the remote access session.

$sel:remoteRecordEnabled:RemoteAccessSession', remoteAccessSession_remoteRecordEnabled - This flag is set to true if remote recording is enabled for the remote access session.

$sel:result:RemoteAccessSession', remoteAccessSession_result - The result of the remote access session. Can be any of the following:

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

$sel:skipAppResign:RemoteAccessSession', remoteAccessSession_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.

$sel:started:RemoteAccessSession', remoteAccessSession_started - The date and time the remote access session was started.

$sel:status:RemoteAccessSession', remoteAccessSession_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.

$sel:stopped:RemoteAccessSession', remoteAccessSession_stopped - The date and time the remote access session was stopped.

$sel:vpcConfig:RemoteAccessSession', remoteAccessSession_vpcConfig - The VPC security groups and subnets that are attached to a project.

remoteAccessSession_arn :: Lens' RemoteAccessSession (Maybe Text)

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

remoteAccessSession_billingMethod :: Lens' RemoteAccessSession (Maybe 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.

remoteAccessSession_clientId :: Lens' RemoteAccessSession (Maybe Text)

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.

remoteAccessSession_created :: Lens' RemoteAccessSession (Maybe UTCTime)

The date and time the remote access session was created.

remoteAccessSession_device :: Lens' RemoteAccessSession (Maybe Device)

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

remoteAccessSession_deviceMinutes :: Lens' RemoteAccessSession (Maybe DeviceMinutes)

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

remoteAccessSession_deviceUdid :: Lens' RemoteAccessSession (Maybe Text)

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.

remoteAccessSession_endpoint :: Lens' RemoteAccessSession (Maybe Text)

The endpoint for the remote access sesssion.

remoteAccessSession_hostAddress :: Lens' RemoteAccessSession (Maybe Text)

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.

remoteAccessSession_instanceArn :: Lens' RemoteAccessSession (Maybe Text)

The ARN of the instance.

remoteAccessSession_interactionMode :: Lens' RemoteAccessSession (Maybe 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.

remoteAccessSession_message :: Lens' RemoteAccessSession (Maybe Text)

A message about the remote access session.

remoteAccessSession_name :: Lens' RemoteAccessSession (Maybe Text)

The name of the remote access session.

remoteAccessSession_remoteDebugEnabled :: Lens' RemoteAccessSession (Maybe Bool)

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

Remote debugging is no longer supported.

remoteAccessSession_remoteRecordAppArn :: Lens' RemoteAccessSession (Maybe Text)

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

remoteAccessSession_remoteRecordEnabled :: Lens' RemoteAccessSession (Maybe Bool)

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

remoteAccessSession_result :: Lens' RemoteAccessSession (Maybe ExecutionResult)

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

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

remoteAccessSession_skipAppResign :: Lens' RemoteAccessSession (Maybe Bool)

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.

remoteAccessSession_started :: Lens' RemoteAccessSession (Maybe UTCTime)

The date and time the remote access session was started.

remoteAccessSession_status :: Lens' RemoteAccessSession (Maybe ExecutionStatus)

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

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

remoteAccessSession_stopped :: Lens' RemoteAccessSession (Maybe UTCTime)

The date and time the remote access session was stopped.

remoteAccessSession_vpcConfig :: Lens' RemoteAccessSession (Maybe VpcConfig)

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