Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListRotations

Retrieves a list of on-call rotations.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string",
   "RotationNamePrefix": "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.

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.

Type: Integer

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

Required: No

NextToken

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

Type: String

Length Constraints: Maximum length of 2048.

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

Required: No

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.

Type: String

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

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

Required: No

Response Syntax


{
   "NextToken": "string",
   "Rotations": [ 
      { 
         "ContactIds": [ "string" ],
         "Name": "string",
         "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
                  }
               }
            ]
         },
         "RotationArn": "string",
         "StartTime": number,
         "TimeZoneId": "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. Use this token to get the next set of results.

Type: String

Length Constraints: Maximum length of 2048.

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

Rotations

Information about rotations that meet the filter criteria.

Type: Array of Rotation 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

ResourceNotFoundException

Request references a resource that doesn't exist.

HTTP Status Code: 400

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