Update Rotation

ssmcontacts_update_rotation

R Documentation

Updates the information specified for an on-call rotation

Description

Updates the information specified for an on-call rotation.

Usage

ssmcontacts_update_rotation(RotationId, ContactIds, StartTime,
  TimeZoneId, Recurrence)

Arguments

RotationId

[required] The Amazon Resource Name (ARN) of the rotation to update.

ContactIds

The Amazon Resource Names (ARNs) of the contacts to include in the updated rotation.

The order in which you list the contacts is their shift order in the rotation schedule.

StartTime

The date and time the rotation goes into effect.

TimeZoneId

The time zone to base the updated rotation’s activity 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.

Designators for time zones that don’t support Daylight Savings Time Rules, such as Pacific Standard Time (PST) and Pacific Daylight Time (PDT), aren't supported.

Recurrence

[required] Information about how long the updated rotation lasts before restarting at the beginning of the shift order.

Value

An empty list.

Request syntax

svc$update_rotation(
  RotationId = "string",
  ContactIds = list(
    "string"
  ),
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  TimeZoneId = "string",
  Recurrence = list(
    MonthlySettings = list(
      list(
        DayOfMonth = 123,
        HandOffTime = list(
          HourOfDay = 123,
          MinuteOfHour = 123
        )
      )
    ),
    WeeklySettings = list(
      list(
        DayOfWeek = "MON"|"TUE"|"WED"|"THU"|"FRI"|"SAT"|"SUN",
        HandOffTime = list(
          HourOfDay = 123,
          MinuteOfHour = 123
        )
      )
    ),
    DailySettings = list(
      list(
        HourOfDay = 123,
        MinuteOfHour = 123
      )
    ),
    NumberOfOnCalls = 123,
    ShiftCoverages = list(
      list(
        list(
          Start = list(
            HourOfDay = 123,
            MinuteOfHour = 123
          ),
          End = list(
            HourOfDay = 123,
            MinuteOfHour = 123
          )
        )
      )
    ),
    RecurrenceMultiplier = 123
  )
)