AWS Systems Manager Incident Manager
Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web…
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 31
- POSTBatch get incident findings
/batchGetIncidentFindingsRetrieves details about all specified findings for an incident, including descriptive details about each finding. A finding represents a recent application… - POSTCreate replication set
/createReplicationSetA replication set replicates and encrypts your data to the provided Regions with the provided KMS key. - POSTCreate response plan
/createResponsePlanCreates a response plan that automates the initial response to incidents. A response plan engages contacts, starts chat channel collaboration, and initiates… - POSTCreate timeline event
/createTimelineEventCreates a custom timeline event on the incident details page of an incident record. Incident Manager automatically creates timeline events that mark key… - POSTDelete incident record
/deleteIncidentRecordDelete an incident record from Incident Manager. - POSTDelete replication set
/deleteReplicationSet?arn=stringDeletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data. - POSTDelete resource policy
/deleteResourcePolicyDeletes the resource policy that Resource Access Manager uses to share your Incident Manager resource. - POSTDelete response plan
/deleteResponsePlanDeletes the specified response plan. Deleting a response plan stops all linked CloudWatch alarms and EventBridge events from creating an incident with this… - POSTDelete timeline event
/deleteTimelineEventDeletes a timeline event from an incident. - GETGet incident record
/getIncidentRecord?arn=stringReturns the details for the specified incident record. - GETGet replication set
/getReplicationSet?arn=stringRetrieve your Incident Manager replication set. - POSTGet resource policies
/getResourcePolicies?resourceArn=stringRetrieves the resource policies attached to the specified response plan. - GETGet response plan
/getResponsePlan?arn=stringRetrieves the details of the specified response plan. - GETGet timeline event
/getTimelineEvent?incidentRecordArn=string&eventId=stringRetrieves a timeline event based on its ID and incident record. - POSTList incident findings
/listIncidentFindingsRetrieves a list of the IDs of findings, plus their last modified times, that have been identified for a specified incident. A finding represents a recent… - POSTList incident records
/listIncidentRecordsLists all incident records in your account. Use this command to retrieve the Amazon Resource Name (ARN) of the incident record you want to update. - POSTList related items
/listRelatedItemsList all related items for an incident record. - POSTList replication sets
/listReplicationSetsLists details about the replication set configured in your account. - POSTList response plans
/listResponsePlansLists all response plans in your account. - GETList tags for resource
/tags/:resourceArnLists the tags that are attached to the specified response plan or incident. - POSTTag resource
/tags/:resourceArnAdds a tag to a response plan. - DELETEUntag resource
/tags/:resourceArn?tagKeys=Removes a tag from a resource. - POSTList timeline events
/listTimelineEventsLists timeline events for the specified incident record. - POSTPut resource policy
/putResourcePolicyAdds a resource policy to the specified response plan. The resource policy is used to share the response plan using Resource Access Manager (RAM). For more… - POSTStart incident
/startIncidentUsed to start an incident from CloudWatch alarms, EventBridge events, or manually. - POSTUpdate deletion protection
/updateDeletionProtectionUpdate deletion protection to either allow or deny deletion of the final Region in a replication set. - POSTUpdate incident record
/updateIncidentRecordUpdate the details of an incident record. You can use this operation to update an incident record from the defined chat channel. For more information about… - POSTUpdate related items
/updateRelatedItemsAdd or remove related items from the related items tab of an incident record. - POSTUpdate replication set
/updateReplicationSetAdd or delete Regions from your replication set. - POSTUpdate response plan
/updateResponsePlanUpdates the specified response plan. - POSTUpdate timeline event
/updateTimelineEventUpdates a timeline event. You can update events of type Custom Event .
API details
- Base URL
https://ssm-incidents.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 31 operations on 29 pathsPOST 25GET 5DELETE 1
- Description format
- AWS Smithy model, API version
2018-05-10 - 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 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 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 “Batch get incident findings” (POST /batchGetIncidentFindings), 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?
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 Developer tools and has 31 endpoints.
Who publishes the AWS Systems Manager Incident Manager?
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?
Requests go to https://ssm-incidents.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Systems Manager Incident Manager?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Systems Manager Incident Manager have?
31 operations on 29 paths (25 POST, 5 GET, 1 DELETE).
Is forking the AWS Systems Manager Incident Manager free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.