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-medialive:amazon-medialive-alerts-api"

All apis

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

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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 Elemental MediaLive Alerts API
  version: '2017-10-14'
  description: Generated from AWS's published Smithy model for AWS Elemental MediaLive. 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://medialive.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Alerts
paths:
  /prod/channels/{ChannelId}/alerts:
    get:
      operationId: ListAlerts
      summary: List Alerts
      description: List the alerts for a channel with optional filtering based on alert state.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAlertsResponse'
        '502':
          description: BadGatewayException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadGatewayException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '504':
          description: GatewayTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayTimeoutException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAlertsRequest'
      tags:
      - Alerts
  /prod/clusters/{ClusterId}/alerts:
    get:
      operationId: ListClusterAlerts
      summary: List Cluster Alerts
      description: List the alerts for a cluster with optional filtering based on alert state.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListClusterAlertsResponse'
        '502':
          description: BadGatewayException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadGatewayException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '504':
          description: GatewayTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayTimeoutException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListClusterAlertsRequest'
      tags:
      - Alerts
  /prod/multiplexes/{MultiplexId}/alerts:
    get:
      operationId: ListMultiplexAlerts
      summary: List Multiplex Alerts
      description: List the alerts for a multiplex with optional filtering based on alert state.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListMultiplexAlertsResponse'
        '502':
          description: BadGatewayException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadGatewayException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '504':
          description: GatewayTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayTimeoutException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListMultiplexAlertsRequest'
      tags:
      - Alerts
components:
  schemas:
    ListMultiplexAlertsResponse:
      type: object
      properties:
        Alerts:
          type: array
          items:
            $ref: '#/components/schemas/MultiplexAlert'
          description: The alerts found for this multiplex
        NextToken:
          type: string
          description: The token to use to retrieve the next page of results
    BadGatewayException:
      type: object
      properties:
        Message:
          type: string
    ListClusterAlertsResponse:
      type: object
      properties:
        Alerts:
          type: array
          items:
            $ref: '#/components/schemas/ClusterAlert'
          description: The alerts found for this cluster
        NextToken:
          type: string
          description: The token to use to retrieve the next page of results
    MultiplexAlert:
      type: object
      properties:
        AlertType:
          type: string
          description: The type of the alert
        ClearedTimestamp:
          type: string
          format: date-time
          description: The time when the alert was cleared
        Id:
          type: string
          description: The unique ID for this alert instance
        Message:
          type: string
          description: The user facing alert message which can have more context
        PipelineId:
          type: string
          description: The ID of the pipeline this alert is associated with
        SetTimestamp:
          type: string
          format: date-time
          description: The time when the alert was set
        State:
          type: string
          enum:
          - SET
          - CLEARED
          description: The state of the alert
    NotFoundException:
      type: object
      properties:
        Message:
          type: string
    ForbiddenException:
      type: object
      properties:
        Message:
          type: string
    ListAlertsRequest:
      type: object
      properties:
        ChannelId:
          type: string
          description: The unique ID of the channel
        MaxResults:
          type: integer
          description: The maximum number of items to return
        NextToken:
          type: string
          description: The next pagination token
        StateFilter:
          type: string
          description: Specifies the set of alerts to return based on their state. SET - Return only alerts with SET state. CLEARED - Return only alerts with CLEARED state. ALL - Return all alerts.
      required:
      - ChannelId
    ChannelAlert:
      type: object
      properties:
        AlertType:
          type: string
          description: The type of the alert
        ClearedTimestamp:
          type: string
          format: date-time
          description: The time when the alert was cleared
        Id:
          type: string
          description: The unique ID for this alert instance
        Message:
          type: string
          description: The user facing alert message which can have more context
        PipelineId:
          type: string
          description: The ID of the pipeline this alert is associated with
        SetTimestamp:
          type: string
          format: date-time
          description: The time when the alert was set
        State:
          type: string
          enum:
          - SET
          - CLEARED
          description: The state of the alert
    ListClusterAlertsRequest:
      type: object
      properties:
        ClusterId:
          type: string
          description: The unique ID of the cluster
        MaxResults:
          type: integer
          description: The maximum number of items to return
        NextToken:
          type: string
          description: The next pagination token
        StateFilter:
          type: string
          description: Specifies the set of alerts to return based on their state. SET - Return only alerts with SET state. CLEARED - Return only alerts with CLEARED state. ALL - Return all alerts.
      required:
      - ClusterId
    GatewayTimeoutException:
      type: object
      properties:
        Message:
          type: string
    ListAlertsResponse:
      type: object
      properties:
        Alerts:
          type: array
          items:
            $ref: '#/components/schemas/ChannelAlert'
          description: The alerts found for this channel
        NextToken:
          type: string
          description: The token to use to retrieve the next page of results
    ClusterAlert:
      type: object
      properties:
        AlertType:
          type: string
          description: The type of the alert
        ChannelId:
          type: string
          description: The ID of the channel this alert is associated with
        ClearedTimestamp:
          type: string
          format: date-time
          description: The time when the alert was cleared
        Id:
          type: string
          description: The further subtype of this alert
        Message:
          type: string
          description: The user facing alert message which can have more context
        NodeId:
          type: string
          description: The ID of the node this alert is associated with
        SetTimestamp:
          type: string
          format: date-time
          description: The time when the alert was set
        State:
          type: string
          enum:
          - SET
          - CLEARED
          description: The state of the alert
    BadRequestException:
      type: object
      properties:
        Message:
          type: string
    ListMultiplexAlertsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of items to return
        MultiplexId:
          type: string
          description: The unique ID of the multiplex
        NextToken:
          type: string
          description: The next pagination token
        StateFilter:
          type: string
          description: Specifies the set of alerts to return based on their state. SET - Return only alerts with SET state. CLEARED - Return only alerts with CLEARED state. ALL - Return all alerts.
      required:
      - MultiplexId
    InternalServerErrorException:
      type: object
      properties:
        Message:
          type: string
    TooManyRequestsException:
      type: object
      properties:
        Message:
          type: string
  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: medialive
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/medialive/service/2017-10-14/medialive-2017-10-14.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)