AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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, GameLift returns a user name and password
as strings for use with a Windows Remote Desktop client. For a Linux instance, 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. You can retrieve a fleet's instance IDs by calling DescribeInstances.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginGetInstanceAccess and EndGetInstanceAccess.
public abstract Task<GetInstanceAccessResponse> GetInstanceAccessAsync( GetInstanceAccessRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the GetInstanceAccess service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
|InternalServiceException||The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.|
|InvalidRequestException||One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.|
|NotFoundException||THe requested resources was not found. The resource was either not created yet or deleted.|
|UnauthorizedException||The client failed authentication. Clients should not retry such requests.|
.NET Core App:
Supported in: 3.1
Supported in: 2.0
Supported in: 4.5