/AWS1/IF_GML=>DEREGISTERGAMESERVER()

About DeregisterGameServer

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

Method Signature

METHODS /AWS1/IF_GML~DEREGISTERGAMESERVER
  IMPORTING
    !IV_GAMESERVERGROUPNAME TYPE /AWS1/GMLGAMESERVERGRNAMEORARN OPTIONAL
    !IV_GAMESERVERID TYPE /AWS1/GMLGAMESERVERID OPTIONAL
  RAISING
    /AWS1/CX_GMLINTERNALSERVICEEX
    /AWS1/CX_GMLINVALIDREQUESTEX
    /AWS1/CX_GMLNOTFOUNDEXCEPTION
    /AWS1/CX_GMLUNAUTHORIZEDEX
    /AWS1/CX_GMLCLIENTEXC
    /AWS1/CX_GMLSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_gameservergroupname TYPE /AWS1/GMLGAMESERVERGRNAMEORARN /AWS1/GMLGAMESERVERGRNAMEORARN

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

iv_gameserverid TYPE /AWS1/GMLGAMESERVERID /AWS1/GMLGAMESERVERID

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

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

lo_client->deregistergameserver(
  iv_gameservergroupname = |string|
  iv_gameserverid = |string|
).