CreateRotationOverride
Creates an override for a rotation in an on-call schedule.
Request Syntax
{
"EndTime": number,
"IdempotencyToken": "string",
"NewContactIds": [ "string" ],
"RotationId": "string",
"StartTime": number
}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 when the override ends.
Type: Timestamp
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
- NewContactIds
-
The Amazon Resource Names (ARNs) of the contacts to replace those in the current on-call rotation with.
If you want to include any current team members in the override shift, you must include their ARNs in the new contact ID list.
Type: Array of strings
Array Members: Minimum number of 0 items. 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
- RotationId
-
The Amazon Resource Name (ARN) of the rotation to create an override for.
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 when the override goes into effect.
Type: Timestamp
Required: Yes
Response Syntax
{
"RotationOverrideId": "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.
- RotationOverrideId
-
The Amazon Resource Name (ARN) of the created rotation override.
Type: String
Length Constraints: Minimum length of 36. Maximum length of 39.
Pattern:
([a-fA-Z0-9]{8,11}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}){1}
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
