Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetComputeAccess

Requests authorization to remotely connect to a compute resource in an Amazon GameLift fleet. Call this action to connect to an instance in a managed EC2 fleet if the fleet's game build uses Amazon GameLift server SDK 5.x or later. To connect to instances with game builds that use server SDK 4.x or earlier, call GetInstanceAccess.

To request access to a compute, identify the specific EC2 instance and the fleet it belongs to. You can retrieve instances for a managed EC2 fleet by calling ListCompute.

If successful, this operation returns a set of temporary AWS credentials, including a two-part access key and a session token. Use these credentials with Amazon EC2 Systems Manager (SSM) to start a session with the compute. For more details, see Starting a session (AWS CLI) in the Amazon EC2 Systems Manager User Guide.

Learn more

Remotely connect to fleet instances

Debug fleet issues

Request Syntax


{
   "ComputeName": "string",
   "FleetId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

ComputeName

A unique identifier for the compute resource that you want to connect to. You can use either a registered compute name or an instance ID.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: [a-zA-Z0-9\-]+|^arn:.*:compute\/[a-zA-Z0-9\-]+

Required: Yes

FleetId

A unique identifier for the fleet that contains the compute resource you want to connect to. You can use either the fleet ID or ARN value.

Type: String

Pattern: ^fleet-\S+|^arn:.*:fleet\/fleet-\S+

Required: Yes

Response Syntax


{
   "ComputeArn": "string",
   "ComputeName": "string",
   "Credentials": { 
      "AccessKeyId": "string",
      "SecretAccessKey": "string",
      "SessionToken": "string"
   },
   "FleetArn": "string",
   "FleetId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ComputeArn

The Amazon Resource Name (ARN) that is assigned to an Amazon GameLift compute resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: ^arn:.*:compute\/[a-zA-Z0-9\-]+

ComputeName

The identifier of the compute resource to be accessed. This value might be either a compute name or an instance ID.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: [a-zA-Z0-9\-]+|^arn:.*:compute\/[a-zA-Z0-9\-]+

Credentials

A set of temporary AWS credentials for use when connecting to the compute resource with Amazon EC2 Systems Manager (SSM).

Type: AwsCredentials object

FleetArn

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

Type: String

Pattern: ^arn:.*:fleet\/fleet-\S+

FleetId

The ID of the fleet that contains the compute resource to be accessed.

Type: String

Pattern: ^fleet-\S+|^arn:.*:fleet\/fleet-\S+

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

HTTP Status Code: 500

InvalidRequestException

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

HTTP Status Code: 400

NotFoundException

The requested resources was not found. The resource was either not created yet or deleted.

HTTP Status Code: 400

UnauthorizedException

The client failed authentication. Clients should not retry such requests.

HTTP Status Code: 400