amazonaws.com – ssm-contacts

OpenAPI apis-guru cloud

Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. An incident is any unplanned interruption or reduction in quality of services.

Incident Manager increases incident resolution by notifying responders of impact, highlighting relevant troubleshooting data, and providing collaboration tools to get services back up and running. To achieve the primary goal of reducing the time-to-resolution of critical incidents, Incident Manager automates response plans and enables responder team escalation.

Homepage: https://api.apis.guru/v2/specs/amazonaws.com:ssm-contacts/2021-05-03.json
Provider: amazonaws.com:ssm-contacts / ssm-contacts
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/amazonaws.com/ssm-contacts/2021-05-03/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/amazonaws.com/ssm-contacts/2021-05-03/openapi.yaml

Tools (41)

Extracted live via the executor SDK.

xAmzTargetSsmContactsAcceptPage.acceptPage

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

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

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.
xAmzTargetSsmContactsCreateContactChannel.createContactChannel

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

Creates a rotation in an on-call schedule.
xAmzTargetSsmContactsCreateRotationOverride.createRotationOverride

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

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

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.
xAmzTargetSsmContactsDeleteContactChannel.deleteContactChannel

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.
xAmzTargetSsmContactsDeleteRotation.deleteRotation

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.
xAmzTargetSsmContactsDeleteRotationOverride.deleteRotationOverride

Deletes an existing override for an on-call rotation.
xAmzTargetSsmContactsDescribeEngagement.describeEngagement

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.
xAmzTargetSsmContactsDescribePage.describePage

Lists details of the engagement to a contact channel.
xAmzTargetSsmContactsGetContact.getContact

Retrieves information about the specified contact or escalation plan.
xAmzTargetSsmContactsGetContactChannel.getContactChannel

List details about a specific contact channel.
xAmzTargetSsmContactsGetContactPolicy.getContactPolicy

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

Retrieves information about an on-call rotation.
xAmzTargetSsmContactsGetRotationOverride.getRotationOverride

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

Lists all contact channels for the specified contact.
xAmzTargetSsmContactsListContacts.listContacts

Lists all contacts and escalation plans in Incident Manager.
xAmzTargetSsmContactsListEngagements.listEngagements

Lists all engagements that have happened in an incident.
xAmzTargetSsmContactsListPageReceipts.listPageReceipts

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

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.
xAmzTargetSsmContactsListPagesByContact.listPagesByContact

Lists the engagements to a contact's contact channels.
xAmzTargetSsmContactsListPagesByEngagement.listPagesByEngagement

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

Returns a list of shifts based on rotation configuration parameters.

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

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

Retrieves a list of on-call rotations.
xAmzTargetSsmContactsListRotationShifts.listRotationShifts

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

Lists the tags of an escalation plan or contact.
xAmzTargetSsmContactsPutContactPolicy.putContactPolicy

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 .
xAmzTargetSsmContactsSendActivationCode.sendActivationCode

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.
xAmzTargetSsmContactsStartEngagement.startEngagement

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

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

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

Removes tags from the specified resource.
xAmzTargetSsmContactsUpdateContact.updateContact

Updates the contact or escalation plan specified.
xAmzTargetSsmContactsUpdateContactChannel.updateContactChannel

Updates a contact's contact channel.
xAmzTargetSsmContactsUpdateRotation.updateRotation

Updates the information specified for an on-call rotation.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools