/AWS1/IF_OSR=>CANCELSERVICESOFTWAREUPDATE()

About CancelServiceSoftwareUpdate

Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain's UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.

Method Signature

METHODS /AWS1/IF_OSR~CANCELSERVICESOFTWAREUPDATE
  IMPORTING
    !IV_DOMAINNAME TYPE /AWS1/OSRDOMAINNAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_osrcancsvcsoftwareu01
  RAISING
    /AWS1/CX_OSRBASEEXCEPTION
    /AWS1/CX_OSRINTERNALEXCEPTION
    /AWS1/CX_OSRRESOURCENOTFOUNDEX
    /AWS1/CX_OSRVALIDATIONEX
    /AWS1/CX_OSRCLIENTEXC
    /AWS1/CX_OSRSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_domainname TYPE /AWS1/OSRDOMAINNAME /AWS1/OSRDOMAINNAME

Name of the OpenSearch Service domain that you want to cancel the service software update on.

RETURNING

oo_output TYPE REF TO /aws1/cl_osrcancsvcsoftwareu01 /AWS1/CL_OSRCANCSVCSOFTWAREU01

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->cancelservicesoftwareupdate( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_servicesoftwareoptions = lo_result->get_servicesoftwareoptions( ).
  IF lo_servicesoftwareoptions IS NOT INITIAL.
    lv_string = lo_servicesoftwareoptions->get_currentversion( ).
    lv_string = lo_servicesoftwareoptions->get_newversion( ).
    lv_boolean = lo_servicesoftwareoptions->get_updateavailable( ).
    lv_boolean = lo_servicesoftwareoptions->get_cancellable( ).
    lv_deploymentstatus = lo_servicesoftwareoptions->get_updatestatus( ).
    lv_string = lo_servicesoftwareoptions->get_description( ).
    lv_deploymentclosedatetime = lo_servicesoftwareoptions->get_automatedupdatedate( ).
    lv_boolean = lo_servicesoftwareoptions->get_optionaldeployment( ).
  ENDIF.
ENDIF.