DEREGISTERGATEWAYINSTANCE()`¶

About DeregisterGatewayInstance¶

Deregisters an instance. Before you deregister an instance, all bridges running on the instance must be stopped. If you want to deregister an instance without stopping the bridges, you must use the --force option.

Method Signature¶

METHODS /AWS1/IF_MDX~DEREGISTERGATEWAYINSTANCE
  IMPORTING
    !IV_FORCE TYPE /AWS1/MDXBOOLEAN OPTIONAL
    !IV_GATEWAYINSTANCEARN TYPE /AWS1/MDXGATEWAYINSTANCEARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_mdxdereggwinstrsp
  RAISING
    /AWS1/CX_MDXBADREQUESTEX
    /AWS1/CX_MDXCONFLICTEXCEPTION
    /AWS1/CX_MDXFORBIDDENEXCEPTION
    /AWS1/CX_MDXINTERNALSERVERER00
    /AWS1/CX_MDXNOTFOUNDEXCEPTION
    /AWS1/CX_MDXSERVICEUNAVAILEX
    /AWS1/CX_MDXTOOMANYREQUESTSEX
    /AWS1/CX_MDXCLIENTEXC
    /AWS1/CX_MDXSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_gatewayinstancearn` `TYPE /AWS1/MDXGATEWAYINSTANCEARN` `/AWS1/MDXGATEWAYINSTANCEARN`¶

The Amazon Resource Name (ARN) of the gateway that contains the instance that you want to deregister.

Optional arguments:¶

`iv_force` `TYPE /AWS1/MDXBOOLEAN` `/AWS1/MDXBOOLEAN`¶

Force the deregistration of an instance. Force will deregister an instance, even if there are bridges running on it.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_mdxdereggwinstrsp` `/AWS1/CL_MDXDEREGGWINSTRSP`¶

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->deregistergatewayinstance(
  iv_force = ABAP_TRUE
  iv_gatewayinstancearn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_gatewayinstancearn( ).
  lv_instancestate = lo_result->get_instancestate( ).
ENDIF.

/AWS1/IF_MDX=>DEREGISTERGATEWAYINSTANCE()¶