GetComputeAccess
This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
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
To request access, specify the compute name and the fleet ID. If successful, this operation returns a set of temporary AWS credentials, including a two-part access key and a session token.
EC2 fleets
With an 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.
Container fleets
With a container fleet (where compute type is CONTAINER
), use
these credentials and the target value with SSM to connect to the fleet instance where
the container is running. After you're connected to the instance, use Docker commands to
interact with the container.
Learn more
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 (for example,
a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9
) or the compute ARN.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
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",
"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\-]+)?
- 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 holds the compute resource to be accessed.
Type: String
Pattern:
^fleet-\S+|^arn:.*:fleet\/fleet-\S+
- Target
-
(For container fleets only) 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: