String pageId
The Amazon Resource Name (ARN) of the engagement to a contact channel.
String contactChannelId
The ARN of the contact channel.
String acceptType
The type indicates if the page was DELIVERED or READ.
String note
Information provided by the user when the user acknowledges the page.
String acceptCode
A 6-digit code used to acknowledge the page.
String acceptCodeValidation
An optional field that Incident Manager uses to ENFORCE AcceptCode validation when
acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the
console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user
matches the code sent by Incident Manager with the page.
Incident Manager can also IGNORE AcceptCode validation. Ignoring
AcceptCode validation causes Incident Manager to accept any value entered for the
AcceptCode.
String contactArn
The Amazon Resource Name (ARN) of the contact or escalation plan.
String alias
The unique and identifiable alias of the contact or escalation plan.
String displayName
The full name of the contact or escalation plan.
String type
Refers to the type of contact. A single contact is type PERSONAL and an escalation plan is type
ESCALATION.
String contactChannelArn
The Amazon Resource Name (ARN) of the contact channel.
String contactArn
The ARN of the contact that contains the contact channel.
String name
The name of the contact channel.
String type
The type of the contact channel. Incident Manager supports three contact methods:
SMS
VOICE
ContactChannelAddress deliveryAddress
The details that Incident Manager uses when trying to engage the contact channel.
String activationStatus
A Boolean value describing if the contact channel has been activated or not. If the contact channel isn't activated, Incident Manager can't engage the contact through it.
String simpleAddress
The format is dependent on the type of the contact channel. The following are the expected formats:
SMS - '+' followed by the country code and phone number
VOICE - '+' followed by the country code and phone number
EMAIL - any standard email format
HandOffTime start
Information about when the on-call rotation shift begins.
HandOffTime end
Information about when the on-call rotation shift ends.
String contactId
The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
String name
The name of the contact channel.
String type
Incident Manager supports three types of contact channels:
SMS
VOICE
EMAIL
ContactChannelAddress deliveryAddress
The details that Incident Manager uses when trying to engage the contact channel. The format is dependent on the type of the contact channel. The following are the expected formats:
SMS - '+' followed by the country code and phone number
VOICE - '+' followed by the country code and phone number
EMAIL - any standard email format
Boolean deferActivation
If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't engage your contact channel until it has been activated.
String idempotencyToken
A token ensuring that the operation is called only once with the specified details.
String contactChannelArn
The Amazon Resource Name (ARN) of the contact channel.
String alias
The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable.
String displayName
The full name of the contact or escalation plan.
String type
To create an escalation plan use ESCALATION. To create a contact use PERSONAL.
Plan plan
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.
List<E> tags
Adds a tag to the target. You can only tag resources created in the first Region of your replication set.
String idempotencyToken
A token ensuring that the operation is called only once with the specified details.
String contactArn
The Amazon Resource Name (ARN) of the created contact or escalation plan.
String rotationId
The Amazon Resource Name (ARN) of the rotation to create an override for.
List<E> 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.
Date startTime
The date and time when the override goes into effect.
Date endTime
The date and time when the override ends.
String idempotencyToken
A token that ensures that the operation is called only once with the specified details.
String rotationOverrideId
The Amazon Resource Name (ARN) of the created rotation override.
String name
The name of the rotation.
List<E> contactIds
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.
Date startTime
The date and time that the rotation goes into effect.
String 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.
Designators for time zones that don’t support Daylight Savings Time rules, such as Pacific Standard Time (PST) and Pacific Daylight Time (PDT), are not supported.
RecurrenceSettings recurrence
Information about the rule that specifies when a shift's team members rotate.
List<E> 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.
String idempotencyToken
A token that ensures that the operation is called only once with the specified details.
String rotationArn
The Amazon Resource Name (ARN) of the created rotation.
String contactChannelId
The Amazon Resource Name (ARN) of the contact channel you're deactivating.
String contactChannelId
The Amazon Resource Name (ARN) of the contact channel.
String contactId
The Amazon Resource Name (ARN) of the contact that you're deleting.
String rotationId
The Amazon Resource Name (ARN) of the on-call rotation to delete.
String engagementId
The Amazon Resource Name (ARN) of the engagement you want the details of.
String contactArn
The ARN of the escalation plan or contacts involved in the engagement.
String engagementArn
The ARN of the engagement.
String sender
The user that started the engagement.
String subject
The secure subject of the message that was sent to the contact. Use this field for engagements to
VOICE and EMAIL.
String content
The secure content of the message that was sent to the contact. Use this field for engagements to
VOICE and EMAIL.
String publicSubject
The insecure subject of the message that was sent to the contact. Use this field for engagements to
SMS.
String publicContent
The insecure content of the message that was sent to the contact. Use this field for engagements to
SMS.
String incidentId
The ARN of the incident in which the engagement occurred.
Date startTime
The time that the engagement started.
Date stopTime
The time that the engagement ended.
String pageId
The ID of the engagement to a contact channel.
String pageArn
The Amazon Resource Name (ARN) of the engagement to a contact channel.
String engagementArn
The ARN of the engagement that engaged the contact channel.
String contactArn
The ARN of the contact that was engaged.
String sender
The user that started the engagement.
String subject
The secure subject of the message that was sent to the contact. Use this field for engagements to
VOICE and EMAIL.
String content
The secure content of the message that was sent to the contact. Use this field for engagements to
VOICE and EMAIL.
String publicSubject
The insecure subject of the message that was sent to the contact. Use this field for engagements to
SMS.
String publicContent
The insecure content of the message that was sent to the contact. Use this field for engagements to
SMS.
String incidentId
The ARN of the incident that engaged the contact channel.
Date sentTime
The time the engagement was sent to the contact channel.
Date readTime
The time that the contact channel acknowledged the engagement.
Date deliveryTime
The time that the contact channel received the engagement.
String engagementArn
The Amazon Resource Name (ARN) of the engagement.
String contactArn
The ARN of the escalation plan or contact that Incident Manager is engaging.
String sender
The user that started the engagement.
String incidentId
The ARN of the incident that's engaging the contact.
Date startTime
The time that the engagement began.
Date stopTime
The time that the engagement ended.
String contactChannelId
The Amazon Resource Name (ARN) of the contact channel you want information about.
String contactArn
The ARN of the contact that the channel belongs to.
String contactChannelArn
The ARN of the contact channel.
String name
The name of the contact channel
String type
The type of contact channel. The type is SMS, VOICE, or EMAIL.
ContactChannelAddress deliveryAddress
The details that Incident Manager uses when trying to engage the contact channel.
String activationStatus
A Boolean value indicating if the contact channel has been activated or not.
String contactArn
The Amazon Resource Name (ARN) of the contact or escalation plan.
String contactId
The Amazon Resource Name (ARN) of the contact or escalation plan.
String contactArn
The ARN of the contact or escalation plan.
String alias
The alias of the contact or escalation plan. The alias is unique and identifiable.
String displayName
The full name of the contact or escalation plan.
String type
The type of contact, either PERSONAL or ESCALATION.
Plan plan
Details about the specific timing or stages and targets of the escalation plan or engagement plan.
String rotationOverrideId
The Amazon Resource Name (ARN) of the override to an on-call rotation.
String rotationArn
The Amazon Resource Name (ARN) of the on-call rotation that was overridden.
List<E> newContactIds
The Amazon Resource Names (ARNs) of the contacts assigned to the override of the on-call rotation.
Date startTime
The date and time when the override goes into effect.
Date endTime
The date and time when the override ends.
Date createTime
The date and time when the override was created.
String rotationId
The Amazon Resource Name (ARN) of the on-call rotation to retrieve information about.
String rotationArn
The Amazon Resource Name (ARN) of the on-call rotation.
String name
The name of the on-call rotation.
List<E> contactIds
The Amazon Resource Names (ARNs) of the contacts assigned to the on-call rotation team.
Date startTime
The specified start time for the on-call rotation.
String timeZoneId
The time zone that the rotation’s activity is based on, in Internet Assigned Numbers Authority (IANA) format.
RecurrenceSettings recurrence
Specifies how long a rotation lasts before restarting at the beginning of the shift order.
Integer retryAfterSeconds
String nextToken
The pagination token to continue to the next page of results.
Integer maxResults
The maximum number of contacts and escalation plans per page of results.
String aliasPrefix
Used to list only contacts who's aliases start with the specified prefix.
String type
The type of contact. A contact is type PERSONAL and an escalation plan is type
ESCALATION.
String nextToken
The pagination token to continue to the next page of results.
Integer maxResults
The maximum number of engagements per page of results.
String incidentId
The Amazon Resource Name (ARN) of the incident you're listing engagements for.
TimeRange timeRangeValue
The time range to lists engagements for an incident.
String contactId
The Amazon Resource Name (ARN) of the contact you are retrieving engagements for.
String nextToken
The pagination token to continue to the next page of results.
Integer maxResults
The maximum number of engagements to contact channels to list per page of results.
Date rotationStartTime
The date and time a rotation would begin. The first shift is calculated from this date and time.
Date startTime
Used to filter the range of calculated shifts before sending the response back to the user.
Date endTime
The date and time a rotation shift would end.
List<E> members
The contacts that would be assigned to a rotation.
String timeZoneId
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".
RecurrenceSettings recurrence
Information about how long a rotation would last before restarting at the beginning of the shift order.
List<E> overrides
Information about changes that would be made in a rotation override.
String nextToken
A token to start the list. This token is used to get the next set of results.
Integer maxResults
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.
String rotationId
The Amazon Resource Name (ARN) of the rotation to retrieve information about.
Date startTime
The date and time for the beginning of a time range for listing overrides.
Date endTime
The date and time for the end of a time range for listing overrides.
String nextToken
A token to start the list. Use this token to get the next set of results.
Integer 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.
String rotationId
The Amazon Resource Name (ARN) of the rotation to retrieve shift information about.
Date startTime
The date and time for the beginning of the time range to list shifts for.
Date endTime
The date and time for the end of the time range to list shifts for.
String nextToken
A token to start the list. Use this token to get the next set of results.
Integer 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.
String rotationNamePrefix
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 nextToken
A token to start the list. Use this token to get the next set of results.
Integer 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.
String resourceARN
The Amazon Resource Name (ARN) of the contact or escalation plan.
Integer dayOfMonth
The day of the month when monthly recurring on-call rotations begin.
HandOffTime handOffTime
The time of day when a monthly recurring on-call shift rotation begins.
String pageArn
The Amazon Resource Name (ARN) of the page to the contact channel.
String engagementArn
The ARN of the engagement that this page is part of.
String contactArn
The ARN of the contact that Incident Manager is engaging.
String sender
The user that started the engagement.
String incidentId
The ARN of the incident that's engaging the contact channel.
Date sentTime
The time that Incident Manager engaged the contact channel.
Date deliveryTime
The time the message was delivered to the contact channel.
Date readTime
The time that the contact channel acknowledged engagement.
String contactChannelArn
The Amazon Resource Name (ARN) of the contact channel Incident Manager engaged.
String receiptType
The type follows the engagement cycle, SENT, DELIVERED, and READ.
String receiptInfo
Information provided during the page acknowledgement.
Date receiptTime
The time receipt was SENT, DELIVERED, or READ.
List<E> monthlySettings
Information about on-call rotations that recur monthly.
List<E> weeklySettings
Information about on-call rotations that recur weekly.
List<E> dailySettings
Information about on-call rotations that recur daily.
Integer numberOfOnCalls
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.
Map<K,V> shiftCoverages
Information about the days of the week included in on-call rotation coverage.
Integer recurrenceMultiplier
The number of days, weeks, or months a single rotation lasts.
String rotationArn
The Amazon Resource Name (ARN) of the rotation.
String name
The name of the rotation.
List<E> contactIds
The Amazon Resource Names (ARNs) of the contacts assigned to the rotation team.
Date startTime
The date and time the rotation becomes active.
String timeZoneId
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".
RecurrenceSettings recurrence
Information about when an on-call rotation is in effect and how long the rotation period lasts.
String rotationOverrideId
The Amazon Resource Name (ARN) of the override to an on-call rotation.
List<E> newContactIds
The Amazon Resource Names (ARNs) of the contacts assigned to the override of the on-call rotation.
Date startTime
The time a rotation override begins.
Date endTime
The time a rotation override ends.
Date createTime
The time a rotation override was created.
List<E> contactIds
The Amazon Resource Names (ARNs) of the contacts who are part of the shift rotation.
Date startTime
The time a shift rotation begins.
Date endTime
The time a shift rotation ends.
String type
The type of shift rotation.
ShiftDetails shiftDetails
Additional information about an on-call rotation shift.
String contactChannelId
The Amazon Resource Name (ARN) of the contact channel.
String resourceId
String resourceType
String quotaCode
String serviceCode
String contactId
The Amazon Resource Name (ARN) of the contact being engaged.
String sender
The user that started the engagement.
String subject
The secure subject of the message that was sent to the contact. Use this field for engagements to
VOICE or EMAIL.
String content
The secure content of the message that was sent to the contact. Use this field for engagements to
VOICE or EMAIL.
String publicSubject
The insecure subject of the message that was sent to the contact. Use this field for engagements to
SMS.
String publicContent
The insecure content of the message that was sent to the contact. Use this field for engagements to
SMS.
String incidentId
The ARN of the incident that the engagement is part of.
String idempotencyToken
A token ensuring that the operation is called only once with the specified details.
String engagementArn
The ARN of the engagement.
ChannelTargetInfo channelTargetInfo
Information about the contact channel Incident Manager is engaging.
ContactTargetInfo contactTargetInfo
Information about the contact that Incident Manager is engaging.
String contactChannelId
The Amazon Resource Name (ARN) of the contact channel you want to update.
String name
The name of the contact channel.
ContactChannelAddress deliveryAddress
The details that Incident Manager uses when trying to engage the contact channel.
String contactId
The Amazon Resource Name (ARN) of the contact or escalation plan you're updating.
String displayName
The full name of the contact or escalation plan.
Plan plan
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.
String rotationId
The Amazon Resource Name (ARN) of the rotation to update.
List<E> contactIds
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.
Date startTime
The date and time the rotation goes into effect.
String timeZoneId
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.
Designators for time zones that don’t support Daylight Savings Time Rules, such as Pacific Standard Time (PST) and Pacific Daylight Time (PDT), aren't supported.
RecurrenceSettings recurrence
Information about how long the updated rotation lasts before restarting at the beginning of the shift order.
String dayOfWeek
The day of the week when weekly recurring on-call shift rotations begins.
HandOffTime handOffTime
The time of day when a weekly recurring on-call shift rotation begins.
Copyright © 2025. All rights reserved.