Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . gamelift ]

deregister-game-server

Description

This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.

Removes the game server resource from the game server group. As a result of this action, the de-registered game server can no longer be claimed and will not returned in a list of active game servers.

To de-register a game server, specify the game server group and game server ID. If successful, this action emits a CloudWatch event with termination time stamp and reason.

Learn more

GameLift FleetIQ Guide

Related operations

  • RegisterGameServer
  • ListGameServers
  • ClaimGameServer
  • DescribeGameServer
  • UpdateGameServer
  • DeregisterGameServer

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  deregister-game-server
--game-server-group-name <value>
--game-server-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--game-server-group-name (string)

An identifier for the game server group where the game server to be de-registered is running. Use either the GameServerGroup name or ARN value.

--game-server-id (string)

The identifier for the game server to be de-registered.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

None