find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-incident-manager:amazon-incident-manager-engagement-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: AWS Systems Manager Incident Manager Engagement API
  version: '2018-05-10'
  description: Generated from AWS's published Smithy model for AWS Systems Manager Incident Manager. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://ssm-contacts.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Engagement
paths:
  /#DescribeEngagement:
    post:
      operationId: DescribeEngagement
      summary: Describe Engagement
      description: Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeEngagementResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsAccessDeniedException'
        '400':
          description: DataEncryptionException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DataEncryptionException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsThrottlingException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SSMContacts.DescribeEngagement
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeEngagementRequest'
      tags:
      - Engagement
  /#ListEngagements:
    post:
      operationId: ListEngagements
      summary: List Engagements
      description: Lists all engagements that have happened in an incident.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListEngagementsResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsInternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SSMContacts.ListEngagements
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListEngagementsRequest'
      tags:
      - Engagement
  /#StartEngagement:
    post:
      operationId: StartEngagement
      summary: Start Engagement
      description: Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartEngagementResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsAccessDeniedException'
        '400':
          description: DataEncryptionException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DataEncryptionException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsThrottlingException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SSMContacts.StartEngagement
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartEngagementRequest'
      tags:
      - Engagement
  /#StopEngagement:
    post:
      operationId: StopEngagement
      summary: Stop Engagement
      description: Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StopEngagementResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SSMContacts.StopEngagement
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StopEngagementRequest'
      tags:
      - Engagement
components:
  schemas:
    SsmContactsAccessDeniedException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    StopEngagementRequest:
      type: object
      properties:
        EngagementId:
          type: string
          description: The Amazon Resource Name (ARN) of the engagement.
        Reason:
          type: string
          description: The reason that you're stopping the engagement.
      required:
      - EngagementId
    DescribeEngagementRequest:
      type: object
      properties:
        EngagementId:
          type: string
          description: The Amazon Resource Name (ARN) of the engagement you want the details of.
      required:
      - EngagementId
    ListEngagementsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: The pagination token to continue to the next page of results.
        MaxResults:
          type: integer
          description: The maximum number of engagements per page of results.
        IncidentId:
          type: string
          description: The Amazon Resource Name (ARN) of the incident you're listing engagements for.
        TimeRangeValue:
          $ref: '#/components/schemas/TimeRange'
    SsmContactsThrottlingException:
      type: object
      properties:
        Message:
          type: string
        QuotaCode:
          type: string
          description: Service Quotas requirement to identify originating service
        ServiceCode:
          type: string
          description: Service Quotas requirement to identify originating quota
        RetryAfterSeconds:
          type: integer
          description: Advice to clients on when the call can be safely retried
      required:
      - Message
    SsmContactsInternalServerException:
      type: object
      properties:
        Message:
          type: string
        RetryAfterSeconds:
          type: integer
          description: Advice to clients on when the call can be safely retried
      required:
      - Message
    DescribeEngagementResult:
      type: object
      properties:
        ContactArn:
          type: string
          description: The ARN of the escalation plan or contacts involved in the engagement.
        EngagementArn:
          type: string
          description: The ARN of the engagement.
        Sender:
          type: string
          description: The user that started the engagement.
        Subject:
          type: string
          description: The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.
        Content:
          type: string
          description: The secure content of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.
        PublicSubject:
          type: string
          description: The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.
        PublicContent:
          type: string
          description: The insecure content of the message that was sent to the contact. Use this field for engagements to SMS.
        IncidentId:
          type: string
          description: The ARN of the incident in which the engagement occurred.
        StartTime:
          type: string
          format: date-time
          description: The time that the engagement started.
        StopTime:
          type: string
          format: date-time
          description: The time that the engagement ended.
      required:
      - ContactArn
      - EngagementArn
      - Sender
      - Subject
      - Content
    TimeRange:
      type: object
      properties:
        StartTime:
          type: string
          format: date-time
          description: The start of the time range.
        EndTime:
          type: string
          format: date-time
          description: The end of the time range.
    SsmContactsValidationException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          type: string
          enum:
          - UNKNOWN_OPERATION
          - CANNOT_PARSE
          - FIELD_VALIDATION_FAILED
          - OTHER
          description: Reason the request failed validation
        Fields:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: The fields that caused the error
      required:
      - Message
    StartEngagementResult:
      type: object
      properties:
        EngagementArn:
          type: string
          description: The ARN of the engagement.
      required:
      - EngagementArn
    SsmContactsResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
          description: Hypothetical resource identifier that was not found
        ResourceType:
          type: string
          description: Hypothetical resource type that was not found
      required:
      - Message
      - ResourceId
      - ResourceType
    Engagement:
      type: object
      properties:
        EngagementArn:
          type: string
          description: The Amazon Resource Name (ARN) of the engagement.
        ContactArn:
          type: string
          description: The ARN of the escalation plan or contact that Incident Manager is engaging.
        Sender:
          type: string
          description: The user that started the engagement.
        IncidentId:
          type: string
          description: The ARN of the incident that's engaging the contact.
        StartTime:
          type: string
          format: date-time
          description: The time that the engagement began.
        StopTime:
          type: string
          format: date-time
          description: The time that the engagement ended.
      required:
      - EngagementArn
      - ContactArn
      - Sender
    StartEngagementRequest:
      type: object
      properties:
        ContactId:
          type: string
          description: The Amazon Resource Name (ARN) of the contact being engaged.
        Sender:
          type: string
          description: The user that started the engagement.
        Subject:
          type: string
          description: The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE or EMAIL.
        Content:
          type: string
          description: The secure content of the message that was sent to the contact. Use this field for engagements to VOICE or EMAIL.
        PublicSubject:
          type: string
          description: The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.
        PublicContent:
          type: string
          description: The insecure content of the message that was sent to the contact. Use this field for engagements to SMS.
        IncidentId:
          type: string
          description: The ARN of the incident that the engagement is part of.
        IdempotencyToken:
          type: string
          description: A token ensuring that the operation is called only once with the specified details.
      required:
      - ContactId
      - Sender
      - Subject
      - Content
    DataEncryptionException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ListEngagementsResult:
      type: object
      properties:
        NextToken:
          type: string
          description: The pagination token to continue to the next page of results.
        Engagements:
          type: array
          items:
            $ref: '#/components/schemas/Engagement'
          description: A list of each engagement that occurred during the specified time range of an incident.
      required:
      - Engagements
    ValidationExceptionField:
      type: object
      properties:
        Name:
          type: string
          description: The name of the field that caused the exception.
        Message:
          type: string
          description: Information about what caused the field to cause an exception.
      required:
      - Name
      - Message
    StopEngagementResult:
      type: object
      properties: {}
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: ssm-contacts
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/ssm-contacts/service/2021-05-03/ssm-contacts-2021-05-03.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)