AWS Systems Manager Incident Manager Contacts
Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web…
Productivity & workspace#openapi#cloud
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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.
Endpoints 39
- POSTAccept page
/#X-Amz-Target=SSMContacts.AcceptPageUsed to acknowledge an engagement to a contact channel during an incident. - POSTActivate contact channel
/#X-Amz-Target=SSMContacts.ActivateContactChannelActivates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated. - POSTCreate contact
/#X-Amz-Target=SSMContacts.CreateContactContacts are either the contacts that Incident Manager engages during an incident or the escalation plans that Incident Manager uses to engage contacts in… - POSTCreate contact channel
/#X-Amz-Target=SSMContacts.CreateContactChannelA contact channel is the method that Incident Manager uses to engage your contact. - POSTCreate rotation
/#X-Amz-Target=SSMContacts.CreateRotationCreates a rotation in an on-call schedule. - POSTCreate rotation override
/#X-Amz-Target=SSMContacts.CreateRotationOverrideCreates an override for a rotation in an on-call schedule. - POSTDeactivate contact channel
/#X-Amz-Target=SSMContacts.DeactivateContactChannelTo no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel. - POSTDelete contact
/#X-Amz-Target=SSMContacts.DeleteContactTo remove a contact from Incident Manager, you can delete the contact. However, deleting a contact does not remove it from escalation plans and related… - POSTDelete contact channel
/#X-Amz-Target=SSMContacts.DeleteContactChannelTo stop receiving engagements on a contact channel, you can delete the channel from a contact. Deleting the contact channel does not remove it from the… - POSTDelete rotation
/#X-Amz-Target=SSMContacts.DeleteRotationDeletes a rotation from the system. If a rotation belongs to more than one on-call schedule, this operation deletes it from all of them. - POSTDelete rotation override
/#X-Amz-Target=SSMContacts.DeleteRotationOverrideDeletes an existing override for an on-call rotation. - POSTDescribe engagement
/#X-Amz-Target=SSMContacts.DescribeEngagementIncident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during… - POSTDescribe page
/#X-Amz-Target=SSMContacts.DescribePageLists details of the engagement to a contact channel. - POSTGet contact
/#X-Amz-Target=SSMContacts.GetContactRetrieves information about the specified contact or escalation plan. - POSTGet contact channel
/#X-Amz-Target=SSMContacts.GetContactChannelList details about a specific contact channel. - POSTGet contact policy
/#X-Amz-Target=SSMContacts.GetContactPolicyRetrieves the resource policies attached to the specified contact or escalation plan. - POSTGet rotation
/#X-Amz-Target=SSMContacts.GetRotationRetrieves information about an on-call rotation. - POSTGet rotation override
/#X-Amz-Target=SSMContacts.GetRotationOverrideRetrieves information about an override to an on-call rotation. - POSTList contact channels
/#X-Amz-Target=SSMContacts.ListContactChannelsLists all contact channels for the specified contact. - POSTList contacts
/#X-Amz-Target=SSMContacts.ListContactsLists all contacts and escalation plans in Incident Manager. - POSTList engagements
/#X-Amz-Target=SSMContacts.ListEngagementsLists all engagements that have happened in an incident. - POSTList page receipts
/#X-Amz-Target=SSMContacts.ListPageReceiptsLists all of the engagements to contact channels that have been acknowledged. - POSTList page resolutions
/#X-Amz-Target=SSMContacts.ListPageResolutionsReturns the resolution path of an engagement. For example, the escalation plan engaged in an incident might target an on-call schedule that includes several… - POSTList pages by contact
/#X-Amz-Target=SSMContacts.ListPagesByContactLists the engagements to a contact's contact channels. - POSTList pages by engagement
/#X-Amz-Target=SSMContacts.ListPagesByEngagementLists the engagements to contact channels that occurred by engaging a contact. - POSTList preview rotation shifts
/#X-Amz-Target=SSMContacts.ListPreviewRotationShiftsReturns a list of shifts based on rotation configuration parameters. The Incident Manager primarily uses this operation to populate the Preview calendar. It… - POSTList rotation overrides
/#X-Amz-Target=SSMContacts.ListRotationOverridesRetrieves a list of overrides currently specified for an on-call rotation. - POSTList rotation shifts
/#X-Amz-Target=SSMContacts.ListRotationShiftsReturns a list of shifts generated by an existing rotation in the system. - POSTList rotations
/#X-Amz-Target=SSMContacts.ListRotationsRetrieves a list of on-call rotations. - POSTList tags for resource
/#X-Amz-Target=SSMContacts.ListTagsForResourceLists the tags of a contact, escalation plan, rotation, or on-call schedule. - POSTPut contact policy
/#X-Amz-Target=SSMContacts.PutContactPolicyAdds 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… - POSTSend activation code
/#X-Amz-Target=SSMContacts.SendActivationCodeSends 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… - POSTStart engagement
/#X-Amz-Target=SSMContacts.StartEngagementStarts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident. - POSTStop engagement
/#X-Amz-Target=SSMContacts.StopEngagementStops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged. - POSTTag resource
/#X-Amz-Target=SSMContacts.TagResourceTags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set. - POSTUntag resource
/#X-Amz-Target=SSMContacts.UntagResourceRemoves tags from the specified resource. - POSTUpdate contact
/#X-Amz-Target=SSMContacts.UpdateContactUpdates the contact or escalation plan specified. - POSTUpdate contact channel
/#X-Amz-Target=SSMContacts.UpdateContactChannelUpdates a contact's contact channel. - POSTUpdate rotation
/#X-Amz-Target=SSMContacts.UpdateRotationUpdates the information specified for an on-call rotation.
API details
- Base URL
https://ssm-contacts.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 39 operations on 39 pathsPOST 39
- Description format
- AWS Smithy model, API version
2021-05-03 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Systems Manager Incident Manager Contacts in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Systems Manager Incident Manager Contacts collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Accept page” (POST /#X-Amz-Target=SSMContacts.AcceptPage), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Systems Manager Incident Manager Contacts?
Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web… It is listed under Productivity & workspace and has 39 endpoints.
Who publishes the AWS Systems Manager Incident Manager Contacts?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Systems Manager Incident Manager Contacts?
Requests go to https://ssm-contacts.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Systems Manager Incident Manager Contacts?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Systems Manager Incident Manager Contacts have?
39 operations on 39 paths (39 POST).
Is forking the AWS Systems Manager Incident Manager Contacts free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.