Skip to content

/AWS1/IF_SSM=>UPDATEMAINTENANCEWINDOW()

About UpdateMaintenanceWindow

Updates an existing maintenance window. Only specified parameters are modified.

The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.

Method Signature

METHODS /AWS1/IF_SSM~UPDATEMAINTENANCEWINDOW
  IMPORTING
    !IV_WINDOWID TYPE /AWS1/SSMMAINTENANCEWINDOWID OPTIONAL
    !IV_NAME TYPE /AWS1/SSMMAINTENANCEWINDOWNAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/SSMMAINTENANCEWINDOWDESC OPTIONAL
    !IV_STARTDATE TYPE /AWS1/SSMMAINTENANCEWINDOWST00 OPTIONAL
    !IV_ENDDATE TYPE /AWS1/SSMMAINTENANCEWINDOWST00 OPTIONAL
    !IV_SCHEDULE TYPE /AWS1/SSMMAINTENANCEWINDOWSCHD OPTIONAL
    !IV_SCHEDULETIMEZONE TYPE /AWS1/SSMMAINTENANCEWINDOWTI00 OPTIONAL
    !IV_SCHEDULEOFFSET TYPE /AWS1/SSMMAINTENANCEWINDOWOFF OPTIONAL
    !IV_DURATION TYPE /AWS1/SSMMAINTENANCEWINDOWDU00 OPTIONAL
    !IV_CUTOFF TYPE /AWS1/SSMMAINTENANCEWINDOWCU00 OPTIONAL
    !IV_ALLOWUNASSOCIATEDTARGETS TYPE /AWS1/SSMMAINTENANCEWINDOWAL00 OPTIONAL
    !IV_ENABLED TYPE /AWS1/SSMMAINTENANCEWINDOWENBD OPTIONAL
    !IV_REPLACE TYPE /AWS1/SSMBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ssmupmaintenancewin01
  RAISING
    /AWS1/CX_SSMDOESNOTEXISTEX
    /AWS1/CX_SSMINTERNALSERVERERR
    /AWS1/CX_SSMCLIENTEXC
    /AWS1/CX_SSMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_windowid TYPE /AWS1/SSMMAINTENANCEWINDOWID /AWS1/SSMMAINTENANCEWINDOWID

The ID of the maintenance window to update.

Optional arguments:

iv_name TYPE /AWS1/SSMMAINTENANCEWINDOWNAME /AWS1/SSMMAINTENANCEWINDOWNAME

The name of the maintenance window.

iv_description TYPE /AWS1/SSMMAINTENANCEWINDOWDESC /AWS1/SSMMAINTENANCEWINDOWDESC

An optional description for the update request.

iv_startdate TYPE /AWS1/SSMMAINTENANCEWINDOWST00 /AWS1/SSMMAINTENANCEWINDOWST00

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.

When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start date.

iv_enddate TYPE /AWS1/SSMMAINTENANCEWINDOWST00 /AWS1/SSMMAINTENANCEWINDOWST00

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.

iv_schedule TYPE /AWS1/SSMMAINTENANCEWINDOWSCHD /AWS1/SSMMAINTENANCEWINDOWSCHD

The schedule of the maintenance window in the form of a cron or rate expression.

iv_scheduletimezone TYPE /AWS1/SSMMAINTENANCEWINDOWTI00 /AWS1/SSMMAINTENANCEWINDOWTI00

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

iv_scheduleoffset TYPE /AWS1/SSMMAINTENANCEWINDOWOFF /AWS1/SSMMAINTENANCEWINDOWOFF

The number of days to wait after the date and time specified by a cron expression before running the maintenance window.

For example, the following cron expression schedules a maintenance window to run the third Tuesday of every month at 11:30 PM.

cron(30 23 ? * TUE#3 *)

If the schedule offset is 2, the maintenance window won't run until two days later.

iv_duration TYPE /AWS1/SSMMAINTENANCEWINDOWDU00 /AWS1/SSMMAINTENANCEWINDOWDU00

The duration of the maintenance window in hours.

iv_cutoff TYPE /AWS1/SSMMAINTENANCEWINDOWCU00 /AWS1/SSMMAINTENANCEWINDOWCU00

The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.

iv_allowunassociatedtargets TYPE /AWS1/SSMMAINTENANCEWINDOWAL00 /AWS1/SSMMAINTENANCEWINDOWAL00

Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

iv_enabled TYPE /AWS1/SSMMAINTENANCEWINDOWENBD /AWS1/SSMMAINTENANCEWINDOWENBD

Whether the maintenance window is enabled.

iv_replace TYPE /AWS1/SSMBOOLEAN /AWS1/SSMBOOLEAN

If True, then all fields that are required by the CreateMaintenanceWindow operation are also required for this API request. Optional fields that aren't specified are set to null.

RETURNING

oo_output TYPE REF TO /aws1/cl_ssmupmaintenancewin01 /AWS1/CL_SSMUPMAINTENANCEWIN01

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->updatemaintenancewindow(
  iv_allowunassociatedtargets = ABAP_TRUE
  iv_cutoff = 123
  iv_description = |string|
  iv_duration = 123
  iv_enabled = ABAP_TRUE
  iv_enddate = |string|
  iv_name = |string|
  iv_replace = ABAP_TRUE
  iv_schedule = |string|
  iv_scheduleoffset = 123
  iv_scheduletimezone = |string|
  iv_startdate = |string|
  iv_windowid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_maintenancewindowid = lo_result->get_windowid( ).
  lv_maintenancewindowname = lo_result->get_name( ).
  lv_maintenancewindowdescri = lo_result->get_description( ).
  lv_maintenancewindowstring = lo_result->get_startdate( ).
  lv_maintenancewindowstring = lo_result->get_enddate( ).
  lv_maintenancewindowschedu = lo_result->get_schedule( ).
  lv_maintenancewindowtimezo = lo_result->get_scheduletimezone( ).
  lv_maintenancewindowoffset = lo_result->get_scheduleoffset( ).
  lv_maintenancewindowdurati = lo_result->get_duration( ).
  lv_maintenancewindowcutoff = lo_result->get_cutoff( ).
  lv_maintenancewindowallowu = lo_result->get_allowunassociatedtargets( ).
  lv_maintenancewindowenable = lo_result->get_enabled( ).
ENDIF.