AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This operation is used with the Amazon 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

Amazon GameLift FleetIQ Guide

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDeregisterGameServer and EndDeregisterGameServer.

Namespace: Amazon.GameLift
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<DeregisterGameServerResponse> DeregisterGameServerAsync(
         DeregisterGameServerRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.GameLift.Model.DeregisterGameServerRequest

Container for the necessary parameters to execute the DeregisterGameServer service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the DeregisterGameServer service method, as returned by GameLift.

Exceptions

ExceptionCondition
InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
NotFoundException The requested resources was not found. The resource was either not created yet or deleted.
UnauthorizedException The client failed authentication. Clients should not retry such requests.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also