Skip to content

/AWS1/IF_GML=>DEREGISTERCOMPUTE()

About DeregisterCompute

This API works with the following fleet types: Anywhere

Removes a compute resource from an Anywhere fleet. Deregistered computes can no longer host game sessions through Amazon GameLift Servers. Use this operation with an Anywhere fleet that doesn't use the Amazon GameLift Servers 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.

Method Signature

METHODS /AWS1/IF_GML~DEREGISTERCOMPUTE
  IMPORTING
    !IV_FLEETID TYPE /AWS1/GMLFLEETIDORARN OPTIONAL
    !IV_COMPUTENAME TYPE /AWS1/GMLCOMPUTENAMEORARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gmlderegcomputeoutput
  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_fleetid TYPE /AWS1/GMLFLEETIDORARN /AWS1/GMLFLEETIDORARN

A unique identifier for the fleet the compute resource is currently registered to.

iv_computename TYPE /AWS1/GMLCOMPUTENAMEORARN /AWS1/GMLCOMPUTENAMEORARN

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

RETURNING

oo_output TYPE REF TO /aws1/cl_gmlderegcomputeoutput /AWS1/CL_GMLDEREGCOMPUTEOUTPUT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

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.

DATA(lo_result) = lo_client->deregistercompute(
  iv_computename = |string|
  iv_fleetid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.