Request Syntax Request Parameters Response Elements Errors See Also

UpdateRotation

Updates the information specified for an on-call rotation.

Request Syntax


{
   "ContactIds": [ "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
            }
         }
      ]
   },
   "RotationId": "string",
   "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.

ContactIds

The Amazon Resource Names (ARNs) of the contacts to include in the updated rotation.

Note

Only the PERSONAL contact type is supported. The contact types ESCALATION and ONCALL_SCHEDULE are not supported for this operation.

The order in which you list the contacts is their shift order in the rotation schedule.

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

Pattern: arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*

Required: No

Recurrence

Information about how long the updated rotation lasts before restarting at the beginning of the shift order.

Type: RecurrenceSettings object

Required: Yes

RotationId

The Amazon Resource Name (ARN) of the rotation to update.

Type: String

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

Pattern: arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*

Required: Yes

StartTime

The date and time the rotation goes into effect.

Type: Timestamp

Required: No

TimeZoneId

The time zone to base the updated rotation’s activity on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

Note

Designators for time zones that don’t support Daylight Savings Time Rules, such as Pacific Standard Time (PST), aren't supported.

Type: String

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

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

Required: No

Response Elements

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

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

ConflictException

Updating or deleting a resource causes an inconsistent state.

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