GetInstanceAccess (smaws-clients.Smaws_Client

Module Smaws_Client_GameLift.GetInstanceAccess

This API works with the following fleet types: EC2

Requests authorization to remotely connect to an instance in an Amazon GameLift Servers managed fleet. Use this operation to connect to instances with game servers that use Amazon GameLift Servers server SDK 4.x or earlier. To connect to instances with game servers that use server SDK 5.x or later, call https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetComputeAccess.

To request access to an instance, specify IDs for the instance and the fleet it belongs to. You can retrieve instance IDs for a fleet by calling DescribeInstances with the fleet ID.

If successful, this operation returns an IP address and credentials. The returned credentials match the operating system of the instance, as follows:

For a Windows instance: returns a user name and secret (password) for use with a Windows Remote Desktop client.

For a Linux instance: returns a user name and secret (RSA private key) for use with an SSH client. You must save the secret to a .pem file. If you're using the CLI, see the example Get credentials for a Linux instance for tips on automatically saving the secret to a .pem file.

Learn more

Related actions

val error_to_string : 
  [ Smaws_Lib.Protocols.AwsJson.error
  | `InternalServiceException of Types.internal_service_exception
  | `InvalidRequestException of Types.invalid_request_exception
  | `NotFoundException of Types.not_found_exception
  | `UnauthorizedException of Types.unauthorized_exception ] ->
  string

val request : 
  'http_type Smaws_Lib.Context.t ->
  Types.get_instance_access_input ->
  (Types.get_instance_access_output,
    [> Smaws_Lib.Protocols.AwsJson.error
    | `InternalServiceException of Types.internal_service_exception
    | `InvalidRequestException of Types.invalid_request_exception
    | `NotFoundException of Types.not_found_exception
    | `UnauthorizedException of Types.unauthorized_exception ])
    Stdlib.result

val request_with_metadata : 
  'http_type Smaws_Lib.Context.t ->
  Types.get_instance_access_input ->
  (Types.get_instance_access_output Smaws_Lib.Response.t,
    [> Smaws_Lib.Protocols.AwsJson.error
    | `InternalServiceException of Types.internal_service_exception
    | `InvalidRequestException of Types.invalid_request_exception
    | `NotFoundException of Types.not_found_exception
    | `UnauthorizedException of Types.unauthorized_exception ]
    * Smaws_Lib.Response.metadata)
    Stdlib.result