Create Rotation

ssmcontacts_create_rotation

R Documentation

Creates a rotation in an on-call schedule

Description

Creates a rotation in an on-call schedule.

Usage

ssmcontacts_create_rotation(Name, ContactIds, StartTime, TimeZoneId,
  Recurrence, Tags, IdempotencyToken)

Arguments

Name

[required] The name of the rotation.

ContactIds

[required] The Amazon Resource Names (ARNs) of the contacts to add to the rotation.

The order that you list the contacts in is their shift order in the rotation schedule. To change the order of the contact's shifts, use the update_rotation operation.

StartTime

The date and time that the rotation goes into effect.

TimeZoneId

[required] The time zone to base the 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), are not supported.

Recurrence

[required] Information about the rule that specifies when a shift's team members rotate.

Tags

Optional metadata to assign to the rotation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For more information, see Tagging Incident Manager resources in the Incident Manager User Guide.

IdempotencyToken

A token that ensures that the operation is called only once with the specified details.

Value

A list with the following syntax:

list(
  RotationArn = "string"
)

Request syntax

svc$create_rotation(
  Name = "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
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  IdempotencyToken = "string"
)