GetComputeAuthToken - Amazon GameLift
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

GetComputeAuthToken

Requests an authentication token from Amazon GameLift for a registered compute in an Anywhere fleet. The game servers that are running on the compute use this token to authenticate with the Amazon GameLift service. Each server process must provide a valid authentication token in its call to the Amazon GameLift server SDK action InitSDK().

Authentication tokens are valid for a limited time span. Use a mechanism to regularly request a fresh authentication token before the current token expires.

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

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

A valid temporary authentication token.

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 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 name of the compute resource that the authentication token is issued to.

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.

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

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: