amazonka-devicefarm-1.5.0: Amazon Device Farm SDK.

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

Network.AWS.DeviceFarm.CreateRemoteAccessSession

Contents

Description

Specifies and starts a remote access session.

Synopsis

Creating a Request

createRemoteAccessSession Source #

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 true .
  • 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.
  • 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 Source #

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

See: createRemoteAccessSession smart constructor.

Instances

Eq CreateRemoteAccessSession Source # 
Data CreateRemoteAccessSession Source # 

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 Source # 
Show CreateRemoteAccessSession Source # 
Generic CreateRemoteAccessSession Source # 
Hashable CreateRemoteAccessSession Source # 
ToJSON CreateRemoteAccessSession Source # 
NFData CreateRemoteAccessSession Source # 
AWSRequest CreateRemoteAccessSession Source # 
ToQuery CreateRemoteAccessSession Source # 
ToPath CreateRemoteAccessSession Source # 
ToHeaders CreateRemoteAccessSession Source # 
type Rep CreateRemoteAccessSession Source # 
type Rep CreateRemoteAccessSession = D1 (MetaData "CreateRemoteAccessSession" "Network.AWS.DeviceFarm.CreateRemoteAccessSession" "amazonka-devicefarm-1.5.0-XwN0sn2YagFwkQSin1mYz" False) (C1 (MetaCons "CreateRemoteAccessSession'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_crasClientId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_crasSshPublicKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_crasName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_crasRemoteDebugEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_crasConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CreateRemoteAccessSessionConfiguration)))) ((:*:) (S1 (MetaSel (Just Symbol "_crasProjectARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_crasDeviceARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))
type Rs CreateRemoteAccessSession Source # 

Request Lenses

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

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

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

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

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

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

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

The configuration information for the remote access session request.

crasProjectARN :: Lens' CreateRemoteAccessSession Text Source #

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

crasDeviceARN :: Lens' CreateRemoteAccessSession Text Source #

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

Destructuring the Response

createRemoteAccessSessionResponse Source #

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:

data CreateRemoteAccessSessionResponse Source #

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

See: createRemoteAccessSessionResponse smart constructor.

Instances

Eq CreateRemoteAccessSessionResponse Source # 
Data CreateRemoteAccessSessionResponse Source # 

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 Source # 
Show CreateRemoteAccessSessionResponse Source # 
Generic CreateRemoteAccessSessionResponse Source # 
NFData CreateRemoteAccessSessionResponse Source # 
type Rep CreateRemoteAccessSessionResponse Source # 
type Rep CreateRemoteAccessSessionResponse = D1 (MetaData "CreateRemoteAccessSessionResponse" "Network.AWS.DeviceFarm.CreateRemoteAccessSession" "amazonka-devicefarm-1.5.0-XwN0sn2YagFwkQSin1mYz" False) (C1 (MetaCons "CreateRemoteAccessSessionResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_crasrsRemoteAccessSession") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RemoteAccessSession))) (S1 (MetaSel (Just Symbol "_crasrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

crasrsRemoteAccessSession :: Lens' CreateRemoteAccessSessionResponse (Maybe RemoteAccessSession) Source #

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