Network.AWS.DeviceFarm.CreateRemoteAccessSession

Specifies and starts a remote access session.

Creating a Request

createRemoteAccessSession

Arguments

:: Text

crasProjectARN

-> Text

crasDeviceARN

-> CreateRemoteAccessSession

Creates a value of CreateRemoteAccessSession with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• crasClientId - 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 is required only if remoteDebugEnabled is set to true .
• crasSkipAppResign - When set to true , for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect. For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs .
• crasInstanceARN - The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.
• crasRemoteRecordEnabled - Set to true to enable remote recording for the remote access session.
• crasRemoteRecordAppARN - The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
• crasSshPublicKey - The public key of the ssh key pair you want to use for connecting to remote devices in your remote debugging session. This is only required if remoteDebugEnabled is set to true .
• crasName - The name of the remote access session that you wish to create.
• crasRemoteDebugEnabled - Set to true if you want to access devices remotely for debugging in your remote access session.
• crasConfiguration - The configuration information for the remote access session request.
• crasInteractionMode - 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.
• crasProjectARN - The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.
• crasDeviceARN - The Amazon Resource Name (ARN) of the device for which you want to create a remote access session.

data CreateRemoteAccessSession

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

See: createRemoteAccessSession smart constructor.

Instances

Eq CreateRemoteAccessSession

Defined in Network.AWS.DeviceFarm.CreateRemoteAccessSession

Methods

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

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

Data CreateRemoteAccessSession

Defined in Network.AWS.DeviceFarm.CreateRemoteAccessSession

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateRemoteAccessSession -> c CreateRemoteAccessSession

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateRemoteAccessSession

toConstr :: CreateRemoteAccessSession -> Constr

dataTypeOf :: CreateRemoteAccessSession -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateRemoteAccessSession)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateRemoteAccessSession)

gmapT :: (forall b. Data b => b -> b) -> CreateRemoteAccessSession -> CreateRemoteAccessSession

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateRemoteAccessSession -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateRemoteAccessSession -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateRemoteAccessSession -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateRemoteAccessSession -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateRemoteAccessSession -> m CreateRemoteAccessSession

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateRemoteAccessSession -> m CreateRemoteAccessSession

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateRemoteAccessSession -> m CreateRemoteAccessSession

Read CreateRemoteAccessSession

Defined in Network.AWS.DeviceFarm.CreateRemoteAccessSession

Methods

readsPrec :: Int -> ReadS CreateRemoteAccessSession

readList :: ReadS [CreateRemoteAccessSession]

readPrec :: ReadPrec CreateRemoteAccessSession

readListPrec :: ReadPrec [CreateRemoteAccessSession]

Show CreateRemoteAccessSession

Defined in Network.AWS.DeviceFarm.CreateRemoteAccessSession

Methods

showsPrec :: Int -> CreateRemoteAccessSession -> ShowS

show :: CreateRemoteAccessSession -> String

showList :: [CreateRemoteAccessSession] -> ShowS

Generic CreateRemoteAccessSession

Defined in Network.AWS.DeviceFarm.CreateRemoteAccessSession

Associated Types

type Rep CreateRemoteAccessSession :: Type -> Type

Methods

from :: CreateRemoteAccessSession -> Rep CreateRemoteAccessSession x

to :: Rep CreateRemoteAccessSession x -> CreateRemoteAccessSession

Hashable CreateRemoteAccessSession

Defined in Network.AWS.DeviceFarm.CreateRemoteAccessSession

Methods

hashWithSalt :: Int -> CreateRemoteAccessSession -> Int

hash :: CreateRemoteAccessSession -> Int

ToJSON CreateRemoteAccessSession

Defined in Network.AWS.DeviceFarm.CreateRemoteAccessSession

Methods

toJSON :: CreateRemoteAccessSession -> Value

toEncoding :: CreateRemoteAccessSession -> Encoding

toJSONList :: [CreateRemoteAccessSession] -> Value

toEncodingList :: [CreateRemoteAccessSession] -> Encoding

AWSRequest CreateRemoteAccessSession

Defined in Network.AWS.DeviceFarm.CreateRemoteAccessSession

Associated Types

type Rs CreateRemoteAccessSession :: Type

Methods

request :: CreateRemoteAccessSession -> Request CreateRemoteAccessSession

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy CreateRemoteAccessSession -> ClientResponse -> m (Response CreateRemoteAccessSession)

ToHeaders CreateRemoteAccessSession

Defined in Network.AWS.DeviceFarm.CreateRemoteAccessSession

Methods

toHeaders :: CreateRemoteAccessSession -> [Header]

ToPath CreateRemoteAccessSession

Defined in Network.AWS.DeviceFarm.CreateRemoteAccessSession

Methods

toPath :: CreateRemoteAccessSession -> ByteString

ToQuery CreateRemoteAccessSession

Defined in Network.AWS.DeviceFarm.CreateRemoteAccessSession

Methods

toQuery :: CreateRemoteAccessSession -> QueryString

NFData CreateRemoteAccessSession

Defined in Network.AWS.DeviceFarm.CreateRemoteAccessSession

Methods

rnf :: CreateRemoteAccessSession -> ()

type Rep CreateRemoteAccessSession

Defined in Network.AWS.DeviceFarm.CreateRemoteAccessSession

