Amazon Incident Manager Incident Manager Contact Channel API

openapi: 3.2.0
info:
  title: AWS Systems Manager Incident Manager Contact Channel 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 Channel
paths:
  /#CreateContactChannel:
    post:
      operationId: CreateContactChannel
      summary: Create Contact Channel
      description: A contact channel is the method that Incident Manager uses to engage your contact.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateContactChannelResult'
        '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'
        '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.CreateContactChannel
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateContactChannelRequest'
      tags:
      - Contact Channel
  /#DeleteContactChannel:
    post:
      operationId: DeleteContactChannel
      summary: Delete Contact Channel
      description: To stop receiving engagements on a contact channel, you can delete the channel from a contact. Deleting the contact channel does not remove it from the contact's engagement plan, but the stage that includes the channel will be ignored. If you delete the only contact channel for a contact, you'll no longer be able to engage that contact during an incident.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteContactChannelResult'
        '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.DeleteContactChannel
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteContactChannelRequest'
      tags:
      - Contact Channel
  /#GetContactChannel:
    post:
      operationId: GetContactChannel
      summary: Get Contact Channel
      description: List details about a specific contact channel.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetContactChannelResult'
        '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.GetContactChannel
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetContactChannelRequest'
      tags:
      - Contact Channel
  /#ListContactChannels:
    post:
      operationId: ListContactChannels
      summary: List Contact Channels
      description: Lists all contact channels for the specified contact.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListContactChannelsResult'
        '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.ListContactChannels
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListContactChannelsRequest'
      tags:
      - Contact Channel
  /#UpdateContactChannel:
    post:
      operationId: UpdateContactChannel
      summary: Update Contact Channel
      description: Updates a contact's contact channel.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateContactChannelResult'
        '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'
        '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.UpdateContactChannel
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateContactChannelRequest'
      tags:
      - Contact Channel
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
    DataEncryptionException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    UpdateContactChannelResult:
      type: object
      properties: {}
    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
    CreateContactChannelRequest:
      type: object
      properties:
        ContactId:
          type: string
          description: The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
        Name:
          type: string
          description: The name of the contact channel.
        Type:
          type: string
          enum:
          - SMS
          - VOICE
          - EMAIL
          description: 'Incident Manager supports three types of contact channels: SMS VOICE EMAIL'
        DeliveryAddress:
          $ref: '#/components/schemas/ContactChannelAddress'
        DeferActivation:
          type: boolean
          description: If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't engage your contact channel until it has been activated.
        IdempotencyToken:
          type: string
          description: A token ensuring that the operation is called only once with the specified details.
      required:
      - ContactId
      - Name
      - Type
      - DeliveryAddress
    UpdateContactChannelRequest:
      type: object
      properties:
        ContactChannelId:
          type: string
          description: The Amazon Resource Name (ARN) of the contact channel you want to update.
        Name:
          type: string
          description: The name of the contact channel.
        DeliveryAddress:
          $ref: '#/components/schemas/ContactChannelAddress'
      required:
      - ContactChannelId
    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
    DeleteContactChannelRequest:
      type: object
      properties:
        ContactChannelId:
          type: string
          description: The Amazon Resource Name (ARN) of the contact channel.
      required:
      - ContactChannelId
    GetContactChannelRequest:
      type: object
      properties:
        ContactChannelId:
          type: string
          description: The Amazon Resource Name (ARN) of the contact channel you want information about.
      required:
      - ContactChannelId
    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
    GetContactChannelResult:
      type: object
      properties:
        ContactArn:
          type: string
          description: The ARN of the contact that the channel belongs to.
        ContactChannelArn:
          type: string
          description: The ARN of the contact channel.
        Name:
          type: string
          description: The name of the contact channel
        Type:
          type: string
          enum:
          - SMS
          - VOICE
          - EMAIL
          description: The type of contact channel. The type is SMS, VOICE, or EMAIL.
        DeliveryAddress:
          $ref: '#/components/schemas/ContactChannelAddress'
        ActivationStatus:
          type: string
          enum:
          - ACTIVATED
          - NOT_ACTIVATED
          description: A Boolean value indicating if the contact channel has been activated or not.
      required:
      - ContactArn
      - ContactChannelArn
      - Name
      - Type
      - DeliveryAddress
    DeleteContactChannelResult:
      type: object
      properties: {}
    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
    CreateContactChannelResult:
      type: object
      properties:
        ContactChannelArn:
          type: string
          description: The Amazon Resource Name (ARN) of the contact channel.
      required:
      - ContactChannelArn
    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
    ListContactChannelsRequest:
      type: object
      properties:
        ContactId:
          type: string
          description: The Amazon Resource Name (ARN) of the contact.
        NextToken:
          type: string
          description: The pagination token to continue to the next page of results.
        MaxResults:
          type: integer
          description: The maximum number of contact channels per page.
      required:
      - ContactId
    ListContactChannelsResult:
      type: object
      properties:
        NextToken:
          type: string
          description: The pagination token to continue to the next page of results.
        ContactChannels:
          type: array
          items:
            $ref: '#/components/schemas/ContactChannel'
          description: A list of contact channels related to the specified contact.
      required:
      - ContactChannels
    ContactChannelAddress:
      type: object
      properties:
        SimpleAddress:
          type: string
          description: 'The format is dependent on the type of the contact channel. The following are the expected formats: SMS - ''+'' followed by the country code and phone number VOICE - ''+'' followed by the country code and phone number EMAIL - any standard email format'
    SsmContactsInternalServerException:
      type: object
      properties:
        Message:
          type: string
        RetryAfterSeconds:
          type: integer
          description: Advice to clients on when the call can be safely retried
      required:
      - Message
    ContactChannel:
      type: object
      properties:
        ContactChannelArn:
          type: string
          description: The Amazon Resource Name (ARN) of the contact channel.
        ContactArn:
          type: string
          description: The ARN of the contact that contains the contact channel.
        Name:
          type: string
          description: The name of the contact channel.
        Type:
          type: string
          enum:
          - SMS
          - VOICE
          - EMAIL
          description: 'The type of the contact channel. Incident Manager supports three contact methods: SMS VOICE EMAIL'
        DeliveryAddress:
          $ref: '#/components/schemas/ContactChannelAddress'
        ActivationStatus:
          type: string
          enum:
          - ACTIVATED
          - NOT_ACTIVATED
          description: A Boolean value describing if the contact channel has been activated or not. If the contact channel isn't activated, Incident Manager can't engage the contact through it.
      required:
      - ContactChannelArn
      - ContactArn
      - Name
      - DeliveryAddress
      - ActivationStatus
  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)