Skip to content

/AWS1/IF_SCD=>UPDATESCHEDULE()

About UpdateSchedule

Updates the specified schedule. When you call UpdateSchedule, EventBridge Scheduler uses all values, including empty values, specified in the request and overrides the existing schedule. This is by design. This means that if you do not set an optional field in your request, that field will be set to its system-default value after the update.

Before calling this operation, we recommend that you call the GetSchedule API operation and make a note of all optional parameters for your UpdateSchedule call.

Method Signature

METHODS /AWS1/IF_SCD~UPDATESCHEDULE
  IMPORTING
    !IV_NAME TYPE /AWS1/SCDNAME OPTIONAL
    !IV_GROUPNAME TYPE /AWS1/SCDSCHEDULEGROUPNAME OPTIONAL
    !IV_SCHEDULEEXPRESSION TYPE /AWS1/SCDSCHEDULEEXPRESSION OPTIONAL
    !IV_STARTDATE TYPE /AWS1/SCDSTARTDATE OPTIONAL
    !IV_ENDDATE TYPE /AWS1/SCDENDDATE OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/SCDDESCRIPTION OPTIONAL
    !IV_SCHEDULEXPRSNTIMEZONE TYPE /AWS1/SCDSCHEDULEXPRSNTIMEZONE OPTIONAL
    !IV_STATE TYPE /AWS1/SCDSCHEDULESTATE OPTIONAL
    !IV_KMSKEYARN TYPE /AWS1/SCDKMSKEYARN OPTIONAL
    !IO_TARGET TYPE REF TO /AWS1/CL_SCDTARGET OPTIONAL
    !IO_FLEXIBLETIMEWINDOW TYPE REF TO /AWS1/CL_SCDFLEXIBLETIMEWINDOW OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/SCDCLIENTTOKEN OPTIONAL
    !IV_ACTIONAFTERCOMPLETION TYPE /AWS1/SCDACTIONAFTERCOMPLETION OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_scdupdateschdoutput
  RAISING
    /AWS1/CX_SCDCONFLICTEXCEPTION
    /AWS1/CX_SCDINTERNALSERVEREX
    /AWS1/CX_SCDRESOURCENOTFOUNDEX
    /AWS1/CX_SCDTHROTTLINGEX
    /AWS1/CX_SCDVALIDATIONEX
    /AWS1/CX_SCDCLIENTEXC
    /AWS1/CX_SCDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_name TYPE /AWS1/SCDNAME /AWS1/SCDNAME

The name of the schedule that you are updating.

iv_scheduleexpression TYPE /AWS1/SCDSCHEDULEEXPRESSION /AWS1/SCDSCHEDULEEXPRESSION

The expression that defines when the schedule runs. The following formats are supported.

  • at expression - at(yyyy-mm-ddThh:mm:ss)

  • rate expression - rate(value unit)

  • cron expression - cron(fields)

You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.

A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).

A rate expression consists of a value as a positive integer, and a unit with the following options: minute | minutes | hour | hours | day | days

For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.

io_target TYPE REF TO /AWS1/CL_SCDTARGET /AWS1/CL_SCDTARGET

The schedule target. You can use this operation to change the target that your schedule invokes.

io_flexibletimewindow TYPE REF TO /AWS1/CL_SCDFLEXIBLETIMEWINDOW /AWS1/CL_SCDFLEXIBLETIMEWINDOW

Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

Optional arguments:

iv_groupname TYPE /AWS1/SCDSCHEDULEGROUPNAME /AWS1/SCDSCHEDULEGROUPNAME

The name of the schedule group with which the schedule is associated. You must provide this value in order for EventBridge Scheduler to find the schedule you want to update. If you omit this value, EventBridge Scheduler assumes the group is associated to the default group.

iv_startdate TYPE /AWS1/SCDSTARTDATE /AWS1/SCDSTARTDATE

The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.

iv_enddate TYPE /AWS1/SCDENDDATE /AWS1/SCDENDDATE

The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time schedules.

iv_description TYPE /AWS1/SCDDESCRIPTION /AWS1/SCDDESCRIPTION

The description you specify for the schedule.

iv_schedulexprsntimezone TYPE /AWS1/SCDSCHEDULEXPRSNTIMEZONE /AWS1/SCDSCHEDULEXPRSNTIMEZONE

The timezone in which the scheduling expression is evaluated.

iv_state TYPE /AWS1/SCDSCHEDULESTATE /AWS1/SCDSCHEDULESTATE

Specifies whether the schedule is enabled or disabled.

iv_kmskeyarn TYPE /AWS1/SCDKMSKEYARN /AWS1/SCDKMSKEYARN

