StartIncidentInput is a JSON Structure definition published by Amazon Incident Manager, describing 6 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-incident-manager/refs/heads/main/json-structure/incident-manager-start-incident-input-structure.json",
"name": "StartIncidentInput",
"description": "StartIncidentInput schema",
"type": "object",
"properties": {
"clientToken": {
"allOf": [
{
"$ref": "#/components/schemas/ClientToken"
},
{
"description": "A token ensuring that the operation is called only once with the specified details."
}
]
},
"impact": {
"allOf": [
{
"$ref": "#/components/schemas/Impact"
},
{
"description": "<p>Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.</p> <p class=\"title\"> <b>Possible impacts:</b> </p> <ul> <li> <p> <code>1</code> - Critical impact, this typically relates to full application failure that impacts many to all customers. </p> </li> <li> <p> <code>2</code> - High impact, partial application failure with impact to many customers.</p> </li> <li> <p> <code>3</code> - Medium impact, the application is providing reduced service to customers.</p> </li> <li> <p> <code>4</code> - Low impact, customer might aren't impacted by the problem yet.</p> </li> <li> <p> <code>5</code> - No impact, customers aren't currently impacted but urgent action is needed to avoid impact.</p> </li> </ul>"
}
]
},
"relatedItems": {
"allOf": [
{
"$ref": "#/components/schemas/RelatedItemList"
},
{
"description": "Add related items to the incident for other responders to use. Related items are Amazon Web Services resources, external links, or files uploaded to an Amazon S3 bucket. "
}
]
},
"responsePlanArn": {
"allOf": [
{
"$ref": "#/components/schemas/Arn"
},
{
"description": "The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, Amazon SNS topics, runbooks, title, and impact of the incident. "
}
]
},
"title": {
"allOf": [
{
"$ref": "#/components/schemas/IncidentTitle"
},
{
"description": "Provide a title for the incident. Providing a title overwrites the title provided by the response plan. "
}
]
},
"triggerDetails": {
"allOf": [
{
"$ref": "#/components/schemas/TriggerDetails"
},
{
"description": "Details of what created the incident record in Incident Manager."
}
]
}
},
"required": [
"responsePlanArn"
]
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.