GameLift / Client / deregister_game_server

deregister_game_server#

GameLift.Client.deregister_game_server(**kwargs)#

This operation is used with the GameLift FleetIQ solution and game server groups.

Removes the game server from a game server group. As a result of this operation, the deregistered game server can no longer be claimed and will not be returned in a list of active game servers.

To deregister a game server, specify the game server group and game server ID. If successful, this operation emits a CloudWatch event with termination timestamp and reason.

Learn more

GameLift FleetIQ Guide

See also: AWS API Documentation

Request Syntax

response = client.deregister_game_server(
    GameServerGroupName='string',
    GameServerId='string'
)
Parameters:

  • GameServerGroupName (string) –

    [REQUIRED]

    A unique identifier for the game server group where the game server is running.

  • GameServerId (string) –

    [REQUIRED]

    A custom string that uniquely identifies the game server to deregister.

Returns:

None

Exceptions

  • GameLift.Client.exceptions.InvalidRequestException

  • GameLift.Client.exceptions.NotFoundException

  • GameLift.Client.exceptions.UnauthorizedException

  • GameLift.Client.exceptions.InternalServiceException