Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DeviceFarm.CreateRemoteAccessSession

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Specifies and starts a remote access session.

Synopsis

Creating a Request

data CreateRemoteAccessSession Source #

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.
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?
instanceArn :: Maybe Text
The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.
remoteRecordEnabled :: Maybe Bool
Set to true to enable remote recording for the remote access session.
remoteRecordAppArn :: Maybe Text
The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
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.
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.
configuration :: Maybe CreateRemoteAccessSessionConfiguration
The configuration information for the remote access session request.
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.
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

Instances details

Eq CreateRemoteAccessSession Source #
Instance details Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession Methods (==) :: CreateRemoteAccessSession -> CreateRemoteAccessSession -> Bool # (/=) :: CreateRemoteAccessSession -> CreateRemoteAccessSession -> Bool #
Read CreateRemoteAccessSession Source #
Instance details Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession Methods readsPrec :: Int -> ReadS CreateRemoteAccessSession # readList :: ReadS [CreateRemoteAccessSession] # readPrec :: ReadPrec CreateRemoteAccessSession # readListPrec :: ReadPrec [CreateRemoteAccessSession] #
Show CreateRemoteAccessSession Source #
Instance details Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession Methods showsPrec :: Int -> CreateRemoteAccessSession -> ShowS # show :: CreateRemoteAccessSession -> String # showList :: [CreateRemoteAccessSession] -> ShowS #
Generic CreateRemoteAccessSession Source #
Instance details Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession Associated Types type Rep CreateRemoteAccessSession :: Type -> Type # Methods from :: CreateRemoteAccessSession -> Rep CreateRemoteAccessSession x # to :: Rep CreateRemoteAccessSession x -> CreateRemoteAccessSession #
NFData CreateRemoteAccessSession Source #
Instance details Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession Methods rnf :: CreateRemoteAccessSession -> () #
Hashable CreateRemoteAccessSession Source #
Instance details Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession Methods hashWithSalt :: Int -> CreateRemoteAccessSession -> Int # hash :: CreateRemoteAccessSession -> Int #
ToJSON CreateRemoteAccessSession Source #
Instance details Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession Methods toJSON :: CreateRemoteAccessSession -> Value # toEncoding :: CreateRemoteAccessSession -> Encoding # toJSONList :: [CreateRemoteAccessSession] -> Value # toEncodingList :: [CreateRemoteAccessSession] -> Encoding #
AWSRequest CreateRemoteAccessSession Source #
Instance details Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession Associated Types type AWSResponse CreateRemoteAccessSession # Methods request :: CreateRemoteAccessSession -> Request CreateRemoteAccessSession # response :: MonadResource m => Logger -> Service -> Proxy CreateRemoteAccessSession -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateRemoteAccessSession))) #
ToHeaders CreateRemoteAccessSession Source #
Instance details Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession Methods toHeaders :: CreateRemoteAccessSession -> [Header] #
ToPath CreateRemoteAccessSession Source #
Instance details Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession Methods toPath :: CreateRemoteAccessSession -> ByteString #
ToQuery CreateRemoteAccessSession Source #
Instance details Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession Methods toQuery :: CreateRemoteAccessSession -> QueryString #
type Rep CreateRemoteAccessSession Source #
Instance details Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession type Rep CreateRemoteAccessSession = D1 ('MetaData "CreateRemoteAccessSession" "Amazonka.DeviceFarm.CreateRemoteAccessSession" "libZSservicesZSamazonka-devicefarmZSamazonka-devicefarm" 'False) (C1 ('MetaCons "CreateRemoteAccessSession'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientId") '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 "remoteRecordEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "remoteRecordAppArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sshPublicKey") '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 "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateRemoteAccessSessionConfiguration)))) :: (S1 ('MetaSel ('Just "interactionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InteractionMode)) :: (S1 ('MetaSel ('Just "projectArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "deviceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CreateRemoteAccessSession Source #
Instance details Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession type AWSResponse CreateRemoteAccessSession = CreateRemoteAccessSessionResponse

newCreateRemoteAccessSession Source #

Arguments

:: Text	`$sel:projectArn:CreateRemoteAccessSession'`
-> Text	`$sel:deviceArn: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:

$sel:clientId: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:skipAppResign: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:instanceArn:CreateRemoteAccessSession', createRemoteAccessSession_instanceArn - The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.

$sel:remoteRecordEnabled:CreateRemoteAccessSession', createRemoteAccessSession_remoteRecordEnabled - Set to true to enable remote recording for the remote access session.

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

$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:name:CreateRemoteAccessSession', createRemoteAccessSession_name - The name of the remote access session to create.

$sel:remoteDebugEnabled: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.

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

$sel:interactionMode: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.

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

$sel:deviceArn: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) Source #

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

createRemoteAccessSession_instanceArn :: Lens' CreateRemoteAccessSession (Maybe Text) Source #

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

createRemoteAccessSession_remoteRecordEnabled :: Lens' CreateRemoteAccessSession (Maybe Bool) Source #

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

createRemoteAccessSession_remoteRecordAppArn :: Lens' CreateRemoteAccessSession (Maybe Text) Source #

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

createRemoteAccessSession_sshPublicKey :: Lens' CreateRemoteAccessSession (Maybe Text) Source #

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

The name of the remote access session to create.

createRemoteAccessSession_remoteDebugEnabled :: Lens' CreateRemoteAccessSession (Maybe Bool) Source #

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

Remote debugging is no longer supported.

createRemoteAccessSession_configuration :: Lens' CreateRemoteAccessSession (Maybe CreateRemoteAccessSessionConfiguration) Source #

The configuration information for the remote access session request.

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

createRemoteAccessSession_projectArn :: Lens' CreateRemoteAccessSession Text Source #

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

createRemoteAccessSession_deviceArn :: Lens' CreateRemoteAccessSession Text Source #

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

Destructuring the Response

data CreateRemoteAccessSessionResponse Source #

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

Instances details

Eq CreateRemoteAccessSessionResponse Source #
Instance details Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession Methods (==) :: CreateRemoteAccessSessionResponse -> CreateRemoteAccessSessionResponse -> Bool # (/=) :: CreateRemoteAccessSessionResponse -> CreateRemoteAccessSessionResponse -> Bool #
Read CreateRemoteAccessSessionResponse Source #
Instance details Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession Methods readsPrec :: Int -> ReadS CreateRemoteAccessSessionResponse # readList :: ReadS [CreateRemoteAccessSessionResponse] # readPrec :: ReadPrec CreateRemoteAccessSessionResponse # readListPrec :: ReadPrec [CreateRemoteAccessSessionResponse] #
Show CreateRemoteAccessSessionResponse Source #
Instance details Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession Methods showsPrec :: Int -> CreateRemoteAccessSessionResponse -> ShowS # show :: CreateRemoteAccessSessionResponse -> String # showList :: [CreateRemoteAccessSessionResponse] -> ShowS #
Generic CreateRemoteAccessSessionResponse Source #
Instance details Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession Associated Types type Rep CreateRemoteAccessSessionResponse :: Type -> Type # Methods from :: CreateRemoteAccessSessionResponse -> Rep CreateRemoteAccessSessionResponse x # to :: Rep CreateRemoteAccessSessionResponse x -> CreateRemoteAccessSessionResponse #
NFData CreateRemoteAccessSessionResponse Source #
Instance details Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession Methods rnf :: CreateRemoteAccessSessionResponse -> () #
type Rep CreateRemoteAccessSessionResponse Source #
Instance details Defined in Amazonka.DeviceFarm.CreateRemoteAccessSession type Rep CreateRemoteAccessSessionResponse = D1 ('MetaData "CreateRemoteAccessSessionResponse" "Amazonka.DeviceFarm.CreateRemoteAccessSession" "libZSservicesZSamazonka-devicefarmZSamazonka-devicefarm" '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 Source #

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

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

createRemoteAccessSessionResponse_httpStatus :: Lens' CreateRemoteAccessSessionResponse Int Source #

The response's http status code.