List Preview Rotation Shifts

ssmcontacts_list_preview_rotation_shifts

R Documentation

Returns a list of shifts based on rotation configuration parameters

Description

Returns a list of shifts based on rotation configuration parameters.

The Incident Manager primarily uses this operation to populate the Preview calendar. It is not typically run by end users.

Usage

ssmcontacts_list_preview_rotation_shifts(RotationStartTime, StartTime,
  EndTime, Members, TimeZoneId, Recurrence, Overrides, NextToken,
  MaxResults)

Arguments

RotationStartTime

The date and time a rotation would begin. The first shift is calculated from this date and time.

StartTime

Used to filter the range of calculated shifts before sending the response back to the user.

EndTime

[required] The date and time a rotation shift would end.

Members

[required] The contacts that would be assigned to a rotation.

TimeZoneId

[required] The time zone the rotation’s activity would be based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul".

Recurrence

[required] Information about how long a rotation would last before restarting at the beginning of the shift order.

Overrides

Information about changes that would be made in a rotation override.

NextToken

A token to start the list. This token is used 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 can be specified in a subsequent call to get the next set of results.

Value

A list with the following syntax:

list(
  RotationShifts = list(
    list(
      ContactIds = list(
        "string"
      ),
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      ),
      Type = "REGULAR"|"OVERRIDDEN",
      ShiftDetails = list(
        OverriddenContactIds = list(
          "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_preview_rotation_shifts(
  RotationStartTime = as.POSIXct(
    "2015-01-01"
  ),
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  Members = list(
    "string"
  ),
  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
  ),
  Overrides = list(
    list(
      NewMembers = list(
        "string"
      ),
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string",
  MaxResults = 123
)