APIs.io Engineering Platform Notification Alert Types API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Notification Alert Types API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</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: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.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://apigateway.{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 Amazon API Gateway multi-region endpoint
- url: https://apigateway.{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 Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Notification Alert Types
paths:
  /accounts/{account_id}/alerting/v3/available_alerts:
    get:
      description: Gets a list of all alert types for which an account is eligible.
      operationId: notification-alert-types-get-alert-types
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/aaa_account-id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aaa_response_collection'
                - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: Get Alert Types response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_response_collection'
          description: Get Alert Types response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get Alert Types
      tags:
      - Notification Alert Types
      x-api-token-group:
      - Cloudflare Zero Trust PII Read
      - Notifications Write
      - Notifications Read
      - Account Settings Write
      - Account Settings Read
components:
  schemas:
    aaa_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/aaa_messages'
        messages:
          $ref: '#/components/schemas/aaa_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    aaa_alert-types:
      properties:
        description:
          $ref: '#/components/schemas/aaa_description'
        display_name:
          $ref: '#/components/schemas/aaa_display_name'
        filter_options:
          $ref: '#/components/schemas/aaa_filter_options'
        type:
          $ref: '#/components/schemas/aaa_type'
      type: object
    aaa_type:
      description: Use this value when creating and updating a notification policy.
      example: http_alert_origin_error
      type: string
    aaa_response_collection:
      allOf:
      - $ref: '#/components/schemas/aaa_api-response-collection'
      - properties:
          result:
            additionalProperties:
              items:
                $ref: '#/components/schemas/aaa_alert-types'
              type: array
            example:
              Origin Monitoring:
              - description: High levels of 5xx HTTP errors at your origin.
                display_name: Origin Error Rate Alert
                filter_options:
                - AvailableValues: null
                  ComparisonOperator: ==
                  Key: zones
                  Range: 1-n
                - AvailableValues:
                  - Description: Service-Level Objective of 99.7
                    ID: '99.7'
                  - Description: Service-Level Objective of 99.8
                    ID: '99.8'
                  ComparisonOperator: '>='
                  Key: slo
                  Range: 0-1
                type: http_alert_origin_error
            type: object
    aaa_description:
      description: Describes the alert type.
      example: High levels of 5xx HTTP errors at your origin
      type: string
    aaa_filter_options:
      description: 'Format of additional configuration options (filters) for the alert type. Data type of filters during policy creation: Array of strings.'
      example:
      - AvailableValues: null
        ComparisonOperator: ==
        Key: zones
        Range: 1-n
      - AvailableValues:
        - Description: Service-Level Objective of 99.7
          ID: '99.7'
        - Description: Service-Level Objective of 99.8
          ID: '99.8'
        ComparisonOperator: '>='
        Key: slo
        Range: 0-1
      items: {}
      type: array
    aaa_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    aaa_schemas-api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/aaa_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/aaa_messages'
          example: []
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    aaa_display_name:
      description: Alert type name.
      example: Origin Error Rate Alert
      type: string
    aaa_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    aaa_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/aaa_api-response-common'
      - properties:
          result_info:
            $ref: '#/components/schemas/aaa_result_info'
      type: object
    aaa_account-id:
      description: The account id
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
  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/apigateway/
x-hasEquivalentPaths: true