# DeregisterGameServer
<a name="API_DeregisterGameServer"></a>

 **This API works with the following fleet types:** EC2 (FleetIQ)

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** 

 [Amazon GameLift Servers FleetIQ Guide](https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) 

## Request Syntax
<a name="API_DeregisterGameServer_RequestSyntax"></a>

```
{
   "GameServerGroupName": "string",
   "GameServerId": "string"
}
```

## Request Parameters
<a name="API_DeregisterGameServer_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [GameServerGroupName](#API_DeregisterGameServer_RequestSyntax) **   <a name="gameliftservers-DeregisterGameServer-request-GameServerGroupName"></a>
A unique identifier for the game server group where the game server is running.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9-\.]+|^arn:.*:gameservergroup\/[a-zA-Z0-9-\.]+`   
Required: Yes

 ** [GameServerId](#API_DeregisterGameServer_RequestSyntax) **   <a name="gameliftservers-DeregisterGameServer-request-GameServerId"></a>
A custom string that uniquely identifies the game server to deregister.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `[a-zA-Z0-9-\.]+`   
Required: Yes

## Response Elements
<a name="API_DeregisterGameServer_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeregisterGameServer_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## Examples
<a name="API_DeregisterGameServer_Examples"></a>

### Remove a game server from active status
<a name="API_DeregisterGameServer_Example_1"></a>

This example deregisters a game server so that it can no longer be claimed for gameplay.

#### Sample Request
<a name="API_DeregisterGameServer_Example_1_Request"></a>

```
{
   "GameServerGroupName": "MegaFrogServers_NA",
   "GameServerId": "mega-frog-game-12345678"
}

CLI command:

aws gamelift deregister-game-server \
    --game-server-group-name MegaFrogServers_NA \
    --GameServerId mega-frog-game-12345678
```

## See Also
<a name="API_DeregisterGameServer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/gamelift-2015-10-01/DeregisterGameServer) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/gamelift-2015-10-01/DeregisterGameServer) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/gamelift-2015-10-01/DeregisterGameServer) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/gamelift-2015-10-01/DeregisterGameServer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/gamelift-2015-10-01/DeregisterGameServer) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/gamelift-2015-10-01/DeregisterGameServer) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/gamelift-2015-10-01/DeregisterGameServer) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/gamelift-2015-10-01/DeregisterGameServer) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/gamelift-2015-10-01/DeregisterGameServer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/gamelift-2015-10-01/DeregisterGameServer)