GetRotationOverride
Important
AWS Systems Manager Incident Manager will no longer be open to new customers starting November 7, 2025. If you would like to use Incident Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Incident Manager availability change.
Retrieves information about an override to an on-call rotation.
Request Syntax
{
"RotationId": "string
",
"RotationOverrideId": "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.
- RotationId
-
The Amazon Resource Name (ARN) of the overridden rotation to retrieve information about.
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
- RotationOverrideId
-
The Amazon Resource Name (ARN) of the on-call rotation override to retrieve information about.
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}
Required: Yes
Response Syntax
{
"CreateTime": number,
"EndTime": number,
"NewContactIds": [ "string" ],
"RotationArn": "string",
"RotationOverrideId": "string",
"StartTime": number
}
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.
- CreateTime
-
The date and time when the override was created.
Type: Timestamp
- EndTime
-
The date and time when the override ends.
Type: Timestamp
- NewContactIds
-
The Amazon Resource Names (ARNs) of the contacts assigned to the override of the on-call rotation.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 25 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+=\/,.@:-])*
- RotationArn
-
The Amazon Resource Name (ARN) of the on-call rotation that was overridden.
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+=\/,.@:-])*
- RotationOverrideId
-
The Amazon Resource Name (ARN) of the override to an on-call rotation.
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}
- StartTime
-
The date and time when the override goes into effect.
Type: Timestamp
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: