Amazonka.DeviceFarm.CreateRemoteAccessSession

Specifies and starts a remote access session.

Creating a Request

data CreateRemoteAccessSession

Creates and submits a request to start a remote access session.

See: newCreateRemoteAccessSession smart constructor.

Constructors

CreateRemoteAccessSession'

Fields

• clientId :: Maybe Text

  Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same clientId value in each call to CreateRemoteAccessSession. This identifier is required only if remoteDebugEnabled is set to true.

  Remote debugging is no longer supported.

• configuration :: Maybe CreateRemoteAccessSessionConfiguration

  The configuration information for the remote access session request.

• instanceArn :: Maybe Text

  The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.

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

  The name of the remote access session to create.

• remoteDebugEnabled :: Maybe Bool

  Set to true if you want to access devices remotely for debugging in your remote access session.

  Remote debugging is no longer supported.

• remoteRecordAppArn :: Maybe Text

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

• remoteRecordEnabled :: Maybe Bool

  Set to true to enable remote recording for the remote access session.

• 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 on how Device Farm modifies your uploads during tests, see Do you modify my app?

• sshPublicKey :: Maybe Text

  Ignored. The public key of the ssh key pair you want to use for connecting to remote devices in your remote debugging session. This key is required only if remoteDebugEnabled is set to true.

  Remote debugging is no longer supported.

• projectArn :: Text

  The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.

• deviceArn :: Text

  The ARN of the device for which you want to create a remote access session.

Instances

ToJSON CreateRemoteAccessSession

Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession

Methods

toJSON :: CreateRemoteAccessSession -> Value

toEncoding :: CreateRemoteAccessSession -> Encoding

toJSONList :: [CreateRemoteAccessSession] -> Value

toEncodingList :: [CreateRemoteAccessSession] -> Encoding

ToHeaders CreateRemoteAccessSession

Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession

Methods

toHeaders :: CreateRemoteAccessSession -> [Header]

ToPath CreateRemoteAccessSession

Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession

Methods

toPath :: CreateRemoteAccessSession -> ByteString

ToQuery CreateRemoteAccessSession

Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession

Methods

toQuery :: CreateRemoteAccessSession -> QueryString

AWSRequest CreateRemoteAccessSession

Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession

Associated Types

type AWSResponse CreateRemoteAccessSession

Methods

request :: (Service -> Service) -> CreateRemoteAccessSession -> Request CreateRemoteAccessSession

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateRemoteAccessSession -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateRemoteAccessSession)))

Generic CreateRemoteAccessSession

Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession

Associated Types

type Rep CreateRemoteAccessSession :: Type -> Type

Methods

from :: CreateRemoteAccessSession -> Rep CreateRemoteAccessSession x

to :: Rep CreateRemoteAccessSession x -> CreateRemoteAccessSession

Read CreateRemoteAccessSession

Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession

Methods

readsPrec :: Int -> ReadS CreateRemoteAccessSession

readList :: ReadS [CreateRemoteAccessSession]

readPrec :: ReadPrec CreateRemoteAccessSession

readListPrec :: ReadPrec [CreateRemoteAccessSession]

Show CreateRemoteAccessSession

Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession

Methods

showsPrec :: Int -> CreateRemoteAccessSession -> ShowS

show :: CreateRemoteAccessSession -> String

showList :: [CreateRemoteAccessSession] -> ShowS

NFData CreateRemoteAccessSession

Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession

Methods

rnf :: CreateRemoteAccessSession -> ()

Eq CreateRemoteAccessSession

Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession

Methods

(==) :: CreateRemoteAccessSession -> CreateRemoteAccessSession -> Bool

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

Hashable CreateRemoteAccessSession

Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession

Methods

hashWithSalt :: Int -> CreateRemoteAccessSession -> Int

hash :: CreateRemoteAccessSession -> Int

type AWSResponse CreateRemoteAccessSession

Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession

type AWSResponse CreateRemoteAccessSession = CreateRemoteAccessSessionResponse

type Rep CreateRemoteAccessSession

Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession

type Rep CreateRemoteAccessSession = D1 ('MetaData "CreateRemoteAccessSession" "Amazonka.DeviceFarm.CreateRemoteAccessSession" "amazonka-devicefarm-2.0-2e4KvZvQ9bT8TNjEPvmW9Q" 'False) (C1 ('MetaCons "CreateRemoteAccessSession'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateRemoteAccessSessionConfiguration)) :*: S1 ('MetaSel ('Just "instanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "interactionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InteractionMode)) :*: (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 "skipAppResign") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "sshPublicKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "projectArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "deviceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateRemoteAccessSession

Arguments

:: Text

$sel:projectArn:CreateRemoteAccessSession'

-> Text

CreateRemoteAccessSession

-> CreateRemoteAccessSession

Create a value of CreateRemoteAccessSession 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:

CreateRemoteAccessSession, createRemoteAccessSession_clientId - Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same clientId value in each call to CreateRemoteAccessSession. This identifier is required only if remoteDebugEnabled is set to true.

Remote debugging is no longer supported.

$sel:configuration:CreateRemoteAccessSession', createRemoteAccessSession_configuration - The configuration information for the remote access session request.

CreateRemoteAccessSession, createRemoteAccessSession_instanceArn - The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.

CreateRemoteAccessSession, createRemoteAccessSession_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.

CreateRemoteAccessSession, createRemoteAccessSession_name - The name of the remote access session to create.

CreateRemoteAccessSession, createRemoteAccessSession_remoteDebugEnabled - Set to true if you want to access devices remotely for debugging in your remote access session.

Remote debugging is no longer supported.

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

CreateRemoteAccessSession, createRemoteAccessSession_remoteRecordEnabled - Set to true to enable remote recording for the remote access session.

CreateRemoteAccessSession, createRemoteAccessSession_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 on how Device Farm modifies your uploads during tests, see Do you modify my app?

$sel:sshPublicKey:CreateRemoteAccessSession', createRemoteAccessSession_sshPublicKey - Ignored. The public key of the ssh key pair you want to use for connecting to remote devices in your remote debugging session. This key is required only if remoteDebugEnabled is set to true.

Remote debugging is no longer supported.

$sel:projectArn:CreateRemoteAccessSession', createRemoteAccessSession_projectArn - The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.

CreateRemoteAccessSession, createRemoteAccessSession_deviceArn - The ARN of the device for which you want to create a remote access session.

Request Lenses

createRemoteAccessSession_clientId :: Lens' CreateRemoteAccessSession (Maybe Text)

Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same clientId value in each call to CreateRemoteAccessSession. This identifier is required only if remoteDebugEnabled is set to true.

Remote debugging is no longer supported.

createRemoteAccessSession_configuration :: Lens' CreateRemoteAccessSession (Maybe CreateRemoteAccessSessionConfiguration)

The configuration information for the remote access session request.

createRemoteAccessSession_instanceArn :: Lens' CreateRemoteAccessSession (Maybe Text)

The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.

createRemoteAccessSession_interactionMode :: Lens' CreateRemoteAccessSession (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.

createRemoteAccessSession_name :: Lens' CreateRemoteAccessSession (Maybe Text)

The name of the remote access session to create.

createRemoteAccessSession_remoteDebugEnabled :: Lens' CreateRemoteAccessSession (Maybe Bool)

Set to true if you want to access devices remotely for debugging in your remote access session.

Remote debugging is no longer supported.

createRemoteAccessSession_remoteRecordAppArn :: Lens' CreateRemoteAccessSession (Maybe Text)

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

createRemoteAccessSession_remoteRecordEnabled :: Lens' CreateRemoteAccessSession (Maybe Bool)

Set to true to enable remote recording for the remote access session.

createRemoteAccessSession_skipAppResign :: Lens' CreateRemoteAccessSession (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 on how Device Farm modifies your uploads during tests, see Do you modify my app?

createRemoteAccessSession_sshPublicKey :: Lens' CreateRemoteAccessSession (Maybe Text)

Ignored. The public key of the ssh key pair you want to use for connecting to remote devices in your remote debugging session. This key is required only if remoteDebugEnabled is set to true.

Remote debugging is no longer supported.

createRemoteAccessSession_projectArn :: Lens' CreateRemoteAccessSession Text

The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.

createRemoteAccessSession_deviceArn :: Lens' CreateRemoteAccessSession Text

The ARN of the device for which you want to create a remote access session.

Destructuring the Response

data CreateRemoteAccessSessionResponse

Represents the server response from a request to create a remote access session.

See: newCreateRemoteAccessSessionResponse smart constructor.

Constructors

CreateRemoteAccessSessionResponse'

Fields

• remoteAccessSession :: Maybe RemoteAccessSession

  A container that describes the remote access session when the request to create a remote access session is sent.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateRemoteAccessSessionResponse

Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession

Associated Types

type Rep CreateRemoteAccessSessionResponse :: Type -> Type

Methods

from :: CreateRemoteAccessSessionResponse -> Rep CreateRemoteAccessSessionResponse x

to :: Rep CreateRemoteAccessSessionResponse x -> CreateRemoteAccessSessionResponse

Read CreateRemoteAccessSessionResponse

Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession

Methods

readsPrec :: Int -> ReadS CreateRemoteAccessSessionResponse

readList :: ReadS [CreateRemoteAccessSessionResponse]

readPrec :: ReadPrec CreateRemoteAccessSessionResponse

readListPrec :: ReadPrec [CreateRemoteAccessSessionResponse]

Show CreateRemoteAccessSessionResponse

Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession

Methods

showsPrec :: Int -> CreateRemoteAccessSessionResponse -> ShowS

show :: CreateRemoteAccessSessionResponse -> String

showList :: [CreateRemoteAccessSessionResponse] -> ShowS

NFData CreateRemoteAccessSessionResponse

Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession

Methods

rnf :: CreateRemoteAccessSessionResponse -> ()

Eq CreateRemoteAccessSessionResponse

Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession

Methods

(==) :: CreateRemoteAccessSessionResponse -> CreateRemoteAccessSessionResponse -> Bool

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

type Rep CreateRemoteAccessSessionResponse

Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession

type Rep CreateRemoteAccessSessionResponse = D1 ('MetaData "CreateRemoteAccessSessionResponse" "Amazonka.DeviceFarm.CreateRemoteAccessSession" "amazonka-devicefarm-2.0-2e4KvZvQ9bT8TNjEPvmW9Q" 'False) (C1 ('MetaCons "CreateRemoteAccessSessionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "remoteAccessSession") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RemoteAccessSession)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateRemoteAccessSessionResponse

Arguments

:: Int

$sel:httpStatus:CreateRemoteAccessSessionResponse'

-> CreateRemoteAccessSessionResponse

Create a value of CreateRemoteAccessSessionResponse 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:remoteAccessSession:CreateRemoteAccessSessionResponse', createRemoteAccessSessionResponse_remoteAccessSession - A container that describes the remote access session when the request to create a remote access session is sent.

$sel:httpStatus:CreateRemoteAccessSessionResponse', createRemoteAccessSessionResponse_httpStatus - The response's http status code.

Response Lenses

createRemoteAccessSessionResponse_remoteAccessSession :: Lens' CreateRemoteAccessSessionResponse (Maybe RemoteAccessSession)

A container that describes the remote access session when the request to create a remote access session is sent.

createRemoteAccessSessionResponse_httpStatus :: Lens' CreateRemoteAccessSessionResponse Int

The response's http status code.