GameLift / Client / get_instance_access

get_instance_access#

GameLift.Client.get_instance_access(**kwargs)#

Requests authorization to remotely connect to an instance in an Amazon GameLift managed fleet. Use this operation to connect to instances with game servers that use Amazon GameLift server SDK 4.x or earlier. To connect to instances with game servers that use server SDK 5.x or later, call 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

Remotely connect to fleet instances

Debug fleet issues

Related actions

All APIs by task

See also: AWS API Documentation

Request Syntax

response = client.get_instance_access(
    FleetId='string',
    InstanceId='string'
)
Parameters:

  • FleetId (string) –

    [REQUIRED]

    A unique identifier for the fleet that contains the instance you want to access. You can request access to instances in EC2 fleets with the following statuses: ACTIVATING, ACTIVE, or ERROR. Use either a fleet ID or an ARN value.

    Note

    You can access fleets in ERROR status for a short period of time before Amazon GameLift deletes them.

  • InstanceId (string) –

    [REQUIRED]

    A unique identifier for the instance you want to access. You can access an instance in any status.

Return type:

dict

Returns:

Response Syntax

{
    'InstanceAccess': {
        'FleetId': 'string',
        'InstanceId': 'string',
        'IpAddress': 'string',
        'OperatingSystem': 'WINDOWS_2012'|'AMAZON_LINUX'|'AMAZON_LINUX_2'|'WINDOWS_2016'|'AMAZON_LINUX_2023',
        'Credentials': {
            'UserName': 'string',
            'Secret': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • InstanceAccess (dict) –

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

      • FleetId (string) –

        A unique identifier for the fleet containing the instance to be accessed.

      • InstanceId (string) –

        A unique identifier for the instance to be accessed.

      • IpAddress (string) –

        IP address assigned to the instance.

      • OperatingSystem (string) –

        Operating system that is running on the instance.

      • Credentials (dict) –

        Security credentials that are required to access the instance.

        • UserName (string) –

          A user name for logging in.

        • Secret (string) –

          Secret string. For Windows instances, the secret is a password for use with Windows Remote Desktop. For Linux instances, it’s a private key for use with SSH.

Exceptions