List Rotations

ssmcontacts_list_rotations

R Documentation

Retrieves a list of on-call rotations

Description

Retrieves a list of on-call rotations.

Usage

ssmcontacts_list_rotations(RotationNamePrefix, NextToken, MaxResults)

Arguments

RotationNamePrefix

A filter to include rotations in list results based on their common prefix. For example, entering prod returns a list of all rotation names that begin with prod, such as production and prod-1.

NextToken

A token to start the list. Use this token to get the next set of results.

MaxResults

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Value

A list with the following syntax:

list(
  NextToken = "string",
  Rotations = list(
    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$list_rotations(
  RotationNamePrefix = "string",
  NextToken = "string",
  MaxResults = 123
)