ListRotationShifts
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.
Returns a list of shifts generated by an existing rotation in the system.
Request Syntax
{
"EndTime": number
,
"MaxResults": number
,
"NextToken": "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 for the end of the time range to list shifts for.
Type: Timestamp
Required: Yes
- 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
- RotationId
-
The Amazon Resource Name (ARN) of the rotation to retrieve shift 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
- StartTime
-
The date and time for the beginning of the time range to list shifts for.
Type: Timestamp
Required: No
Response Syntax
{
"NextToken": "string",
"RotationShifts": [
{
"ContactIds": [ "string" ],
"EndTime": number,
"ShiftDetails": {
"OverriddenContactIds": [ "string" ]
},
"StartTime": number,
"Type": "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_+=\-]*$
- RotationShifts
-
Information about shifts that meet the filter criteria.
Type: Array of RotationShift 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
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: