Amazon Incident Manager Incident Manager Contact API

openapi: 3.2.0
info:
  title: AWS Systems Manager Incident Manager Contact API
  version: '2018-05-10'
  description: Generated from AWS's published Smithy model for AWS Systems Manager Incident Manager. 5 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: Contact
paths:
  /#CreateContact:
    post:
      operationId: CreateContact
      summary: Create Contact
      description: Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that Incident Manager uses to engage contacts in phases during an incident.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateContactResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsConflictException'
        '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'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsServiceQuotaExceededException'
        '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.CreateContact
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateContactRequest'
      tags:
      - Contact
  /#DeleteContact:
    post:
      operationId: DeleteContact
      summary: Delete Contact
      description: To remove a contact from Incident Manager, you can delete the contact. However, deleting a contact does not remove it from escalation plans and related response plans. Deleting an escalation plan also does not remove it from all related response plans. To modify an escalation plan, we recommend using the UpdateContact action to specify a different existing contact.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteContactResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsConflictException'
        '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.DeleteContact
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteContactRequest'
      tags:
      - Contact
  /#GetContact:
    post:
      operationId: GetContact
      summary: Get Contact
      description: Retrieves information about the specified contact or escalation plan.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetContactResult'
        '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.GetContact
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetContactRequest'
      tags:
      - Contact
  /#ListContacts:
    post:
      operationId: ListContacts
      summary: List Contacts
      description: Lists all contacts and escalation plans in Incident Manager.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListContactsResult'
        '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.ListContacts
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListContactsRequest'
      tags:
      - Contact
  /#UpdateContact:
    post:
      operationId: UpdateContact
      summary: Update Contact
      description: Updates the contact or escalation plan specified.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateContactResult'
        '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'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsServiceQuotaExceededException'
        '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.UpdateContact
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateContactRequest'
      tags:
      - Contact
