STARTSERVICESOFTWAREUPDATE()`¶

About StartServiceSoftwareUpdate¶

Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

Method Signature¶

METHODS /AWS1/IF_OSR~STARTSERVICESOFTWAREUPDATE
  IMPORTING
    !IV_DOMAINNAME TYPE /AWS1/OSRDOMAINNAME OPTIONAL
    !IV_SCHEDULEAT TYPE /AWS1/OSRSCHEDULEAT OPTIONAL
    !IV_DESIREDSTARTTIME TYPE /AWS1/OSRLONG OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_osrstrtsvcsoftwareu01
  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`¶

The name of the domain that you want to update to the latest service software.

Optional arguments:¶

`iv_scheduleat` `TYPE /AWS1/OSRSCHEDULEAT` `/AWS1/OSRSCHEDULEAT`¶

When to start the service software update.

NOW - Immediately schedules the update to happen in the current hour if there's capacity available.

TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.

OFF_PEAK_WINDOW - Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.

Default: NOW if you don't specify a value for DesiredStartTime, and TIMESTAMP if you do.

`iv_desiredstarttime` `TYPE /AWS1/OSRLONG` `/AWS1/OSRLONG`¶

The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_osrstrtsvcsoftwareu01` `/AWS1/CL_OSRSTRTSVCSOFTWAREU01`¶

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->startservicesoftwareupdate(
  iv_desiredstarttime = 123
  iv_domainname = |string|
  iv_scheduleat = |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.

/AWS1/IF_OSR=>STARTSERVICESOFTWAREUPDATE()¶