2023/03/28 - AWS Systems Manager Incident Manager Contacts - 12 new4 updated api methods
Changes This release adds 12 new APIs as part of Oncall Schedule feature release, adds support for a new contact type: ONCALL_SCHEDULE. Check public documentation for AWS ssm-contacts for more information
Retrieves a list of overrides currently specified for an on-call rotation.
See also: AWS API Documentation
Request Syntax
client.list_rotation_overrides(
RotationId='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the rotation to retrieve information about.
datetime
[REQUIRED]
The date and time for the beginning of a time range for listing overrides.
datetime
[REQUIRED]
The date and time for the end of a time range for listing overrides.
string
A token to start the list. Use this token to get the next set of results.
integer
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.
dict
Response Syntax
{
'RotationOverrides': [
{
'RotationOverrideId': 'string',
'NewContactIds': [
'string',
],
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'CreateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RotationOverrides (list) --
A list of rotation overrides in the specified time range.
(dict) --
Information about an override specified for an on-call rotation.
RotationOverrideId (string) --
The Amazon Resource Name (ARN) of the override to an on-call rotation.
NewContactIds (list) --
The Amazon Resource Names (ARNs) of the contacts assigned to the override of the on-call rotation.
(string) --
StartTime (datetime) --
The time a rotation override begins.
EndTime (datetime) --
The time a rotation override ends.
CreateTime (datetime) --
The time a rotation override was created.
NextToken (string) --
The token for the next set of items to return. Use this token to get the next set of results.
Returns a list of shifts generated by an existing rotation in the system.
See also: AWS API Documentation
Request Syntax
client.list_rotation_shifts(
RotationId='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the rotation to retrieve shift information about.
datetime
The date and time for the beginning of the time range to list shifts for.
datetime
[REQUIRED]
The date and time for the end of the time range to list shifts for.
string
A token to start the list. Use this token to get the next set of results.
integer
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.
dict
Response Syntax
{
'RotationShifts': [
{
'ContactIds': [
'string',
],
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'Type': 'REGULAR'|'OVERRIDDEN',
'ShiftDetails': {
'OverriddenContactIds': [
'string',
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RotationShifts (list) --
Information about shifts that meet the filter criteria.
(dict) --
Information about a shift that belongs to an on-call rotation.
ContactIds (list) --
The Amazon Resource Names (ARNs) of the contacts who are part of the shift rotation.
(string) --
StartTime (datetime) --
The time a shift rotation begins.
EndTime (datetime) --
The time a shift rotation ends.
Type (string) --
The type of shift rotation.
ShiftDetails (dict) --
Additional information about an on-call rotation shift.
OverriddenContactIds (list) --
The Amazon Resources Names (ARNs) of the contacts who were replaced in a shift when an override was created. If the override is deleted, these contacts are restored to the shift.
(string) --
NextToken (string) --
The token for the next set of items to return. Use this token to get the next set of results.
Retrieves information about an on-call rotation.
See also: AWS API Documentation
Request Syntax
client.get_rotation(
RotationId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the on-call rotation to retrieve information about.
dict
Response Syntax
{
'RotationArn': 'string',
'Name': 'string',
'ContactIds': [
'string',
],
'StartTime': datetime(2015, 1, 1),
'TimeZoneId': 'string',
'Recurrence': {
'MonthlySettings': [
{
'DayOfMonth': 123,
'HandOffTime': {
'HourOfDay': 123,
'MinuteOfHour': 123
}
},
],
'WeeklySettings': [
{
'DayOfWeek': 'MON'|'TUE'|'WED'|'THU'|'FRI'|'SAT'|'SUN',
'HandOffTime': {
'HourOfDay': 123,
'MinuteOfHour': 123
}
},
],
'DailySettings': [
{
'HourOfDay': 123,
'MinuteOfHour': 123
},
],
'NumberOfOnCalls': 123,
'ShiftCoverages': {
'string': [
{
'Start': {
'HourOfDay': 123,
'MinuteOfHour': 123
},
'End': {
'HourOfDay': 123,
'MinuteOfHour': 123
}
},
]
},
'RecurrenceMultiplier': 123
}
}
Response Structure
(dict) --
RotationArn (string) --
The Amazon Resource Name (ARN) of the on-call rotation.
Name (string) --
The name of the on-call rotation.
ContactIds (list) --
The Amazon Resource Names (ARNs) of the contacts assigned to the on-call rotation team.
(string) --
StartTime (datetime) --
The specified start time for the on-call rotation.
TimeZoneId (string) --
The time zone that the rotation’s activity is based on, in Internet Assigned Numbers Authority (IANA) format.
Recurrence (dict) --
Specifies how long a rotation lasts before restarting at the beginning of the shift order.
MonthlySettings (list) --
Information about on-call rotations that recur monthly.
(dict) --
Information about on-call rotations that recur monthly.
DayOfMonth (integer) --
The day of the month when monthly recurring on-call rotations begin.
HandOffTime (dict) --
The time of day when a monthly recurring on-call shift rotation begins.
HourOfDay (integer) --
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) --
The minute when an on-call rotation shift begins or ends.
WeeklySettings (list) --
Information about on-call rotations that recur weekly.
(dict) --
Information about rotations that recur weekly.
DayOfWeek (string) --
The day of the week when weekly recurring on-call shift rotations begins.
HandOffTime (dict) --
The time of day when a weekly recurring on-call shift rotation begins.
HourOfDay (integer) --
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) --
The minute when an on-call rotation shift begins or ends.
DailySettings (list) --
Information about on-call rotations that recur daily.
(dict) --
Details about when an on-call rotation shift begins or ends.
HourOfDay (integer) --
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) --
The minute when an on-call rotation shift begins or ends.
NumberOfOnCalls (integer) --
The number of contacts, or shift team members designated to be on call concurrently during a shift. For example, in an on-call schedule containing ten contacts, a value of 2 designates that two of them are on call at any given time.
ShiftCoverages (dict) --
Information about the days of the week included in on-call rotation coverage.
(string) --
(list) --
(dict) --
Information about when an on-call shift begins and ends.
Start (dict) --
Information about when the on-call rotation shift begins.
HourOfDay (integer) --
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) --
The minute when an on-call rotation shift begins or ends.
End (dict) --
Information about when the on-call rotation shift ends.
HourOfDay (integer) --
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) --
The minute when an on-call rotation shift begins or ends.
RecurrenceMultiplier (integer) --
The number of days, weeks, or months a single rotation lasts.
Deletes a rotation from the system. If a rotation belongs to more than one on-call schedule, this operation deletes it from all of them.
See also: AWS API Documentation
Request Syntax
client.delete_rotation(
RotationId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the on-call rotation to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a rotation in an on-call schedule.
See also: AWS API Documentation
Request Syntax
client.create_rotation(
Name='string',
ContactIds=[
'string',
],
StartTime=datetime(2015, 1, 1),
TimeZoneId='string',
Recurrence={
'MonthlySettings': [
{
'DayOfMonth': 123,
'HandOffTime': {
'HourOfDay': 123,
'MinuteOfHour': 123
}
},
],
'WeeklySettings': [
{
'DayOfWeek': 'MON'|'TUE'|'WED'|'THU'|'FRI'|'SAT'|'SUN',
'HandOffTime': {
'HourOfDay': 123,
'MinuteOfHour': 123
}
},
],
'DailySettings': [
{
'HourOfDay': 123,
'MinuteOfHour': 123
},
],
'NumberOfOnCalls': 123,
'ShiftCoverages': {
'string': [
{
'Start': {
'HourOfDay': 123,
'MinuteOfHour': 123
},
'End': {
'HourOfDay': 123,
'MinuteOfHour': 123
}
},
]
},
'RecurrenceMultiplier': 123
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
IdempotencyToken='string'
)
string
[REQUIRED]
The name of the rotation.
list
[REQUIRED]
The Amazon Resource Names (ARNs) of the contacts to add to the rotation.
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.
(string) --
datetime
The date and time that the rotation goes into effect.
string
[REQUIRED]
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.
dict
[REQUIRED]
Information about the rule that specifies when a shift's team members rotate.
MonthlySettings (list) --
Information about on-call rotations that recur monthly.
(dict) --
Information about on-call rotations that recur monthly.
DayOfMonth (integer) -- [REQUIRED]
The day of the month when monthly recurring on-call rotations begin.
HandOffTime (dict) -- [REQUIRED]
The time of day when a monthly recurring on-call shift rotation begins.
HourOfDay (integer) -- [REQUIRED]
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) -- [REQUIRED]
The minute when an on-call rotation shift begins or ends.
WeeklySettings (list) --
Information about on-call rotations that recur weekly.
(dict) --
Information about rotations that recur weekly.
DayOfWeek (string) -- [REQUIRED]
The day of the week when weekly recurring on-call shift rotations begins.
HandOffTime (dict) -- [REQUIRED]
The time of day when a weekly recurring on-call shift rotation begins.
HourOfDay (integer) -- [REQUIRED]
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) -- [REQUIRED]
The minute when an on-call rotation shift begins or ends.
DailySettings (list) --
Information about on-call rotations that recur daily.
(dict) --
Details about when an on-call rotation shift begins or ends.
HourOfDay (integer) -- [REQUIRED]
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) -- [REQUIRED]
The minute when an on-call rotation shift begins or ends.
NumberOfOnCalls (integer) -- [REQUIRED]
The number of contacts, or shift team members designated to be on call concurrently during a shift. For example, in an on-call schedule containing ten contacts, a value of 2 designates that two of them are on call at any given time.
ShiftCoverages (dict) --
Information about the days of the week included in on-call rotation coverage.
(string) --
(list) --
(dict) --
Information about when an on-call shift begins and ends.
Start (dict) --
Information about when the on-call rotation shift begins.
HourOfDay (integer) -- [REQUIRED]
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) -- [REQUIRED]
The minute when an on-call rotation shift begins or ends.
End (dict) --
Information about when the on-call rotation shift ends.
HourOfDay (integer) -- [REQUIRED]
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) -- [REQUIRED]
The minute when an on-call rotation shift begins or ends.
RecurrenceMultiplier (integer) -- [REQUIRED]
The number of days, weeks, or months a single rotation lasts.
list
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.
(dict) --
A container of a key-value name pair.
Key (string) --
Name of the object key.
Value (string) --
Value of the tag.
string
A token that ensures that the operation is called only once with the specified details.
dict
Response Syntax
{
'RotationArn': 'string'
}
Response Structure
(dict) --
RotationArn (string) --
The Amazon Resource Name (ARN) of the created rotation.
Returns the resolution path of an engagement. For example, the escalation plan engaged in an incident might target an on-call schedule that includes several contacts in a rotation, but just one contact on-call when the incident starts. The resolution path indicates the hierarchy of escalation plan > on-call schedule > contact.
See also: AWS API Documentation
Request Syntax
client.list_page_resolutions(
NextToken='string',
PageId='string'
)
string
A token to start the list. Use this token to get the next set of results.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the contact engaged for the incident.
dict
Response Syntax
{
'NextToken': 'string',
'PageResolutions': [
{
'ContactArn': 'string',
'Type': 'PERSONAL'|'ESCALATION'|'ONCALL_SCHEDULE',
'StageIndex': 123
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token for the next set of items to return. Use this token to get the next set of results.
PageResolutions (list) --
Information about the resolution for an engagement.
(dict) --
Information about the engagement resolution steps. The resolution starts from the first contact, which can be an escalation plan, then resolves to an on-call rotation, and finally to a personal contact.
The ResolutionContact structure describes the information for each node or step in that process. It contains information about different contact types, such as the escalation, rotation, and personal contacts.
ContactArn (string) --
The Amazon Resource Name (ARN) of a contact in the engagement resolution process.
Type (string) --
The type of contact for a resolution step.
StageIndex (integer) --
The stage in the escalation plan that resolves to this contact.
Deletes an existing override for an on-call rotation.
See also: AWS API Documentation
Request Syntax
client.delete_rotation_override(
RotationId='string',
RotationOverrideId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the rotation that was overridden.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the on-call rotation override to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates an override for a rotation in an on-call schedule.
See also: AWS API Documentation
Request Syntax
client.create_rotation_override(
RotationId='string',
NewContactIds=[
'string',
],
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
IdempotencyToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the rotation to create an override for.
list
[REQUIRED]
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.
(string) --
datetime
[REQUIRED]
The date and time when the override goes into effect.
datetime
[REQUIRED]
The date and time when the override ends.
string
A token that ensures that the operation is called only once with the specified details.
dict
Response Syntax
{
'RotationOverrideId': 'string'
}
Response Structure
(dict) --
RotationOverrideId (string) --
The Amazon Resource Name (ARN) of the created rotation override.
Returns a list of shifts based on rotation configuration parameters.
See also: AWS API Documentation
Request Syntax
client.list_preview_rotation_shifts(
RotationStartTime=datetime(2015, 1, 1),
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Members=[
'string',
],
TimeZoneId='string',
Recurrence={
'MonthlySettings': [
{
'DayOfMonth': 123,
'HandOffTime': {
'HourOfDay': 123,
'MinuteOfHour': 123
}
},
],
'WeeklySettings': [
{
'DayOfWeek': 'MON'|'TUE'|'WED'|'THU'|'FRI'|'SAT'|'SUN',
'HandOffTime': {
'HourOfDay': 123,
'MinuteOfHour': 123
}
},
],
'DailySettings': [
{
'HourOfDay': 123,
'MinuteOfHour': 123
},
],
'NumberOfOnCalls': 123,
'ShiftCoverages': {
'string': [
{
'Start': {
'HourOfDay': 123,
'MinuteOfHour': 123
},
'End': {
'HourOfDay': 123,
'MinuteOfHour': 123
}
},
]
},
'RecurrenceMultiplier': 123
},
Overrides=[
{
'NewMembers': [
'string',
],
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
],
NextToken='string',
MaxResults=123
)
datetime
The date and time a rotation would begin. The first shift is calculated from this date and time.
datetime
Used to filter the range of calculated shifts before sending the response back to the user.
datetime
[REQUIRED]
The date and time a rotation shift would end.
list
[REQUIRED]
The contacts that would be assigned to a rotation.
(string) --
string
[REQUIRED]
The time zone the rotation’s activity would be based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul".
dict
[REQUIRED]
Information about how long a rotation would last before restarting at the beginning of the shift order.
MonthlySettings (list) --
Information about on-call rotations that recur monthly.
(dict) --
Information about on-call rotations that recur monthly.
DayOfMonth (integer) -- [REQUIRED]
The day of the month when monthly recurring on-call rotations begin.
HandOffTime (dict) -- [REQUIRED]
The time of day when a monthly recurring on-call shift rotation begins.
HourOfDay (integer) -- [REQUIRED]
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) -- [REQUIRED]
The minute when an on-call rotation shift begins or ends.
WeeklySettings (list) --
Information about on-call rotations that recur weekly.
(dict) --
Information about rotations that recur weekly.
DayOfWeek (string) -- [REQUIRED]
The day of the week when weekly recurring on-call shift rotations begins.
HandOffTime (dict) -- [REQUIRED]
The time of day when a weekly recurring on-call shift rotation begins.
HourOfDay (integer) -- [REQUIRED]
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) -- [REQUIRED]
The minute when an on-call rotation shift begins or ends.
DailySettings (list) --
Information about on-call rotations that recur daily.
(dict) --
Details about when an on-call rotation shift begins or ends.
HourOfDay (integer) -- [REQUIRED]
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) -- [REQUIRED]
The minute when an on-call rotation shift begins or ends.
NumberOfOnCalls (integer) -- [REQUIRED]
The number of contacts, or shift team members designated to be on call concurrently during a shift. For example, in an on-call schedule containing ten contacts, a value of 2 designates that two of them are on call at any given time.
ShiftCoverages (dict) --
Information about the days of the week included in on-call rotation coverage.
(string) --
(list) --
(dict) --
Information about when an on-call shift begins and ends.
Start (dict) --
Information about when the on-call rotation shift begins.
HourOfDay (integer) -- [REQUIRED]
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) -- [REQUIRED]
The minute when an on-call rotation shift begins or ends.
End (dict) --
Information about when the on-call rotation shift ends.
HourOfDay (integer) -- [REQUIRED]
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) -- [REQUIRED]
The minute when an on-call rotation shift begins or ends.
RecurrenceMultiplier (integer) -- [REQUIRED]
The number of days, weeks, or months a single rotation lasts.
list
Information about changes that would be made in a rotation override.
(dict) --
Information about contacts and times that an on-call override replaces.
NewMembers (list) --
Information about contacts to add to an on-call rotation override.
(string) --
StartTime (datetime) --
Information about the time a rotation override would begin.
EndTime (datetime) --
Information about the time a rotation override would end.
string
A token to start the list. This token is used to get the next set of results.
integer
The maximum number of items to return for this call. The call also returns a token that can be specified in a subsequent call to get the next set of results.
dict
Response Syntax
{
'RotationShifts': [
{
'ContactIds': [
'string',
],
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'Type': 'REGULAR'|'OVERRIDDEN',
'ShiftDetails': {
'OverriddenContactIds': [
'string',
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RotationShifts (list) --
Details about a rotation shift, including times, types, and contacts.
(dict) --
Information about a shift that belongs to an on-call rotation.
ContactIds (list) --
The Amazon Resource Names (ARNs) of the contacts who are part of the shift rotation.
(string) --
StartTime (datetime) --
The time a shift rotation begins.
EndTime (datetime) --
The time a shift rotation ends.
Type (string) --
The type of shift rotation.
ShiftDetails (dict) --
Additional information about an on-call rotation shift.
OverriddenContactIds (list) --
The Amazon Resources Names (ARNs) of the contacts who were replaced in a shift when an override was created. If the override is deleted, these contacts are restored to the shift.
(string) --
NextToken (string) --
The token for the next set of items to return. This token is used to get the next set of results.
Retrieves information about an override to an on-call rotation.
See also: AWS API Documentation
Request Syntax
client.get_rotation_override(
RotationId='string',
RotationOverrideId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the overridden rotation to retrieve information about.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the on-call rotation override to retrieve information about.
dict
Response Syntax
{
'RotationOverrideId': 'string',
'RotationArn': 'string',
'NewContactIds': [
'string',
],
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'CreateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
RotationOverrideId (string) --
The Amazon Resource Name (ARN) of the override to an on-call rotation.
RotationArn (string) --
The Amazon Resource Name (ARN) of the on-call rotation that was overridden.
NewContactIds (list) --
The Amazon Resource Names (ARNs) of the contacts assigned to the override of the on-call rotation.
(string) --
StartTime (datetime) --
The date and time when the override goes into effect.
EndTime (datetime) --
The date and time when the override ends.
CreateTime (datetime) --
The date and time when the override was created.
Updates the information specified for an on-call rotation.
See also: AWS API Documentation
Request Syntax
client.update_rotation(
RotationId='string',
ContactIds=[
'string',
],
StartTime=datetime(2015, 1, 1),
TimeZoneId='string',
Recurrence={
'MonthlySettings': [
{
'DayOfMonth': 123,
'HandOffTime': {
'HourOfDay': 123,
'MinuteOfHour': 123
}
},
],
'WeeklySettings': [
{
'DayOfWeek': 'MON'|'TUE'|'WED'|'THU'|'FRI'|'SAT'|'SUN',
'HandOffTime': {
'HourOfDay': 123,
'MinuteOfHour': 123
}
},
],
'DailySettings': [
{
'HourOfDay': 123,
'MinuteOfHour': 123
},
],
'NumberOfOnCalls': 123,
'ShiftCoverages': {
'string': [
{
'Start': {
'HourOfDay': 123,
'MinuteOfHour': 123
},
'End': {
'HourOfDay': 123,
'MinuteOfHour': 123
}
},
]
},
'RecurrenceMultiplier': 123
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the rotation to update.
list
The Amazon Resource Names (ARNs) of the contacts to include in the updated rotation.
The order in which you list the contacts is their shift order in the rotation schedule.
(string) --
datetime
The date and time the rotation goes into effect.
string
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.
dict
[REQUIRED]
Information about how long the updated rotation lasts before restarting at the beginning of the shift order.
MonthlySettings (list) --
Information about on-call rotations that recur monthly.
(dict) --
Information about on-call rotations that recur monthly.
DayOfMonth (integer) -- [REQUIRED]
The day of the month when monthly recurring on-call rotations begin.
HandOffTime (dict) -- [REQUIRED]
The time of day when a monthly recurring on-call shift rotation begins.
HourOfDay (integer) -- [REQUIRED]
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) -- [REQUIRED]
The minute when an on-call rotation shift begins or ends.
WeeklySettings (list) --
Information about on-call rotations that recur weekly.
(dict) --
Information about rotations that recur weekly.
DayOfWeek (string) -- [REQUIRED]
The day of the week when weekly recurring on-call shift rotations begins.
HandOffTime (dict) -- [REQUIRED]
The time of day when a weekly recurring on-call shift rotation begins.
HourOfDay (integer) -- [REQUIRED]
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) -- [REQUIRED]
The minute when an on-call rotation shift begins or ends.
DailySettings (list) --
Information about on-call rotations that recur daily.
(dict) --
Details about when an on-call rotation shift begins or ends.
HourOfDay (integer) -- [REQUIRED]
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) -- [REQUIRED]
The minute when an on-call rotation shift begins or ends.
NumberOfOnCalls (integer) -- [REQUIRED]
The number of contacts, or shift team members designated to be on call concurrently during a shift. For example, in an on-call schedule containing ten contacts, a value of 2 designates that two of them are on call at any given time.
ShiftCoverages (dict) --
Information about the days of the week included in on-call rotation coverage.
(string) --
(list) --
(dict) --
Information about when an on-call shift begins and ends.
Start (dict) --
Information about when the on-call rotation shift begins.
HourOfDay (integer) -- [REQUIRED]
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) -- [REQUIRED]
The minute when an on-call rotation shift begins or ends.
End (dict) --
Information about when the on-call rotation shift ends.
HourOfDay (integer) -- [REQUIRED]
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) -- [REQUIRED]
The minute when an on-call rotation shift begins or ends.
RecurrenceMultiplier (integer) -- [REQUIRED]
The number of days, weeks, or months a single rotation lasts.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves a list of on-call rotations.
See also: AWS API Documentation
Request Syntax
client.list_rotations(
RotationNamePrefix='string',
NextToken='string',
MaxResults=123
)
string
A filter to include rotations in list results based on their common prefix. For example, entering prod returns a list of all rotation names that begin with prod, such as production and prod-1.
string
A token to start the list. Use this token to get the next set of results.
integer
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.
dict
Response Syntax
{
'NextToken': 'string',
'Rotations': [
{
'RotationArn': 'string',
'Name': 'string',
'ContactIds': [
'string',
],
'StartTime': datetime(2015, 1, 1),
'TimeZoneId': 'string',
'Recurrence': {
'MonthlySettings': [
{
'DayOfMonth': 123,
'HandOffTime': {
'HourOfDay': 123,
'MinuteOfHour': 123
}
},
],
'WeeklySettings': [
{
'DayOfWeek': 'MON'|'TUE'|'WED'|'THU'|'FRI'|'SAT'|'SUN',
'HandOffTime': {
'HourOfDay': 123,
'MinuteOfHour': 123
}
},
],
'DailySettings': [
{
'HourOfDay': 123,
'MinuteOfHour': 123
},
],
'NumberOfOnCalls': 123,
'ShiftCoverages': {
'string': [
{
'Start': {
'HourOfDay': 123,
'MinuteOfHour': 123
},
'End': {
'HourOfDay': 123,
'MinuteOfHour': 123
}
},
]
},
'RecurrenceMultiplier': 123
}
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token for the next set of items to return. Use this token to get the next set of results.
Rotations (list) --
Information about rotations that meet the filter criteria.
(dict) --
Information about a rotation in an on-call schedule.
RotationArn (string) --
The Amazon Resource Name (ARN) of the rotation.
Name (string) --
The name of the rotation.
ContactIds (list) --
The Amazon Resource Names (ARNs) of the contacts assigned to the rotation team.
(string) --
StartTime (datetime) --
The date and time the rotation becomes active.
TimeZoneId (string) --
The time zone the rotation’s activity is based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul".
Recurrence (dict) --
Information about when an on-call rotation is in effect and how long the rotation period lasts.
MonthlySettings (list) --
Information about on-call rotations that recur monthly.
(dict) --
Information about on-call rotations that recur monthly.
DayOfMonth (integer) --
The day of the month when monthly recurring on-call rotations begin.
HandOffTime (dict) --
The time of day when a monthly recurring on-call shift rotation begins.
HourOfDay (integer) --
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) --
The minute when an on-call rotation shift begins or ends.
WeeklySettings (list) --
Information about on-call rotations that recur weekly.
(dict) --
Information about rotations that recur weekly.
DayOfWeek (string) --
The day of the week when weekly recurring on-call shift rotations begins.
HandOffTime (dict) --
The time of day when a weekly recurring on-call shift rotation begins.
HourOfDay (integer) --
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) --
The minute when an on-call rotation shift begins or ends.
DailySettings (list) --
Information about on-call rotations that recur daily.
(dict) --
Details about when an on-call rotation shift begins or ends.
HourOfDay (integer) --
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) --
The minute when an on-call rotation shift begins or ends.
NumberOfOnCalls (integer) --
The number of contacts, or shift team members designated to be on call concurrently during a shift. For example, in an on-call schedule containing ten contacts, a value of 2 designates that two of them are on call at any given time.
ShiftCoverages (dict) --
Information about the days of the week included in on-call rotation coverage.
(string) --
(list) --
(dict) --
Information about when an on-call shift begins and ends.
Start (dict) --
Information about when the on-call rotation shift begins.
HourOfDay (integer) --
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) --
The minute when an on-call rotation shift begins or ends.
End (dict) --
Information about when the on-call rotation shift ends.
HourOfDay (integer) --
The hour when an on-call rotation shift begins or ends.
MinuteOfHour (integer) --
The minute when an on-call rotation shift begins or ends.
RecurrenceMultiplier (integer) --
The number of days, weeks, or months a single rotation lasts.
{'Plan': {'RotationIds': ['string']}, 'Type': {'ONCALL_SCHEDULE'}}
Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that Incident Manager uses to engage contacts in phases during an incident.
See also: AWS API Documentation
Request Syntax
client.create_contact(
Alias='string',
DisplayName='string',
Type='PERSONAL'|'ESCALATION'|'ONCALL_SCHEDULE',
Plan={
'Stages': [
{
'DurationInMinutes': 123,
'Targets': [
{
'ChannelTargetInfo': {
'ContactChannelId': 'string',
'RetryIntervalInMinutes': 123
},
'ContactTargetInfo': {
'ContactId': 'string',
'IsEssential': True|False
}
},
]
},
],
'RotationIds': [
'string',
]
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
IdempotencyToken='string'
)
string
[REQUIRED]
The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable.
string
The full name of the contact or escalation plan.
string
[REQUIRED]
To create an escalation plan use ESCALATION. To create a contact use PERSONAL.
dict
[REQUIRED]
A list of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.
Stages (list) --
A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.
(dict) --
A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.
DurationInMinutes (integer) -- [REQUIRED]
The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.
Targets (list) -- [REQUIRED]
The contacts or contact methods that the escalation plan or engagement plan is engaging.
(dict) --
The contact or contact channel that's being engaged.
ChannelTargetInfo (dict) --
Information about the contact channel Incident Manager is engaging.
ContactChannelId (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the contact channel.
RetryIntervalInMinutes (integer) --
The number of minutes to wait to retry sending engagement in the case the engagement initially fails.
ContactTargetInfo (dict) --
Information about the contact that Incident Manager is engaging.
ContactId (string) --
The Amazon Resource Name (ARN) of the contact.
IsEssential (boolean) -- [REQUIRED]
A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.
RotationIds (list) --
The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan.
(string) --
list
Adds a tag to the target. You can only tag resources created in the first Region of your replication set.
(dict) --
A container of a key-value name pair.
Key (string) --
Name of the object key.
Value (string) --
Value of the tag.
string
A token ensuring that the operation is called only once with the specified details.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ContactArn': 'string'
}
Response Structure
(dict) --
ContactArn (string) --
The Amazon Resource Name (ARN) of the created contact or escalation plan.
{'Plan': {'RotationIds': ['string']}, 'Type': {'ONCALL_SCHEDULE'}}
Retrieves information about the specified contact or escalation plan.
See also: AWS API Documentation
Request Syntax
client.get_contact(
ContactId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the contact or escalation plan.
dict
Response Syntax
{
'ContactArn': 'string',
'Alias': 'string',
'DisplayName': 'string',
'Type': 'PERSONAL'|'ESCALATION'|'ONCALL_SCHEDULE',
'Plan': {
'Stages': [
{
'DurationInMinutes': 123,
'Targets': [
{
'ChannelTargetInfo': {
'ContactChannelId': 'string',
'RetryIntervalInMinutes': 123
},
'ContactTargetInfo': {
'ContactId': 'string',
'IsEssential': True|False
}
},
]
},
],
'RotationIds': [
'string',
]
}
}
Response Structure
(dict) --
ContactArn (string) --
The ARN of the contact or escalation plan.
Alias (string) --
The alias of the contact or escalation plan. The alias is unique and identifiable.
DisplayName (string) --
The full name of the contact or escalation plan.
Type (string) --
The type of contact, either PERSONAL or ESCALATION.
Plan (dict) --
Details about the specific timing or stages and targets of the escalation plan or engagement plan.
Stages (list) --
A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.
(dict) --
A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.
DurationInMinutes (integer) --
The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.
Targets (list) --
The contacts or contact methods that the escalation plan or engagement plan is engaging.
(dict) --
The contact or contact channel that's being engaged.
ChannelTargetInfo (dict) --
Information about the contact channel Incident Manager is engaging.
ContactChannelId (string) --
The Amazon Resource Name (ARN) of the contact channel.
RetryIntervalInMinutes (integer) --
The number of minutes to wait to retry sending engagement in the case the engagement initially fails.
ContactTargetInfo (dict) --
Information about the contact that Incident Manager is engaging.
ContactId (string) --
The Amazon Resource Name (ARN) of the contact.
IsEssential (boolean) --
A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.
RotationIds (list) --
The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan.
(string) --
{'Type': {'ONCALL_SCHEDULE'}}
Response {'Contacts': {'Type': {'ONCALL_SCHEDULE'}}}
Lists all contacts and escalation plans in Incident Manager.
See also: AWS API Documentation
Request Syntax
client.list_contacts(
NextToken='string',
MaxResults=123,
AliasPrefix='string',
Type='PERSONAL'|'ESCALATION'|'ONCALL_SCHEDULE'
)
string
The pagination token to continue to the next page of results.
integer
The maximum number of contacts and escalation plans per page of results.
string
Used to list only contacts who's aliases start with the specified prefix.
string
The type of contact. A contact is type PERSONAL and an escalation plan is type ESCALATION.
dict
Response Syntax
{
'NextToken': 'string',
'Contacts': [
{
'ContactArn': 'string',
'Alias': 'string',
'DisplayName': 'string',
'Type': 'PERSONAL'|'ESCALATION'|'ONCALL_SCHEDULE'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The pagination token to continue to the next page of results.
Contacts (list) --
A list of the contacts and escalation plans in your Incident Manager account.
(dict) --
A personal contact or escalation plan that Incident Manager engages during an incident.
ContactArn (string) --
The Amazon Resource Name (ARN) of the contact or escalation plan.
Alias (string) --
The unique and identifiable alias of the contact or escalation plan.
DisplayName (string) --
The full name of the contact or escalation plan.
Type (string) --
Refers to the type of contact. A single contact is type PERSONAL and an escalation plan is type ESCALATION.
{'Plan': {'RotationIds': ['string']}}
Updates the contact or escalation plan specified.
See also: AWS API Documentation
Request Syntax
client.update_contact(
ContactId='string',
DisplayName='string',
Plan={
'Stages': [
{
'DurationInMinutes': 123,
'Targets': [
{
'ChannelTargetInfo': {
'ContactChannelId': 'string',
'RetryIntervalInMinutes': 123
},
'ContactTargetInfo': {
'ContactId': 'string',
'IsEssential': True|False
}
},
]
},
],
'RotationIds': [
'string',
]
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the contact or escalation plan you're updating.
string
The full name of the contact or escalation plan.
dict
A list of stages. A contact has an engagement plan with stages for specified contact channels. An escalation plan uses these stages to contact specified contacts.
Stages (list) --
A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.
(dict) --
A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.
DurationInMinutes (integer) -- [REQUIRED]
The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.
Targets (list) -- [REQUIRED]
The contacts or contact methods that the escalation plan or engagement plan is engaging.
(dict) --
The contact or contact channel that's being engaged.
ChannelTargetInfo (dict) --
Information about the contact channel Incident Manager is engaging.
ContactChannelId (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the contact channel.
RetryIntervalInMinutes (integer) --
The number of minutes to wait to retry sending engagement in the case the engagement initially fails.
ContactTargetInfo (dict) --
Information about the contact that Incident Manager is engaging.
ContactId (string) --
The Amazon Resource Name (ARN) of the contact.
IsEssential (boolean) -- [REQUIRED]
A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.
RotationIds (list) --
The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --