Amazon Incident Manager StartIncident API

openapi: 3.2.0
info:
  version: 1.0.0
  x-release: v4
  title: AWS Systems Manager Incident Manager CreateReplicationSet Start Incident API
  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: mike.ralphson@gmail.com
    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
    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
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)
security:
- hmac: []
tags:
- name: StartIncident
paths:
  /startIncident:
    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'
    post:
      operationId: StartIncident
      description: 'Used to start an incident from CloudWatch alarms, EventBridge events, or manually. '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartIncidentOutput'
        '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:
              - responsePlanArn
              properties:
                clientToken:
                  description: A token ensuring that the operation is called only once with the specified details.
                  type: string
                  minLength: 0
                  maxLength: 128
                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>
                  type: integer
                  minimum: 1
                  maximum: 5
                relatedItems:
                  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. '
                  type: array
                  items:
                    $ref: '#/components/schemas/RelatedItem'
                  minItems: 0
                  maxItems: 100
                responsePlanArn:
                  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. '
                  type: string
                  pattern: ^arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+$
                  minLength: 0
                  maxLength: 1000
                title:
                  description: 'Provide a title for the incident. Providing a title overwrites the title provided by the response plan. '
                  type: string
                  minLength: 0
                  maxLength: 200
                triggerDetails:
                  description: Details about what caused the incident to be created in Incident Manager.
                  type: object
                  properties:
                    rawData:
                      allOf:
                      - $ref: '#/components/schemas/RawData'
                      - description: Raw data passed from either Amazon EventBridge, Amazon CloudWatch, or Incident Manager when an incident is created.
                    source:
                      allOf:
                      - $ref: '#/components/schemas/IncidentSource'
                      - description: 'Identifies the service that sourced the event. All events sourced from within Amazon Web Services begin with "<code>aws.</code>" Customer-generated events can have any value here, as long as it doesn''t begin with "<code>aws.</code>" We recommend the use of Java package-name style reverse domain-name strings. '
                    timestamp:
                      allOf:
                      - $ref: '#/components/schemas/Timestamp'
                      - description: The time that the incident was detected.
                    triggerArn:
                      allOf:
                      - $ref: '#/components/schemas/Arn'
                      - description: The Amazon Resource Name (ARN) of the source that detected the incident.
      summary: Amazon Incident Manager Start Incident
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - StartIncident
components:
  parameters:
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
  schemas:
    Arn:
      type: string
      pattern: ^arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+$
      minLength: 0
      maxLength: 1000
    ItemValue:
      type: object
      properties:
        arn:
          allOf:
          - $ref: '#/components/schemas/Arn'
          - description: The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.
        metricDefinition:
          allOf:
          - $ref: '#/components/schemas/MetricDefinition'
          - description: The metric definition, if the related item is a metric in Amazon CloudWatch.
        pagerDutyIncidentDetail:
          allOf:
          - $ref: '#/components/schemas/PagerDutyIncidentDetail'
          - description: Details about an incident that is associated with a PagerDuty incident.
        url:
          allOf:
          - $ref: '#/components/schemas/Url'
          - description: The URL, if the related item is a non-Amazon Web Services resource.
      description: Describes a related item.
    RawData:
      type: string
      minLength: 0
      maxLength: 10000
    ConflictException: {}
    MetricDefinition:
      type: string
      minLength: 0
      maxLength: 4000
    ThrottlingException: {}
    Url:
      type: string
      minLength: 0
      maxLength: 1000
    PagerDutyIncidentDetail:
      type: object
      required:
      - id
      properties:
        autoResolve:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: Indicates whether to resolve the PagerDuty incident when you resolve the associated Incident Manager incident.
        id:
          allOf:
          - $ref: '#/components/schemas/PagerDutyIncidentDetailIdString'
          - description: The ID of the incident associated with the PagerDuty service for the response plan.
        secretId:
          allOf:
          - $ref: '#/components/schemas/PagerDutyIncidentDetailSecretIdString'
          - description: The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials.
      description: Details about the PagerDuty incident associated with an incident created by an Incident Manager response plan.
    ItemIdentifier:
      type: object
      required:
      - type
      - value
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/ItemType'
          - description: 'The type of related item. '
        value:
          allOf:
          - $ref: '#/components/schemas/ItemValue'
          - description: Details about the related item.
      description: Details and type of a related item.
    IncidentSource:
      type: string
      minLength: 0
      maxLength: 50
    ResourceNotFoundException: {}
    RelatedItemTitleString:
      type: string
      minLength: 0
      maxLength: 200
    RelatedItem:
      type: object
      required:
      - identifier
      properties:
        generatedId:
          allOf:
          - $ref: '#/components/schemas/GeneratedId'
          - description: <p>A unique ID for a <code>RelatedItem</code>.</p> <important> <p>Don't specify this parameter when you add a <code>RelatedItem</code> by using the <a>UpdateRelatedItems</a> API action.</p> </important>
        identifier:
          allOf:
          - $ref: '#/components/schemas/ItemIdentifier'
          - description: Details about the related item.
        title:
          allOf:
          - $ref: '#/components/schemas/RelatedItemTitleString'
          - description: The title of the related item.
      description: Resources that responders use to triage and mitigate the incident.
    StartIncidentOutput:
      type: object
      required:
      - incidentRecordArn
      properties:
        incidentRecordArn:
          allOf:
          - $ref: '#/components/schemas/Arn'
          - description: The ARN of the newly created incident record.
    Boolean:
      type: boolean
    Timestamp:
      type: string
      format: date-time
    AccessDeniedException: {}
    ValidationException: {}
    ItemType:
      type: string
      enum:
      - ANALYSIS
      - INCIDENT
      - METRIC
      - PARENT
      - ATTACHMENT
      - OTHER
      - AUTOMATION
      - INVOLVED_RESOURCE
      - TASK
    PagerDutyIncidentDetailSecretIdString:
      type: string
      minLength: 1
      maxLength: 512
    PagerDutyIncidentDetailIdString:
      type: string
      minLength: 1
      maxLength: 200
    GeneratedId:
      type: string
      pattern: ^related-item/(ANALYSIS|INCIDENT|METRIC|PARENT|ATTACHMENT|OTHER|AUTOMATION|INVOLVED_RESOURCE|TASK)/([0-9]|[A-F]){32}$
      minLength: 0
      maxLength: 200
    InternalServerException: {}
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/ssm-incidents/
x-hasEquivalentPaths: true