AWS Systems Manager Incident Manager API
The AWS Systems Manager Incident Manager API provides programmatic access to create and manage response plans, incidents, timelines, related items, and replication sets for automated incident response.
The AWS Systems Manager Incident Manager API provides programmatic access to create and manage response plans, incidents, timelines, related items, and replication sets for automated incident response.
openapi: 3.0.0
info:
version: 2018-05-10
x-release: v4
title: AWS Systems Manager Incident Manager
description: <p>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. </p> <p>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. </p>
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: "#FFFFFF"
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: [email protected]
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: ssm-incidents
x-aws-signingName: ssm-incidents
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/ssm-incidents-2018-05-10.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/ssm-incidents/
servers:
- url: http://ssm-incidents.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The SSM Incidents multi-region endpoint
- url: https://ssm-incidents.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The SSM Incidents multi-region endpoint
- url: http://ssm-incidents.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The SSM Incidents endpoint for China (Beijing) and China (Ningxia)
- url: https://ssm-incidents.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The SSM Incidents endpoint for China (Beijing) and China (Ningxia)
x-hasEquivalentPaths: true
paths:
/createReplicationSet:
post:
operationId: CreateReplicationSet
description: "A replication set replicates and encrypts your data to the provided Regions with the provided KMS key. "
responses:
"201":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CreateReplicationSetOutput"
"480":
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceQuotaExceededException"
"481":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"482":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"483":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
"484":
description: ConflictException
content:
application/json:
schema:
$ref: "#/components/schemas/ConflictException"
"485":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- regions
properties:
clientToken:
description: A token that ensures that the operation is called only once with the specified details.
type: string
minLength: 0
maxLength: 128
regions:
description: The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.
type: object
minProperties: 1
maxProperties: 3
additionalProperties:
$ref: "#/components/schemas/RegionMapInputValue"
tags:
description: A list of tags to add to the replication set.
type: object
minProperties: 1
maxProperties: 50
additionalProperties:
$ref: "#/components/schemas/TagValue"
summary: Amazon Incident Manager Create Replication Set
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/createResponsePlan:
post:
operationId: CreateResponsePlan
description: Creates a response plan that automates the initial response to incidents. A response plan engages contacts, starts chat channel collaboration, and initiates runbooks at the
beginning of an incident.
responses:
"201":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CreateResponsePlanOutput"
"480":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"481":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"482":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"483":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
"484":
description: ConflictException
content:
application/json:
schema:
$ref: "#/components/schemas/ConflictException"
"485":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- incidentTemplate
- name
properties:
actions:
description: The actions that the response plan starts at the beginning of an incident.
type: array
items:
$ref: "#/components/schemas/Action"
minItems: 0
maxItems: 1
chatChannel:
description: The Chatbot chat channel used for collaboration during an incident.
type: object
properties:
chatbotSns:
allOf:
- $ref: "#/components/schemas/ChatbotSnsConfigurationSet"
- description: "The Amazon SNS targets that Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel by
using the Amazon SNS topics. "
empty:
allOf:
- $ref: "#/components/schemas/EmptyChatChannel"
- description: Used to remove the chat channel from an incident record or response plan.
clientToken:
description: A token ensuring that the operation is called only once with the specified details.
type: string
minLength: 0
maxLength: 128
displayName:
description: The long format of the response plan name. This field can contain spaces.
type: string
minLength: 0
maxLength: 200
engagements:
description: The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.
type: array
items:
$ref: "#/components/schemas/SsmContactsArn"
minItems: 0
maxItems: 5
incidentTemplate:
description: Basic details used in creating a response plan. The response plan is then used to create an incident record.
type: object
properties:
dedupeString:
allOf:
- $ref: "#/components/schemas/DedupeString"
- description: "Used to stop Incident Manager from creating multiple incident records for the same incident. "
impact:
allOf:
- $ref: "#/components/schemas/Impact"
- description: "The impact of the incident on your customers and applications. "
incidentTags:
allOf:
- $ref: "#/components/schemas/TagMap"
- description: Tags to assign to the template. When the <code>StartIncident</code> API action is called, Incident Manager assigns the tags specified in the template to the
incident.
notificationTargets:
allOf:
- $ref: "#/components/schemas/NotificationTargetSet"
- description: The Amazon SNS targets that are notified when updates are made to an incident.
summary:
allOf:
- $ref: "#/components/schemas/IncidentSummary"
- description: The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context.
title:
allOf:
- $ref: "#/components/schemas/IncidentTitle"
- description: "The title of the incident. "
integrations:
description: Information about third-party services integrated into the response plan.
type: array
items:
$ref: "#/components/schemas/Integration"
minItems: 0
maxItems: 1
name:
description: The short format name of the response plan. Can't include spaces.
type: string
pattern: ^[a-zA-Z0-9-_]*$
minLength: 1
maxLength: 200
tags:
description: A list of tags that you are adding to the response plan.
type: object
minProperties: 1
maxProperties: 50
additionalProperties:
$ref: "#/components/schemas/TagValue"
summary: Amazon Incident Manager Create Response Plan
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/createTimelineEvent:
post:
operationId: CreateTimelineEvent
description: Creates a custom timeline event on the incident details page of an incident record. Incident Manager automatically creates timeline events that mark key moments during an incident.
You can create custom timeline events to mark important events that Incident Manager can detect automatically.
responses:
"201":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CreateTimelineEventOutput"
"480":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"481":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"482":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"483":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
"484":
description: ConflictException
content:
application/json:
schema:
$ref: "#/components/schemas/ConflictException"
"485":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- eventData
- eventTime
- eventType
- incidentRecordArn
properties:
clientToken:
description: A token that ensures that a client calls the action only once with the specified details.
type: string
minLength: 0
maxLength: 128
eventData:
description: A short description of the event.
type: string
minLength: 0
maxLength: 12000
eventReferences:
description: Adds one or more references to the <code>TimelineEvent</code>. A reference is an Amazon Web Services resource involved or associated with the incident. To specify a
reference, enter its Amazon Resource Name (ARN). You can also specify a related item associated with a resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a
resource, use the table's ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.
type: array
items:
$ref: "#/components/schemas/EventReference"
minItems: 0
maxItems: 10
eventTime:
description: The time that the event occurred.
type: string
format: date-time
eventType:
description: The type of event. You can create timeline events of type <code>Custom Event</code>.
type: string
minLength: 0
maxLength: 100
incidentRecordArn:
description: The Amazon Resource Name (ARN) of the incident record that the action adds the incident to.
type: string
pattern: ^arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+$
minLength: 0
maxLength: 1000
summary: Amazon Incident Manager Create Timeline Event
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/deleteIncidentRecord:
post:
operationId: DeleteIncidentRecord
description: "Delete an incident record from Incident Manager. "
responses:
"204":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteIncidentRecordOutput"
"480":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"481":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"482":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
"483":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- arn
properties:
arn:
description: The Amazon Resource Name (ARN) of the incident record you are deleting.
type: string
pattern: ^arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+$
minLength: 0
maxLength: 1000
summary: Amazon Incident Manager Delete Incident Record
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/deleteReplicationSet#arn:
post:
operationId: DeleteReplicationSet
description: Deletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data.
responses:
"204":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteReplicationSetOutput"
"480":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"481":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"482":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"483":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
"484":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
parameters:
- name: arn
in: query
required: true
description: The Amazon Resource Name (ARN) of the replication set you're deleting.
schema:
type: string
pattern: ^arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+$
minLength: 0
maxLength: 1000
summary: Amazon Incident Manager Delete Replication Set
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/deleteResourcePolicy:
post:
operationId: DeleteResourcePolicy
description: Deletes the resource policy that Resource Access Manager uses to share your Incident Manager resource.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteResourcePolicyOutput"
"480":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"481":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"482":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"483":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
"484":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- policyId
- resourceArn
properties:
policyId:
description: The ID of the resource policy you're deleting.
type: string
minLength: 0
maxLength: 256
resourceArn:
description: The Amazon Resource Name (ARN) of the resource you're deleting the policy from.
type: string
pattern: ^arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+$
minLength: 0
maxLength: 1000
summary: Amazon Incident Manager Delete Resource Policy
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/deleteResponsePlan:
post:
operationId: DeleteResponsePlan
description: Deletes the specified response plan. Deleting a response plan stops all linked CloudWatch alarms and EventBridge events from creating an incident with this response plan.
responses:
"204":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteResponsePlanOutput"
"480":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"481":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"482":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
"483":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- arn
properties:
arn:
description: The Amazon Resource Name (ARN) of the response plan.
type: string
pattern: ^arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+$
minLength: 0
maxLength: 1000
summary: Amazon Incident Manager Delete Response Plan
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/deleteTimelineEvent:
post:
operationId: DeleteTimelineEvent
description: Deletes a timeline event from an incident.
responses:
"204":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteTimelineEventOutput"
"480":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"481":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"482":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
"483":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- eventId
- incidentRecordArn
properties:
eventId:
description: The ID of the event to update. You can use <code>ListTimelineEvents</code> to find an event's ID.
type: string
minLength: 0
maxLength: 50
incidentRecordArn:
description: The Amazon Resource Name (ARN) of the incident that includes the timeline event.
type: string
pattern: ^arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+$
minLength: 0
maxLength: 1000
summary: Amazon Incident Manager Delete Timeline Event
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/getIncidentRecord#arn:
get:
operationId: GetIncidentRecord
description: Returns the details for the specified incident record.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/GetIncidentRecordOutput"
"480":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"481":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"482":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"483":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
"484":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
parameters:
- name: arn
in: query
required: true
description: The Amazon Resource Name (ARN) of the incident record.
schema:
type: string
pattern: ^arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+$
minLength: 0
maxLength: 1000
summary: Amazon Incident Manager Get Incident Record
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $re
# --- truncated at 32 KB (171 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-incident-manager/refs/heads/main/openapi/amazon-incident-manager-openapi-original.yml