AWS.SSMContacts — AWS SDK for JavaScript (original) (raw)

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

acceptPage(params = {}, callback) ⇒ AWS.Request

Used to acknowledge an engagement to a contact channel during an incident.

activateContactChannel(params = {}, callback) ⇒ AWS.Request

Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.

createContact(params = {}, callback) ⇒ AWS.Request

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.

createContactChannel(params = {}, callback) ⇒ AWS.Request

A contact channel is the method that Incident Manager uses to engage your contact.

createRotation(params = {}, callback) ⇒ AWS.Request

Creates a rotation in an on-call schedule.

createRotationOverride(params = {}, callback) ⇒ AWS.Request

Creates an override for a rotation in an on-call schedule.

deactivateContactChannel(params = {}, callback) ⇒ AWS.Request

To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.

deleteContact(params = {}, callback) ⇒ AWS.Request

To remove a contact from Incident Manager, you can delete the contact. Deleting a contact removes them from all escalation plans and related response plans. Deleting an escalation plan removes it from all related response plans. You will have to recreate the contact and its contact channels before you can use it again.

deleteContactChannel(params = {}, callback) ⇒ AWS.Request

To no longer receive engagements on a contact channel, you can delete the channel from a contact. Deleting the contact channel removes it from the contact's engagement plan. If you delete the only contact channel for a contact, you won't be able to engage that contact during an incident.

deleteRotation(params = {}, callback) ⇒ AWS.Request

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.

deleteRotationOverride(params = {}, callback) ⇒ AWS.Request

Deletes an existing override for an on-call rotation.

describeEngagement(params = {}, callback) ⇒ AWS.Request

Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.

describePage(params = {}, callback) ⇒ AWS.Request

Lists details of the engagement to a contact channel.

getContact(params = {}, callback) ⇒ AWS.Request

Retrieves information about the specified contact or escalation plan.

getContactChannel(params = {}, callback) ⇒ AWS.Request

List details about a specific contact channel.

getContactPolicy(params = {}, callback) ⇒ AWS.Request

Retrieves the resource policies attached to the specified contact or escalation plan.

getRotation(params = {}, callback) ⇒ AWS.Request

Retrieves information about an on-call rotation.

getRotationOverride(params = {}, callback) ⇒ AWS.Request

Retrieves information about an override to an on-call rotation.

listContactChannels(params = {}, callback) ⇒ AWS.Request

Lists all contact channels for the specified contact.

listContacts(params = {}, callback) ⇒ AWS.Request

Lists all contacts and escalation plans in Incident Manager.

listEngagements(params = {}, callback) ⇒ AWS.Request

Lists all engagements that have happened in an incident.

Lists all of the engagements to contact channels that have been acknowledged.

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.

listPagesByContact(params = {}, callback) ⇒ AWS.Request

Lists the engagements to a contact's contact channels.

listPagesByEngagement(params = {}, callback) ⇒ AWS.Request

Lists the engagements to contact channels that occurred by engaging a contact.

listPreviewRotationShifts(params = {}, callback) ⇒ AWS.Request

Returns a list of shifts based on rotation configuration parameters.

Note: The Incident Manager primarily uses this operation to populate the Preview calendar. It is not typically run by end users.

listRotationOverrides(params = {}, callback) ⇒ AWS.Request

Retrieves a list of overrides currently specified for an on-call rotation.

listRotations(params = {}, callback) ⇒ AWS.Request

Retrieves a list of on-call rotations.

listRotationShifts(params = {}, callback) ⇒ AWS.Request

Returns a list of shifts generated by an existing rotation in the system.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags of an escalation plan or contact.

putContactPolicy(params = {}, callback) ⇒ AWS.Request

Adds a resource policy to the specified contact or escalation plan. The resource policy is used to share the contact or escalation plan using Resource Access Manager (RAM). For more information about cross-account sharing, see Setting up cross-account functionality.

sendActivationCode(params = {}, callback) ⇒ AWS.Request

Sends an activation code to a contact channel. The contact can use this code to activate the contact channel in the console or with the ActivateChannel operation. Incident Manager can't engage a contact channel until it has been activated.

startEngagement(params = {}, callback) ⇒ AWS.Request

Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.

stopEngagement(params = {}, callback) ⇒ AWS.Request

Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.

tagResource(params = {}, callback) ⇒ AWS.Request

Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from the specified resource.

updateContact(params = {}, callback) ⇒ AWS.Request

Updates the contact or escalation plan specified.

updateContactChannel(params = {}, callback) ⇒ AWS.Request

Updates a contact's contact channel.

updateRotation(params = {}, callback) ⇒ AWS.Request

Updates the information specified for an on-call rotation.