Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetComputeAuthToken

Requests an authentication token from Amazon GameLift. The authentication token is used by your game server to authenticate with Amazon GameLift. Each authentication token has an expiration time. To continue using the compute resource to host your game server, regularly retrieve a new authorization token.

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

The name of the compute resource you are requesting the authentication token for.

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 the compute is registered to.

Type: String

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

Required: Yes

Response Syntax


{
   "AuthToken": "string",
   "ComputeArn": "string",
   "ComputeName": "string",
   "ExpirationTimestamp": number,
   "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.

AuthToken

The authentication token that your game server uses to authenticate with Amazon GameLift.

Type: String

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

Pattern: ^[a-zA-Z0-9\-]+

ComputeArn

The Amazon Resource Name (ARN) that is assigned to a 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 name of the compute resource you are requesting the authentication token for.

Type: String

Length Constraints: Maximum length of 1024.

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

ExpirationTimestamp

The amount of time until the authentication token is no longer valid. To continue using the compute resource for game server hosting, renew the authentication token by using this operation again.

Type: Timestamp

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

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

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