GameLift / Client / get_compute_auth_token

get_compute_auth_token#

GameLift.Client.get_compute_auth_token(**kwargs)#

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

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 authorization token for.

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 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 you are requesting the authorization token for.

    • ComputeArn (string) –

      The Amazon Resource Name ( ARN) that is assigned to a 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) –

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

    • ExpirationTimestamp (datetime) –

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

Exceptions

  • GameLift.Client.exceptions.UnauthorizedException

  • GameLift.Client.exceptions.InvalidRequestException

  • GameLift.Client.exceptions.NotFoundException

  • GameLift.Client.exceptions.InternalServiceException