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
The accept code is 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
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 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 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.
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.
String resourceARN
The Amazon Resource Name (ARN) of the contact or escalation plan.
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.
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.
Copyright © 2022. All rights reserved.