components:
  schemas:
    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
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: Name of the object key.
        Value:
          type: string
          description: Value of the tag.
    DataEncryptionException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    Plan:
      type: object
      properties:
        Stages:
          type: array
          items:
            $ref: '#/components/schemas/Stage'
          description: A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.
        RotationIds:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan.
    Stage:
      type: object
      properties:
        DurationInMinutes:
          type: integer
          description: The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.
        Targets:
          type: array
          items:
            $ref: '#/components/schemas/Target'
          description: The contacts or contact methods that the escalation plan or engagement plan is engaging.
      required:
      - DurationInMinutes
      - Targets
    GetContactResult:
      type: object
      properties:
        ContactArn:
          type: string
          description: The ARN of the contact or escalation plan.
        Alias:
          type: string
          description: The alias of the contact or escalation plan. The alias is unique and identifiable.
        DisplayName:
          type: string
          description: The full name of the contact or escalation plan.
        Type:
          type: string
          enum:
          - PERSONAL
          - ESCALATION
          - ONCALL_SCHEDULE
          description: The type of contact.
        Plan:
          $ref: '#/components/schemas/Plan'
      required:
      - ContactArn
      - Alias
      - Type
      - Plan
    Target:
      type: object
      properties:
        ChannelTargetInfo:
          $ref: '#/components/schemas/ChannelTargetInfo'
        ContactTargetInfo:
          $ref: '#/components/schemas/ContactTargetInfo'
    UpdateContactRequest:
      type: object
      properties:
        ContactId:
          type: string
          description: The Amazon Resource Name (ARN) of the contact or escalation plan you're updating.
        DisplayName:
          type: string
          description: The full name of the contact or escalation plan.
        Plan:
          $ref: '#/components/schemas/Plan'
      required:
      - ContactId
    DependentEntity:
      type: object
      properties:
        RelationType:
          type: string
          description: The type of relationship between one resource and the other resource that it is related to or depends on.
        DependentResourceIds:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the dependent resources.
      required:
      - RelationType
      - DependentResourceIds
    CreateContactRequest:
      type: object
      properties:
        Alias:
          type: string
          description: The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable.
        DisplayName:
          type: string
          description: The full name of the contact or escalation plan.
        Type:
          type: string
          enum:
          - PERSONAL
          - ESCALATION
          - ONCALL_SCHEDULE
          description: 'The type of contact to create. PERSONAL: A single, individual contact. ESCALATION: An escalation plan. ONCALL_SCHEDULE: An on-call schedule.'
        Plan:
          $ref: '#/components/schemas/Plan'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Adds a tag to the target. You can only tag resources created in the first Region of your replication set.
        IdempotencyToken:
          type: string
          description: A token ensuring that the operation is called only once with the specified details.
      required:
      - Alias
      - Type
      - Plan
    ContactTargetInfo:
      type: object
      properties:
        ContactId:
          type: string
          description: The Amazon Resource Name (ARN) of the contact.
        IsEssential:
          type: boolean
          description: A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.
      required:
      - IsEssential
    DeleteContactRequest:
      type: object
      properties:
        ContactId:
          type: string
          description: The Amazon Resource Name (ARN) of the contact that you're deleting.
      required:
      - ContactId
    ListContactsResult:
      type: object
      properties:
        NextToken:
          type: string
          description: The pagination token to continue to the next page of results.
        Contacts:
          type: array
          items:
            $ref: '#/components/schemas/Contact'
          description: A list of the contacts and escalation plans in your Incident Manager account.
    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
    ListContactsRequest:
      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 contacts and escalation plans per page of results.
        AliasPrefix:
          type: string
          description: Used to list only contacts who's aliases start with the specified prefix.
        Type:
          type: string
          enum:
          - PERSONAL
          - ESCALATION
          - ONCALL_SCHEDULE
          description: The type of contact.
    Contact:
      type: object
      properties:
        ContactArn:
          type: string
          description: The Amazon Resource Name (ARN) of the contact or escalation plan.
        Alias:
          type: string
          description: The unique and identifiable alias of the contact or escalation plan.
        DisplayName:
          type: string
          description: The full name of the contact or escalation plan.
        Type:
          type: string
          enum:
          - PERSONAL
          - ESCALATION
          - ONCALL_SCHEDULE
          description: 'The type of contact. PERSONAL: A single, individual contact. ESCALATION: An escalation plan. ONCALL_SCHEDULE: An on-call schedule.'
      required:
      - ContactArn
      - Alias
      - Type
    ChannelTargetInfo:
      type: object
      properties:
        ContactChannelId:
          type: string
          description: The Amazon Resource Name (ARN) of the contact channel.
        RetryIntervalInMinutes:
          type: integer
          description: The number of minutes to wait before retrying to send engagement if the engagement initially failed.
      required:
      - ContactChannelId
    DeleteContactResult:
      type: object
      properties: {}
    SsmContactsConflictException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
          description: Identifier of the resource in use
        ResourceType:
          type: string
          description: Type of the resource in use
        DependentEntities:
          type: array
          items:
            $ref: '#/components/schemas/DependentEntity'
          description: List of dependent entities containing information on relation type and resourceArns linked to the resource in use
      required:
      - Message
      - ResourceId
      - ResourceType
    CreateContactResult:
      type: object
      properties:
        ContactArn:
          type: string
          description: The Amazon Resource Name (ARN) of the created contact or escalation plan.
      required:
      - ContactArn
    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
    UpdateContactResult:
      type: object
      properties: {}
    SsmContactsAccessDeniedException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    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
    SsmContactsServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
          description: Identifier of the resource affected
        ResourceType:
          type: string
          description: Type of the resource affected
        QuotaCode:
          type: string
          description: Service Quotas requirement to identify originating service
        ServiceCode:
          type: string
          description: Service Quotas requirement to identify originating quota
      required:
      - Message
      - QuotaCode
      - ServiceCode
    SsmContactsInternalServerException:
      type: object
      properties:
        Message:
          type: string
        RetryAfterSeconds:
          type: integer
          description: Advice to clients on when the call can be safely retried
      required:
      - Message
    GetContactRequest:
      type: object
      properties:
        ContactId:
          type: string
          description: The Amazon Resource Name (ARN) of the contact or escalation plan.
      required:
      - ContactId
  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)