v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14104474602.4 KB

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

To remotely access an instance, you need credentials that match the operating system of the instance. For a Windows instance, Amazon GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, Amazon GameLift returns a user name 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 CLI, saving the secret can be handled as part of the GetInstanceAccess request, as shown in one of the examples for this operation.

To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to.

Learn more

Remotely Access Fleet Instances

Debug Fleet Issues

post/#X-Amz-Target=GameLift.GetComputeAccess

Headers

X-Amz-Target'GameLift.GetComputeAccess' required

Request body

FleetIdstring required

A unique identifier for the fleet that the compute resource is registered to.

ComputeNamestring required

The name of the compute resource you are requesting credentials for.

Response

Success

FleetIdstring

The fleet ID of compute resource.

FleetArnstring

The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.

ComputeNamestring

The name of the compute resource you requested credentials for.

ComputeArnstring

The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift compute resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.