Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetComputeAccess

Requests authorization to remotely connect to a hosting resource in a Amazon GameLift managed fleet. This operation is not used with Amazon GameLift Anywhere fleets.

Request options

To request access to a compute, specify the compute name and the fleet ID.

Results

If successful, this operation returns a set of temporary AWS credentials, including a two-part access key and a session token.

With a managed EC2 fleet (where compute type is EC2), 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.
With a managed container fleet, use these credentials and the target value with SSM to connect to the fleet instance where the container is running. When connected to the instance, use Docker commands to interact with the container using the container name and runtime ID.

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. For an EC2 fleet compute, use the instance ID. For a container fleet, use the compute name. Use https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListCompute.html to retrieve compute identifiers.

Type: String

Length Constraints: Maximum length of 1024.

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

Required: Yes

FleetId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

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

Required: Yes

Response Syntax


{
   "ComputeArn": "string",
   "ComputeName": "string",
   "ContainerIdentifiers": [ 
      { 
         "ContainerName": "string",
         "ContainerRuntimeId": "string"
      }
   ],
   "Credentials": { 
      "AccessKeyId": "string",
      "SecretAccessKey": "string",
      "SessionToken": "string"
   },
   "FleetArn": "string",
   "FleetId": "string",
   "Target": "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\-]+(\/[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\-]+(\/[a-zA-Z0-9\-]+)?$|^arn:.*:compute\/[a-zA-Z0-9\-]+(\/[a-zA-Z0-9\-]+)?

ContainerIdentifiers

For a managed container fleet, a list of containers on the compute. Use the container runtime ID with Docker commands to connect to a specific container.

Type: Array of ContainerIdentifier objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

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

Length Constraints: Minimum length of 1. Maximum length of 512.

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

FleetId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

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

Target

The instance ID where the compute resource is running.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 400.

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

UnsupportedRegionException

The requested operation is not supported in the Region specified.

HTTP Status Code: 400