Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListPreviewRotationShifts

Returns a list of shifts based on rotation configuration parameters.

Note

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

Request Syntax


{
   "EndTime": number,
   "MaxResults": number,
   "Members": [ "string" ],
   "NextToken": "string",
   "Overrides": [ 
      { 
         "EndTime": number,
         "NewMembers": [ "string" ],
         "StartTime": number
      }
   ],
   "Recurrence": { 
      "DailySettings": [ 
         { 
            "HourOfDay": number,
            "MinuteOfHour": number
         }
      ],
      "MonthlySettings": [ 
         { 
            "DayOfMonth": number,
            "HandOffTime": { 
               "HourOfDay": number,
               "MinuteOfHour": number
            }
         }
      ],
      "NumberOfOnCalls": number,
      "RecurrenceMultiplier": number,
      "ShiftCoverages": { 
         "string" : [ 
            { 
               "End": { 
                  "HourOfDay": number,
                  "MinuteOfHour": number
               },
               "Start": { 
                  "HourOfDay": number,
                  "MinuteOfHour": number
               }
            }
         ]
      },
      "WeeklySettings": [ 
         { 
            "DayOfWeek": "string",
            "HandOffTime": { 
               "HourOfDay": number,
               "MinuteOfHour": number
            }
         }
      ]
   },
   "RotationStartTime": number,
   "StartTime": number,
   "TimeZoneId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EndTime

The date and time a rotation shift would end.

Type: Timestamp

Required: Yes

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.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1024.

Required: No

Members

The contacts that would be assigned to a rotation.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 30 items.

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: .*\S.*

Required: Yes

NextToken

A token to start the list. This token is used to get the next set of results.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: ^[\\\/a-zA-Z0-9_+=\-]*$

Required: No

Overrides

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

Type: Array of PreviewOverride objects

Required: No

Recurrence

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

Type: RecurrenceSettings object

Required: Yes

RotationStartTime

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

Type: Timestamp

Required: No

StartTime

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

Type: Timestamp

Required: No

TimeZoneId

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".

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[:a-zA-Z0-9_\-\s\.\\/]*$

Required: Yes

Response Syntax


{
   "NextToken": "string",
   "RotationShifts": [ 
      { 
         "ContactIds": [ "string" ],
         "EndTime": number,
         "ShiftDetails": { 
            "OverriddenContactIds": [ "string" ]
         },
         "StartTime": number,
         "Type": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

The token for the next set of items to return. This token is used to get the next set of results.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: ^[\\\/a-zA-Z0-9_+=\-]*$

RotationShifts

Details about a rotation shift, including times, types, and contacts.

Type: Array of RotationShift objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient access to perform this operation.

HTTP Status Code: 400

InternalServerException

Unexpected error occurred while processing the request.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400