Amazon DevOps Guru Channels API

openapi: 3.1.0
info:
  title: Amazon DevOps Guru Channels API
  version: '2020-12-01'
  description: Generated from AWS's published Smithy model for Amazon DevOps Guru. 3 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://devops-guru.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /channels:
    put:
      operationId: AddNotificationChannel
      summary: Add Notification Channel
      description: Adds a notification channel to DevOps Guru. A notification channel is used to notify you about important
        DevOps Guru events, such as when an insight is generated. If you use an Amazon SNS topic in another account, you must
        attach a policy to it that grants DevOps Guru permission to send it notifications. DevOps Guru adds the required policy
        on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics.
        For more information, see Permissions for Amazon SNS topics. If you use an Amazon SNS topic that is encrypted by an
        Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For
        more information, see Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddNotificationChannelResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddNotificationChannelRequest'
      tags:
      - Channels
    post:
      operationId: ListNotificationChannels
      summary: List Notification Channels
      description: Returns a list of notification channels configured for DevOps Guru. Each notification channel is used to
        notify you when DevOps Guru generates an insight that contains information about how to improve your operations. The
        one supported notification channel is Amazon Simple Notification Service (Amazon SNS).
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListNotificationChannelsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListNotificationChannelsRequest'
      tags:
      - Channels
  /channels/{Id}:
    delete:
      operationId: RemoveNotificationChannel
      summary: Remove Notification Channel
      description: Removes a notification channel from DevOps Guru. A notification channel is used to notify you when DevOps
        Guru generates an insight that contains information about how to improve your operations.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoveNotificationChannelResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoveNotificationChannelRequest'
      tags:
      - Channels
components:
  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: devops-guru
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    AddNotificationChannelRequest:
      type: object
      properties:
        Config:
          $ref: '#/components/schemas/NotificationChannelConfig'
      required:
      - Config
    AddNotificationChannelResponse:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the added notification channel.
      required:
      - Id
    ConflictException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
          description: The ID of the Amazon Web Services resource in which a conflict occurred.
        ResourceType:
          type: string
          description: The type of the Amazon Web Services resource in which a conflict occurred.
      required:
      - Message
      - ResourceId
      - ResourceType
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
        RetryAfterSeconds:
          type: integer
          description: The number of seconds after which the action that caused the internal server exception can be retried.
      required:
      - Message
    ListNotificationChannelsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: The pagination token to use to retrieve the next page of results for this operation. If this value
            is null, it retrieves the first page.
    ListNotificationChannelsResponse:
      type: object
      properties:
        Channels:
          type: array
          items:
            $ref: '#/components/schemas/NotificationChannel'
          description: An array that contains the requested notification channels.
        NextToken:
          type: string
          description: The pagination token to use to retrieve the next page of results for this operation. If there are no
            more pages, this value is null.
    NotificationChannel:
      type: object
      properties:
        Id:
          type: string
          description: The ID of a notification channel.
        Config:
          $ref: '#/components/schemas/NotificationChannelConfig'
    NotificationChannelConfig:
      type: object
      properties:
        Sns:
          $ref: '#/components/schemas/SnsChannelConfig'
        Filters:
          $ref: '#/components/schemas/NotificationFilterConfig'
      required:
      - Sns
    NotificationFilterConfig:
      type: object
      properties:
        Severities:
          type: array
          items:
            type: string
            enum:
            - LOW
            - MEDIUM
            - HIGH
          description: The severity levels that you want to receive notifications for. For example, you can choose to receive
            notifications only for insights with HIGH and MEDIUM severity levels. For more information, see Understanding
            insight severities.
        MessageTypes:
          type: array
          items:
            type: string
            enum:
            - NEW_INSIGHT
            - CLOSED_INSIGHT
            - NEW_ASSOCIATION
            - SEVERITY_UPGRADED
            - NEW_RECOMMENDATION
          description: The events that you want to receive notifications for. For example, you can choose to receive notifications
            only when the severity level is upgraded or a new insight is created.
    RemoveNotificationChannelRequest:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the notification channel to be removed.
      required:
      - Id
    RemoveNotificationChannelResponse:
      type: object
      properties: {}
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
          description: The ID of the Amazon Web Services resource that could not be found.
        ResourceType:
          type: string
          description: The type of the Amazon Web Services resource that could not be found.
      required:
      - Message
      - ResourceId
      - ResourceType
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
    SnsChannelConfig:
      type: object
      properties:
        TopicArn:
          type: string
          description: The Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        QuotaCode:
          type: string
          description: The code of the quota that was exceeded, causing the throttling exception.
        ServiceCode:
          type: string
          description: The code of the service that caused the throttling exception.
        RetryAfterSeconds:
          type: integer
          description: The number of seconds after which the action that caused the throttling exception can be retried.
      required:
      - Message
    ValidationException:
      type: object
      properties:
        Message:
          type: string
          description: A message that describes the validation exception.
        Reason:
          type: string
          enum:
          - UNKNOWN_OPERATION
          - CANNOT_PARSE
          - FIELD_VALIDATION_FAILED
          - OTHER
          - INVALID_PARAMETER_COMBINATION
          - PARAMETER_INCONSISTENT_WITH_SERVICE_STATE
          description: The reason the validation exception was thrown.
        Fields:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
      required:
      - Message
    ValidationExceptionField:
      type: object
      properties:
        Name:
          type: string
          description: The name of the field.
        Message:
          type: string
          description: The message associated with the validation exception with information to help determine its cause.
      required:
      - Name
      - Message
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/devops-guru/service/2020-12-01/devops-guru-2020-12-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)