Lap-Platform AWS Systems Manager Incident Manager Contacts
API version: 2021-05-03
Auth
AWS SigV4
Base URL
Not specified.
Setup
- Configure auth: AWS SigV4
- POST / -- create first resource
Endpoints
39 endpoints across 1 groups. See references/api-spec.lap for full details.
root
| Method | Path | Description |
|---|---|---|
| POST | / | Used to acknowledge an engagement to a contact channel during an incident. |
| POST | / | Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated. |
| POST | / | 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. |
| POST | / | A contact channel is the method that Incident Manager uses to engage your contact. |
| POST | / | Creates a rotation in an on-call schedule. |
| POST | / | Creates an override for a rotation in an on-call schedule. |
| POST | / | To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel. |
| POST | / | 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. |
| POST | / | 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. |
| POST | / | 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. |
| POST | / | Deletes an existing override for an on-call rotation. |
| POST | / | 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. |
| POST | / | Lists details of the engagement to a contact channel. |
| POST | / | Retrieves information about the specified contact or escalation plan. |
| POST | / | List details about a specific contact channel. |
| POST | / | Retrieves the resource policies attached to the specified contact or escalation plan. |
| POST | / | Retrieves information about an on-call rotation. |
| POST | / | Retrieves information about an override to an on-call rotation. |
| POST | / | Lists all contact channels for the specified contact. |
| POST | / | Lists all contacts and escalation plans in Incident Manager. |
| POST | / | Lists all engagements that have happened in an incident. |
| POST | / | Lists all of the engagements to contact channels that have been acknowledged. |
| POST | / | 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. |
| POST | / | Lists the engagements to a contact's contact channels. |
| POST | / | Lists the engagements to contact channels that occurred by engaging a contact. |
| POST | / | 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. |
| POST | / | Retrieves a list of overrides currently specified for an on-call rotation. |
| POST | / | Returns a list of shifts generated by an existing rotation in the system. |
| POST | / | Retrieves a list of on-call rotations. |
| POST | / | Lists the tags of an escalation plan or contact. |
| POST | / | 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. |
| POST | / | 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. |
| POST | / | Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident. |
| POST | / | Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged. |
| POST | / | Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set. |
| POST | / | Removes tags from the specified resource. |
| POST | / | Updates the contact or escalation plan specified. |
| POST | / | Updates a contact's contact channel. |
| POST | / | Updates the information specified for an on-call rotation. |
Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "How to authenticate?" -> See Auth section
Response Tips
- Check response schemas in references/api-spec.lap for field details
- Create/update endpoints typically return the created/updated object
References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
Generated from the official API spec by LAP