STOPINSTANCE()`¶

About StopInstance¶

Stops a specific Amazon Lightsail instance that is currently running.

When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.

The stop instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.

Method Signature¶

METHODS /AWS1/IF_LSA~STOPINSTANCE
  IMPORTING
    !IV_INSTANCENAME TYPE /AWS1/LSARESOURCENAME OPTIONAL
    !IV_FORCE TYPE /AWS1/LSABOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lsastopinstanceresult
  RAISING
    /AWS1/CX_LSAACCESSDENIEDEX
    /AWS1/CX_LSAACCTSETUPINPRGSSEX
    /AWS1/CX_LSAINVALIDINPUTEX
    /AWS1/CX_LSANOTFOUNDEXCEPTION
    /AWS1/CX_LSAOPERATIONFAILUREEX
    /AWS1/CX_LSARGNSETUPINPRGSSEX
    /AWS1/CX_LSASERVICEEXCEPTION
    /AWS1/CX_LSAUNAUTHNTCTDEX
    /AWS1/CX_LSACLIENTEXC
    /AWS1/CX_LSASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_instancename` `TYPE /AWS1/LSARESOURCENAME` `/AWS1/LSARESOURCENAME`¶

The name of the instance (a virtual private server) to stop.

Optional arguments:¶

`iv_force` `TYPE /AWS1/LSABOOLEAN` `/AWS1/LSABOOLEAN`¶

When set to True, forces a Lightsail instance that is stuck in a stopping state to stop.

Only use the force parameter if your instance is stuck in the stopping state. In any other state, your instance should stop normally without adding this parameter to your API request.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_lsastopinstanceresult` `/AWS1/CL_LSASTOPINSTANCERESULT`¶

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->stopinstance(
  iv_force = ABAP_TRUE
  iv_instancename = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_operations( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_nonemptystring = lo_row_1->get_id( ).
      lv_resourcename = lo_row_1->get_resourcename( ).
      lv_resourcetype = lo_row_1->get_resourcetype( ).
      lv_isodate = lo_row_1->get_createdat( ).
      lo_resourcelocation = lo_row_1->get_location( ).
      IF lo_resourcelocation IS NOT INITIAL.
        lv_string = lo_resourcelocation->get_availabilityzone( ).
        lv_regionname = lo_resourcelocation->get_regionname( ).
      ENDIF.
      lv_boolean = lo_row_1->get_isterminal( ).
      lv_string = lo_row_1->get_operationdetails( ).
      lv_operationtype = lo_row_1->get_operationtype( ).
      lv_operationstatus = lo_row_1->get_status( ).
      lv_isodate = lo_row_1->get_statuschangedat( ).
      lv_string = lo_row_1->get_errorcode( ).
      lv_string = lo_row_1->get_errordetails( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_LSA=>STOPINSTANCE()¶