libZSservicesZSamazonka-devicefarmZSamazonka-devicefarm
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DeviceFarm.Types.RemoteAccessSession

Description

 
Synopsis

Documentation

data RemoteAccessSession Source #

Represents information about the remote access session.

See: newRemoteAccessSession smart constructor.

Constructors

RemoteAccessSession' 

Fields

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

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

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

  • instanceArn :: Maybe Text

    The ARN of the instance.

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

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

  • arn :: Maybe Text

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

  • remoteRecordAppArn :: Maybe Text

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

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

  • stopped :: Maybe POSIX

    The date and time the remote access session was stopped.

  • result :: Maybe ExecutionResult

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

    • PENDING.
    • PASSED.
    • WARNED.
    • FAILED.
    • SKIPPED.
    • ERRORED.
    • STOPPED.
  • name :: Maybe Text

    The name of 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).

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

  • endpoint :: Maybe Text

    The endpoint for the remote access sesssion.

  • message :: Maybe Text

    A message about the remote access session.

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

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

    The date and time the remote access session was started.

Instances

Instances details
Eq RemoteAccessSession Source # 
Instance details

Defined in Amazonka.DeviceFarm.Types.RemoteAccessSession

Methods

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

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

Read RemoteAccessSession Source # 
Instance details

Defined in Amazonka.DeviceFarm.Types.RemoteAccessSession

Methods

readsPrec :: Int -> ReadS RemoteAccessSession #

readList :: ReadS [RemoteAccessSession] #

readPrec :: ReadPrec RemoteAccessSession #

readListPrec :: ReadPrec [RemoteAccessSession] #

Show RemoteAccessSession Source # 
Instance details

Defined in Amazonka.DeviceFarm.Types.RemoteAccessSession

Methods

showsPrec :: Int -> RemoteAccessSession -> ShowS #

show :: RemoteAccessSession -> String #

showList :: [RemoteAccessSession] -> ShowS #

Generic RemoteAccessSession Source # 
Instance details

Defined in Amazonka.DeviceFarm.Types.RemoteAccessSession

Associated Types

type Rep RemoteAccessSession :: Type -> Type #

Methods

from :: RemoteAccessSession -> Rep RemoteAccessSession x #

to :: Rep RemoteAccessSession x -> RemoteAccessSession #

NFData RemoteAccessSession Source # 
Instance details

Defined in Amazonka.DeviceFarm.Types.RemoteAccessSession

Methods

rnf :: RemoteAccessSession -> () #

Hashable RemoteAccessSession Source # 
Instance details

Defined in Amazonka.DeviceFarm.Types.RemoteAccessSession

Methods

hashWithSalt :: Int -> RemoteAccessSession -> Int #

hash :: RemoteAccessSession -> Int #

FromJSON RemoteAccessSession Source # 
Instance details

Defined in Amazonka.DeviceFarm.Types.RemoteAccessSession

Methods

parseJSON :: Value -> Parser RemoteAccessSession #

parseJSONList :: Value -> Parser [RemoteAccessSession] #

type Rep RemoteAccessSession Source # 
Instance details

Defined in Amazonka.DeviceFarm.Types.RemoteAccessSession

type Rep RemoteAccessSession = D1 ('MetaData "RemoteAccessSession" "Amazonka.DeviceFarm.Types.RemoteAccessSession" "libZSservicesZSamazonka-devicefarmZSamazonka-devicefarm" 'False) (C1 ('MetaCons "RemoteAccessSession'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "billingMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BillingMethod)) :*: S1 ('MetaSel ('Just "clientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "deviceUdid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "skipAppResign") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "instanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionStatus)) :*: S1 ('MetaSel ('Just "remoteRecordEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "remoteRecordAppArn") '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 "stopped") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "result") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionResult)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "deviceMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeviceMinutes))))) :*: ((S1 ('MetaSel ('Just "remoteDebugEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "hostAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "interactionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InteractionMode)) :*: S1 ('MetaSel ('Just "started") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))))

newRemoteAccessSession :: RemoteAccessSession Source #

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:

$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: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: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:instanceArn:RemoteAccessSession', remoteAccessSession_instanceArn - The ARN of the instance.

$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:remoteRecordEnabled:RemoteAccessSession', remoteAccessSession_remoteRecordEnabled - This flag is set to true if remote recording is enabled for the remote access session.

$sel:arn:RemoteAccessSession', remoteAccessSession_arn - The Amazon Resource Name (ARN) of the remote access session.

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

$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:stopped:RemoteAccessSession', remoteAccessSession_stopped - The date and time the remote access session was stopped.

$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:name:RemoteAccessSession', remoteAccessSession_name - The name of 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:remoteDebugEnabled: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:endpoint:RemoteAccessSession', remoteAccessSession_endpoint - The endpoint for the remote access sesssion.

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

$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: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:started:RemoteAccessSession', remoteAccessSession_started - The date and time the remote access session was started.

remoteAccessSession_billingMethod :: Lens' RemoteAccessSession (Maybe BillingMethod) Source #

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

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_deviceUdid :: Lens' RemoteAccessSession (Maybe Text) Source #

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_skipAppResign :: Lens' RemoteAccessSession (Maybe Bool) Source #

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_instanceArn :: Lens' RemoteAccessSession (Maybe Text) Source #

The ARN of the instance.

remoteAccessSession_status :: Lens' RemoteAccessSession (Maybe ExecutionStatus) Source #

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_remoteRecordEnabled :: Lens' RemoteAccessSession (Maybe Bool) Source #

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

remoteAccessSession_arn :: Lens' RemoteAccessSession (Maybe Text) Source #

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

remoteAccessSession_remoteRecordAppArn :: Lens' RemoteAccessSession (Maybe Text) Source #

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

remoteAccessSession_created :: Lens' RemoteAccessSession (Maybe UTCTime) Source #

The date and time the remote access session was created.

remoteAccessSession_device :: Lens' RemoteAccessSession (Maybe Device) Source #

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

remoteAccessSession_stopped :: Lens' RemoteAccessSession (Maybe UTCTime) Source #

The date and time the remote access session was stopped.

remoteAccessSession_result :: Lens' RemoteAccessSession (Maybe ExecutionResult) Source #

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

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

remoteAccessSession_name :: Lens' RemoteAccessSession (Maybe Text) Source #

The name of the remote access session.

remoteAccessSession_deviceMinutes :: Lens' RemoteAccessSession (Maybe DeviceMinutes) Source #

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

remoteAccessSession_remoteDebugEnabled :: Lens' RemoteAccessSession (Maybe Bool) Source #

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

Remote debugging is no longer supported.

remoteAccessSession_endpoint :: Lens' RemoteAccessSession (Maybe Text) Source #

The endpoint for the remote access sesssion.

remoteAccessSession_message :: Lens' RemoteAccessSession (Maybe Text) Source #

A message about the remote access session.

remoteAccessSession_hostAddress :: Lens' RemoteAccessSession (Maybe Text) Source #

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_interactionMode :: Lens' RemoteAccessSession (Maybe InteractionMode) Source #

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_started :: Lens' RemoteAccessSession (Maybe UTCTime) Source #

The date and time the remote access session was started.