type Rep CreateRemoteAccessSession = D1 (MetaData "CreateRemoteAccessSession" "Network.AWS.DeviceFarm.CreateRemoteAccessSession" "amazonka-devicefarm-1.6.1-BUBE26oXCvH3OZbJddASoX" False) (C1 (MetaCons "CreateRemoteAccessSession'" PrefixI True) (((S1 (MetaSel (Just "_crasClientId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_crasSkipAppResign") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_crasInstanceARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_crasRemoteRecordEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 (MetaSel (Just "_crasRemoteRecordAppARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_crasSshPublicKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_crasName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_crasRemoteDebugEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_crasConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CreateRemoteAccessSessionConfiguration)))) :*: (S1 (MetaSel (Just "_crasInteractionMode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe InteractionMode)) :*: (S1 (MetaSel (Just "_crasProjectARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_crasDeviceARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs CreateRemoteAccessSession

Defined in Network.AWS.DeviceFarm.CreateRemoteAccessSession

type Rs CreateRemoteAccessSession = CreateRemoteAccessSessionResponse

Request Lenses

crasClientId :: 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 is required only if remoteDebugEnabled is set to true .

crasSkipAppResign :: Lens' CreateRemoteAccessSession (Maybe Bool)

When set to true , for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect. For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs .

crasInstanceARN :: Lens' CreateRemoteAccessSession (Maybe Text)

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

crasRemoteRecordEnabled :: Lens' CreateRemoteAccessSession (Maybe Bool)

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

crasRemoteRecordAppARN :: Lens' CreateRemoteAccessSession (Maybe Text)

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

crasSshPublicKey :: Lens' CreateRemoteAccessSession (Maybe Text)

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

crasName :: Lens' CreateRemoteAccessSession (Maybe Text)

The name of the remote access session that you wish to create.

crasRemoteDebugEnabled :: Lens' CreateRemoteAccessSession (Maybe Bool)

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

crasConfiguration :: Lens' CreateRemoteAccessSession (Maybe CreateRemoteAccessSessionConfiguration)

The configuration information for the remote access session request.

crasInteractionMode :: 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.

crasProjectARN :: Lens' CreateRemoteAccessSession Text

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

crasDeviceARN :: Lens' CreateRemoteAccessSession Text

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

Destructuring the Response

createRemoteAccessSessionResponse

Arguments

:: Int

crasrsResponseStatus

-> CreateRemoteAccessSessionResponse

Creates a value of CreateRemoteAccessSessionResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• crasrsRemoteAccessSession - A container that describes the remote access session when the request to create a remote access session is sent.
• crasrsResponseStatus - -- | The response status code.

data CreateRemoteAccessSessionResponse

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

See: createRemoteAccessSessionResponse smart constructor.

Instances

Eq CreateRemoteAccessSessionResponse

Defined in Network.AWS.DeviceFarm.CreateRemoteAccessSession

Methods

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

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

Data CreateRemoteAccessSessionResponse

Defined in Network.AWS.DeviceFarm.CreateRemoteAccessSession

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateRemoteAccessSessionResponse -> c CreateRemoteAccessSessionResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateRemoteAccessSessionResponse

toConstr :: CreateRemoteAccessSessionResponse -> Constr

dataTypeOf :: CreateRemoteAccessSessionResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateRemoteAccessSessionResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateRemoteAccessSessionResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateRemoteAccessSessionResponse -> CreateRemoteAccessSessionResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateRemoteAccessSessionResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateRemoteAccessSessionResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateRemoteAccessSessionResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateRemoteAccessSessionResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateRemoteAccessSessionResponse -> m CreateRemoteAccessSessionResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateRemoteAccessSessionResponse -> m CreateRemoteAccessSessionResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateRemoteAccessSessionResponse -> m CreateRemoteAccessSessionResponse

Read CreateRemoteAccessSessionResponse

Defined in Network.AWS.DeviceFarm.CreateRemoteAccessSession

Methods

readsPrec :: Int -> ReadS CreateRemoteAccessSessionResponse

readList :: ReadS [CreateRemoteAccessSessionResponse]

readPrec :: ReadPrec CreateRemoteAccessSessionResponse

readListPrec :: ReadPrec [CreateRemoteAccessSessionResponse]

Show CreateRemoteAccessSessionResponse

Defined in Network.AWS.DeviceFarm.CreateRemoteAccessSession

Methods

showsPrec :: Int -> CreateRemoteAccessSessionResponse -> ShowS

show :: CreateRemoteAccessSessionResponse -> String

showList :: [CreateRemoteAccessSessionResponse] -> ShowS

Generic CreateRemoteAccessSessionResponse

Defined in Network.AWS.DeviceFarm.CreateRemoteAccessSession

Associated Types

type Rep CreateRemoteAccessSessionResponse :: Type -> Type

Methods

from :: CreateRemoteAccessSessionResponse -> Rep CreateRemoteAccessSessionResponse x

to :: Rep CreateRemoteAccessSessionResponse x -> CreateRemoteAccessSessionResponse

NFData CreateRemoteAccessSessionResponse

Defined in Network.AWS.DeviceFarm.CreateRemoteAccessSession

Methods

rnf :: CreateRemoteAccessSessionResponse -> ()

type Rep CreateRemoteAccessSessionResponse

Defined in Network.AWS.DeviceFarm.CreateRemoteAccessSession

type Rep CreateRemoteAccessSessionResponse = D1 (MetaData "CreateRemoteAccessSessionResponse" "Network.AWS.DeviceFarm.CreateRemoteAccessSession" "amazonka-devicefarm-1.6.1-BUBE26oXCvH3OZbJddASoX" False) (C1 (MetaCons "CreateRemoteAccessSessionResponse'" PrefixI True) (S1 (MetaSel (Just "_crasrsRemoteAccessSession") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RemoteAccessSession)) :*: S1 (MetaSel (Just "_crasrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

crasrsRemoteAccessSession :: Lens' CreateRemoteAccessSessionResponse (Maybe RemoteAccessSession)

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

crasrsResponseStatus :: Lens' CreateRemoteAccessSessionResponse Int

• - | The response status code.