Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateRotation

Creates a rotation in an on-call schedule.

Request Syntax


{
   "ContactIds": [ "string" ],
   "IdempotencyToken": "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
            }
         }
      ]
   },
   "StartTime": number,
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "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 add to the rotation.

Note

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

The order that you list the contacts in is their shift order in the rotation schedule. To change the order of the contact's shifts, use the UpdateRotation operation.

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: Yes

IdempotencyToken

A token that ensures that the operation is called only once with the specified details.

Type: String

Length Constraints: Maximum length of 2048.

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

Required: No

Name

The name of the rotation.

Type: String

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

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

Required: Yes

Recurrence

Information about the rule that specifies when a shift's team members rotate.

Type: RecurrenceSettings object

Required: Yes

StartTime

The date and time that the rotation goes into effect.

Type: Timestamp

Required: No

Tags

Optional metadata to assign to the rotation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For more information, see Tagging Incident Manager resources in the Incident Manager User Guide.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

TimeZoneId

The time zone to base the 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), are not supported.

Type: String

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

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

Required: Yes

Response Syntax


{
   "RotationArn": "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.

RotationArn

The Amazon Resource Name (ARN) of the created rotation.

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+=\/,.@:-])*

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

ServiceQuotaExceededException

Request would cause a service quota to be exceeded.

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