The ARN for the customer managed KMS key that that you want EventBridge Scheduler to use to encrypt and decrypt your data.

iv_clienttoken TYPE /AWS1/SCDCLIENTTOKEN /AWS1/SCDCLIENTTOKEN

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.

iv_actionaftercompletion TYPE /AWS1/SCDACTIONAFTERCOMPLETION /AWS1/SCDACTIONAFTERCOMPLETION

Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.

RETURNING

oo_output TYPE REF TO /aws1/cl_scdupdateschdoutput /AWS1/CL_SCDUPDATESCHDOUTPUT

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->updateschedule(
  io_flexibletimewindow = new /aws1/cl_scdflexibletimewindow(
    iv_maximumwindowinminutes = 123
    iv_mode = |string|
  )
  io_target = new /aws1/cl_scdtarget(
    io_deadletterconfig = new /aws1/cl_scddeadletterconfig( |string| )
    io_ecsparameters = new /aws1/cl_scdecsparameters(
      io_networkconfiguration = new /aws1/cl_scdnetworkconf(
        io_awsvpcconfiguration = new /aws1/cl_scdawsvpcconf(
          it_securitygroups = VALUE /aws1/cl_scdsecuritygroups_w=>tt_securitygroups(
            ( new /aws1/cl_scdsecuritygroups_w( |string| ) )
          )
          it_subnets = VALUE /aws1/cl_scdsubnets_w=>tt_subnets(
            ( new /aws1/cl_scdsubnets_w( |string| ) )
          )
          iv_assignpublicip = |string|
        )
      )
      it_capacityproviderstrategy = VALUE /aws1/cl_scdcappvdrstragitem=>tt_capacityproviderstrategy(
        (
          new /aws1/cl_scdcappvdrstragitem(
            iv_base = 123
            iv_capacityprovider = |string|
            iv_weight = 123
          )
        )
      )
      it_placementconstraints = VALUE /aws1/cl_scdplacementcnstrnt=>tt_placementconstraints(
        (
          new /aws1/cl_scdplacementcnstrnt(
            iv_expression = |string|
            iv_type = |string|
          )
        )
      )
      it_placementstrategy = VALUE /aws1/cl_scdplacementstrategy=>tt_placementstrategies(
        (
          new /aws1/cl_scdplacementstrategy(
            iv_field = |string|
            iv_type = |string|
          )
        )
      )
      it_tags = VALUE /aws1/cl_scdtagmap_w=>tt_tags(
        (
          VALUE /aws1/cl_scdtagmap_w=>tt_tagmap(
            (
              VALUE /aws1/cl_scdtagmap_w=>ts_tagmap_maprow(
                value = new /aws1/cl_scdtagmap_w( |string| )
                key = |string|
              )
            )
          )
        )
      )
      iv_enableecsmanagedtags = ABAP_TRUE
      iv_enableexecutecommand = ABAP_TRUE
      iv_group = |string|
      iv_launchtype = |string|
      iv_platformversion = |string|
      iv_propagatetags = |string|
      iv_referenceid = |string|
      iv_taskcount = 123
      iv_taskdefinitionarn = |string|
    )
    io_eventbridgeparameters = new /aws1/cl_scdeventbridgeparams(
      iv_detailtype = |string|
      iv_source = |string|
    )
    io_kinesisparameters = new /aws1/cl_scdkinesisparameters( |string| )
    io_retrypolicy = new /aws1/cl_scdretrypolicy(
      iv_maximumeventageinseconds = 123
      iv_maximumretryattempts = 123
    )
    io_smpipelineparameters = new /aws1/cl_scdsmpipelineparams(
      it_pipelineparameterlist = VALUE /aws1/cl_scdsmpipelineparam=>tt_smpipelineparameterlist(
        (
          new /aws1/cl_scdsmpipelineparam(
            iv_name = |string|
            iv_value = |string|
          )
        )
      )
    )
    io_sqsparameters = new /aws1/cl_scdsqsparameters( |string| )
    iv_arn = |string|
    iv_input = |string|
    iv_rolearn = |string|
  )
  iv_actionaftercompletion = |string|
  iv_clienttoken = |string|
  iv_description = |string|
  iv_enddate = '20150101000000.0000000'
  iv_groupname = |string|
  iv_kmskeyarn = |string|
  iv_name = |string|
  iv_scheduleexpression = |string|
  iv_schedulexprsntimezone = |string|
  iv_startdate = '20150101000000.0000000'
  iv_state = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_schedulearn = lo_result->get_schedulearn( ).
ENDIF.