amazonka-gamelift-1.4.5: Amazon GameLift SDK.

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

Network.AWS.GameLift.GetInstanceAccess

Contents

Description

Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or watching activity in real time.

Access requires credentials that match the operating system of the instance. For a Windows instance, GameLift returns a username and password as strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift returns a username and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you're making this request using the AWS CLI, saving the secret can be handled as part of the GetInstanceAccess request (see the example later in this topic). For more information on remote access, see Remotely Accessing an Instance .

To request access to a specific instance, specify the IDs of the instance and the fleet it belongs to. If successful, an InstanceAccess object is returned containing the instance's IP address and a set of credentials.

Synopsis

Creating a Request

getInstanceAccess #

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

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

  • giaFleetId - Unique identifier for a fleet. Specify the fleet that contain the instance you want access to. The fleet can be in any of the following statuses: ACTIVATING, ACTIVE, or ERROR. Fleets with an ERROR status can be accessed for a few hours before being deleted.
  • giaInstanceId - Unique identifier for an instance. Specify the instance you want to get access to. You can access an instance in any status.

data GetInstanceAccess #

See: getInstanceAccess smart constructor.

Instances

Eq GetInstanceAccess # 
Data GetInstanceAccess # 

Methods

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

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

toConstr :: GetInstanceAccess -> Constr #

dataTypeOf :: GetInstanceAccess -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetInstanceAccess) #

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

gmapT :: (forall b. Data b => b -> b) -> GetInstanceAccess -> GetInstanceAccess #

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

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

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

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

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

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

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

Read GetInstanceAccess # 
Show GetInstanceAccess # 
Generic GetInstanceAccess # 
Hashable GetInstanceAccess # 
ToJSON GetInstanceAccess # 
NFData GetInstanceAccess # 

Methods

rnf :: GetInstanceAccess -> () #

AWSRequest GetInstanceAccess # 
ToQuery GetInstanceAccess # 
ToPath GetInstanceAccess # 
ToHeaders GetInstanceAccess # 
type Rep GetInstanceAccess # 
type Rep GetInstanceAccess = D1 (MetaData "GetInstanceAccess" "Network.AWS.GameLift.GetInstanceAccess" "amazonka-gamelift-1.4.5-90oxfPbG0dmH3SoKqzJqw8" False) (C1 (MetaCons "GetInstanceAccess'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_giaFleetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_giaInstanceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs GetInstanceAccess # 

Request Lenses

giaFleetId :: Lens' GetInstanceAccess Text #

Unique identifier for a fleet. Specify the fleet that contain the instance you want access to. The fleet can be in any of the following statuses: ACTIVATING, ACTIVE, or ERROR. Fleets with an ERROR status can be accessed for a few hours before being deleted.

giaInstanceId :: Lens' GetInstanceAccess Text #

Unique identifier for an instance. Specify the instance you want to get access to. You can access an instance in any status.

Destructuring the Response

getInstanceAccessResponse #

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

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

data GetInstanceAccessResponse #

See: getInstanceAccessResponse smart constructor.

Instances

Eq GetInstanceAccessResponse # 
Data GetInstanceAccessResponse # 

Methods

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

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

toConstr :: GetInstanceAccessResponse -> Constr #

dataTypeOf :: GetInstanceAccessResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetInstanceAccessResponse) #

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

gmapT :: (forall b. Data b => b -> b) -> GetInstanceAccessResponse -> GetInstanceAccessResponse #

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

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

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

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

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

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

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

Read GetInstanceAccessResponse # 
Show GetInstanceAccessResponse # 
Generic GetInstanceAccessResponse # 
NFData GetInstanceAccessResponse # 
type Rep GetInstanceAccessResponse # 
type Rep GetInstanceAccessResponse = D1 (MetaData "GetInstanceAccessResponse" "Network.AWS.GameLift.GetInstanceAccess" "amazonka-gamelift-1.4.5-90oxfPbG0dmH3SoKqzJqw8" False) (C1 (MetaCons "GetInstanceAccessResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_giarsInstanceAccess") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe InstanceAccess))) (S1 (MetaSel (Just Symbol "_giarsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

giarsInstanceAccess :: Lens' GetInstanceAccessResponse (Maybe InstanceAccess) #

Object containing connection information for a fleet instance, including IP address and access credentials.

giarsResponseStatus :: Lens' GetInstanceAccessResponse Int #

  • - | The response status code.