Skip to content

Get Rotation

ssmcontacts_get_rotation R Documentation

Retrieves information about an on-call rotation

Description

Retrieves information about an on-call rotation.

Usage

ssmcontacts_get_rotation(RotationId)

Arguments

RotationId

[required] The Amazon Resource Name (ARN) of the on-call rotation to retrieve information about.

Value

A list with the following syntax:

list(
  RotationArn = "string",
  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
  )
)

Request syntax

svc$get_rotation(
  RotationId = "string"
)