List Rotation Shifts

ssmcontacts_list_rotation_shifts

R Documentation

Returns a list of shifts generated by an existing rotation in the system¶

Description¶

Returns a list of shifts generated by an existing rotation in the system.

Usage¶

ssmcontacts_list_rotation_shifts(RotationId, StartTime, EndTime,
  NextToken, MaxResults)

Arguments¶

RotationId

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

StartTime

The date and time for the beginning of the time range to list shifts for.

EndTime

[required] The date and time for the end of the time range to list shifts for.

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(
  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_rotation_shifts(
  RotationId = "string",
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  NextToken = "string",
  MaxResults = 123
)