GameLift / Client / deregister_compute

deregister_compute#

GameLift.Client.deregister_compute(**kwargs)#

Removes a compute resource from an Anywhere fleet. Deregistered computes can no longer host game sessions through Amazon GameLift. Use this operation with an Anywhere fleet that doesn’t use the Amazon GameLift Agent For Anywhere fleets with the Agent, the Agent handles all compute registry tasks for you.

To deregister a compute, call this operation from the compute that’s being deregistered and specify the compute name and the fleet ID.

Request Syntax

response = client.deregister_compute(
    FleetId='string',
    ComputeName='string'
)

Parameters:

FleetId (string) –
[REQUIRED]

A unique identifier for the fleet the compute resource is currently registered to.
ComputeName (string) –
[REQUIRED]

The unique identifier of the compute resource to deregister. For an Anywhere fleet compute, use the registered compute name.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

GameLift.Client.exceptions.UnauthorizedException
GameLift.Client.exceptions.InvalidRequestException
GameLift.Client.exceptions.NotFoundException
GameLift.Client.exceptions.InternalServiceException