Copyright | (c) 2013-2017 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 |
Language | Haskell2010 |
Specifies and starts a remote access session.
- createRemoteAccessSession :: Text -> Text -> CreateRemoteAccessSession
- data CreateRemoteAccessSession
- crasClientId :: Lens' CreateRemoteAccessSession (Maybe Text)
- crasSshPublicKey :: Lens' CreateRemoteAccessSession (Maybe Text)
- crasName :: Lens' CreateRemoteAccessSession (Maybe Text)
- crasRemoteDebugEnabled :: Lens' CreateRemoteAccessSession (Maybe Bool)
- crasConfiguration :: Lens' CreateRemoteAccessSession (Maybe CreateRemoteAccessSessionConfiguration)
- crasProjectARN :: Lens' CreateRemoteAccessSession Text
- crasDeviceARN :: Lens' CreateRemoteAccessSession Text
- createRemoteAccessSessionResponse :: Int -> CreateRemoteAccessSessionResponse
- data CreateRemoteAccessSessionResponse
- crasrsRemoteAccessSession :: Lens' CreateRemoteAccessSessionResponse (Maybe RemoteAccessSession)
- crasrsResponseStatus :: Lens' CreateRemoteAccessSessionResponse Int
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 sameclientId
value in each call toCreateRemoteAccessSession
. This is required only ifremoteDebugEnabled
is set to truetrue
.crasSshPublicKey
- The public key of thessh
key pair you want to use for connecting to remote devices in your remote debugging session. This is only required ifremoteDebugEnabled
is set totrue
.crasName
- The name of the remote access session that you wish to create.crasRemoteDebugEnabled
- Set totrue
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.
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:
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 Source #
Represents the server response from a request to create a remote access session.
See: createRemoteAccessSessionResponse
smart constructor.
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.
crasrsResponseStatus :: Lens' CreateRemoteAccessSessionResponse Int Source #
- - | The response status code.