Update Schedule

eventbridgescheduler_update_schedule

R Documentation

Updates the specified schedule

Description

Updates the specified schedule. When you call update_schedule, 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 get_schedule API operation and make a note of all optional parameters for your update_schedule call.

Usage

eventbridgescheduler_update_schedule(ActionAfterCompletion, ClientToken,
  Description, EndDate, FlexibleTimeWindow, GroupName, KmsKeyArn, Name,
  ScheduleExpression, ScheduleExpressionTimezone, StartDate, State,
  Target)

Arguments

ActionAfterCompletion

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

ClientToken

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.

Description

The description you specify for the schedule.

EndDate

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.

FlexibleTimeWindow

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

GroupName

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.

KmsKeyArn

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

Name

[required] The name of the schedule that you are updating.

ScheduleExpression

[required] 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.

ScheduleExpressionTimezone

The timezone in which the scheduling expression is evaluated.

StartDate

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.

State

Specifies whether the schedule is enabled or disabled.

Target

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

Value

A list with the following syntax:

list(
  ScheduleArn = "string"
)

Request syntax

svc$update_schedule(
  ActionAfterCompletion = "NONE"|"DELETE",
  ClientToken = "string",
  Description = "string",
  EndDate = as.POSIXct(
    "2015-01-01"
  ),
  FlexibleTimeWindow = list(
    MaximumWindowInMinutes = 123,
    Mode = "OFF"|"FLEXIBLE"
  ),
  GroupName = "string",
  KmsKeyArn = "string",
  Name = "string",
  ScheduleExpression = "string",
  ScheduleExpressionTimezone = "string",
  StartDate = as.POSIXct(
    "2015-01-01"
  ),
  State = "ENABLED"|"DISABLED",
  Target = list(
    Arn = "string",
    DeadLetterConfig = list(
      Arn = "string"
    ),
    EcsParameters = list(
      CapacityProviderStrategy = list(
        list(
          base = 123,
          capacityProvider = "string",
          weight = 123
        )
      ),
      EnableECSManagedTags = TRUE|FALSE,
      EnableExecuteCommand = TRUE|FALSE,
      Group = "string",
      LaunchType = "EC2"|"FARGATE"|"EXTERNAL",
      NetworkConfiguration = list(
        awsvpcConfiguration = list(
          AssignPublicIp = "ENABLED"|"DISABLED",
          SecurityGroups = list(
            "string"
          ),
          Subnets = list(
            "string"
          )
        )
      ),
      PlacementConstraints = list(
        list(
          expression = "string",
          type = "distinctInstance"|"memberOf"
        )
      ),
      PlacementStrategy = list(
        list(
          field = "string",
          type = "random"|"spread"|"binpack"
        )
      ),
      PlatformVersion = "string",
      PropagateTags = "TASK_DEFINITION",
      ReferenceId = "string",
      Tags = list(
        list(
          "string"
        )
      ),
      TaskCount = 123,
      TaskDefinitionArn = "string"
    ),
    EventBridgeParameters = list(
      DetailType = "string",
      Source = "string"
    ),
    Input = "string",
    KinesisParameters = list(
      PartitionKey = "string"
    ),
    RetryPolicy = list(
      MaximumEventAgeInSeconds = 123,
      MaximumRetryAttempts = 123
    ),
    RoleArn = "string",
    SageMakerPipelineParameters = list(
      PipelineParameterList = list(
        list(
          Name = "string",
          Value = "string"
        )
      )
    ),
    SqsParameters = list(
      MessageGroupId = "string"
    )
  )
)