GameLift / Client / get_compute_auth_token

get_compute_auth_token#

GameLift.Client.get_compute_auth_token(**kwargs)#

Requests an authentication token from Amazon GameLift for a compute resource in an Amazon GameLift fleet. Game servers that are running on the compute use this token to communicate with the Amazon GameLift service, such as when calling the Amazon GameLift server SDK action InitSDK(). Authentication tokens are valid for a limited time span, so you need to request a fresh token before the current token expires.

Request options

  • For managed EC2 fleets (compute type EC2), auth token retrieval and refresh is handled automatically. All game servers that are running on all fleet instances have access to a valid auth token.

  • For Anywhere fleets (compute type ANYWHERE), if you’re using the Amazon GameLift Agent, auth token retrieval and refresh is handled automatically for any compute where the Agent is running. If you’re not using the Agent, create a mechanism to retrieve and refresh auth tokens for computes that are running game server processes.

Learn more

See also: AWS API Documentation

Request Syntax

response = client.get_compute_auth_token(
    FleetId='string',
    ComputeName='string'
)
Parameters:

  • FleetId (string) –

    [REQUIRED]

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

  • ComputeName (string) –

    [REQUIRED]

    The name of the compute resource you are requesting the authentication token for. For an Anywhere fleet compute, use the registered compute name. For an EC2 fleet instance, use the instance ID.

Return type:

dict

Returns:

Response Syntax

{
    'FleetId': 'string',
    'FleetArn': 'string',
    'ComputeName': 'string',
    'ComputeArn': 'string',
    'AuthToken': 'string',
    'ExpirationTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • FleetId (string) –

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

    • FleetArn (string) –

      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.

    • ComputeName (string) –

      The name of the compute resource that the authentication token is issued to.

    • ComputeArn (string) –

      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.

    • AuthToken (string) –

      A valid temporary authentication token.

    • ExpirationTimestamp (datetime) –

      The amount of time until the authentication token is no longer valid.

Exceptions

  • GameLift.Client.exceptions.UnauthorizedException

  • GameLift.Client.exceptions.InvalidRequestException

  • GameLift.Client.exceptions.NotFoundException

  • GameLift.Client.exceptions.InternalServiceException

  • GameLift.Client.exceptions.UnsupportedRegionException