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-nodes-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 Nodes API
  version: '2017-10-14'
  description: Generated from AWS's published Smithy model for AWS Elemental MediaLive. 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://medialive.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Nodes
paths:
  /prod/clusters/{ClusterId}/nodes:
    post:
      operationId: CreateNode
      summary: Create Node
      description: Create a Node in the specified Cluster. You can also create Nodes using the CreateNodeRegistrationScript. Note that you can't move a Node to another Cluster.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateNodeResponse'
        '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'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
        '422':
          description: UnprocessableEntityException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateNodeRequest'
      tags:
      - Nodes
    get:
      operationId: ListNodes
      summary: List Nodes
      description: Retrieve the list of Nodes.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListNodesResponse'
        '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'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListNodesRequest'
      tags:
      - Nodes
  /prod/clusters/{ClusterId}/nodes/{NodeId}:
    delete:
      operationId: DeleteNode
      summary: Delete Node
      description: Delete a Node. The Node must be IDLE.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteNodeResponse'
        '502':
          description: BadGatewayException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadGatewayException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '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/DeleteNodeRequest'
      tags:
      - Nodes
    get:
      operationId: DescribeNode
      summary: Describe Node
      description: Get details about a Node in the specified Cluster.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeNodeResponse'
        '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/DescribeNodeRequest'
      tags:
      - Nodes
    put:
      operationId: UpdateNode
      summary: Update Node
      description: Change the settings for a Node.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateNodeResponse'
        '502':
          description: BadGatewayException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadGatewayException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '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'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateNodeRequest'
      tags:
      - Nodes
components:
  schemas:
    DeleteNodeResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the Node. It is automatically assigned when the Node is created.
        ChannelPlacementGroups:
          type: array
          items:
            type: string
          description: An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups.
        ClusterId:
          type: string
          description: The ID of the Cluster that the Node belongs to.
        ConnectionState:
          type: string
          enum:
          - CONNECTED
          - DISCONNECTED
          description: The current connection state of the Node.
        Id:
          type: string
          description: The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN.
        InstanceArn:
          type: string
          description: The ARN of the EC2 instance hosting the Node.
        Name:
          type: string
          description: The name that you specified for the Node.
        NodeInterfaceMappings:
          type: array
          items:
            $ref: '#/components/schemas/NodeInterfaceMapping'
          description: Documentation update needed
        Role:
          type: string
          enum:
          - BACKUP
          - ACTIVE
          description: The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.
        State:
          type: string
          enum:
          - CREATED
          - REGISTERING
          - READY_TO_ACTIVATE
          - REGISTRATION_FAILED
          - ACTIVATION_FAILED
          - ACTIVE
          - READY
          - IN_USE
          - DEREGISTERING
          - DRAINING
          - DEREGISTRATION_FAILED
          - DEREGISTERED
          description: The current state of the Node.
        SdiSourceMappings:
          type: array
          items:
            $ref: '#/components/schemas/SdiSourceMapping'
          description: An array of SDI source mappings. Each mapping connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses.
    SdiSourceMapping:
      type: object
      properties:
        CardNumber:
          type: integer
          description: A number that uniquely identifies the SDI card on the node hardware.
        ChannelNumber:
          type: integer
          description: A number that uniquely identifies a port on the SDI card.
        SdiSource:
          type: string
          description: The ID of the SdiSource to associate with this port on this card. You can use the ListSdiSources operation to discover all the IDs.
    TooManyRequestsException:
      type: object
      properties:
        Message:
          type: string
    NotFoundException:
      type: object
      properties:
        Message:
          type: string
    ForbiddenException:
      type: object
      properties:
        Message:
          type: string
    ListNodesRequest:
      type: object
      properties:
        ClusterId:
          type: string
          description: The ID of the cluster
        MaxResults:
          type: integer
          description: The maximum number of items to return.
        NextToken:
          type: string
          description: The token to retrieve the next page of results.
      required:
      - ClusterId
    ValidationError:
      type: object
      properties:
        ElementPath:
          type: string
          description: Path to the source of the error.
        ErrorMessage:
          type: string
          description: The error message.
    DeleteNodeRequest:
      type: object
      properties:
        ClusterId:
          type: string
          description: The ID of the cluster
        NodeId:
          type: string
          description: The ID of the node.
      required:
      - ClusterId
      - NodeId
    GatewayTimeoutException:
      type: object
      properties:
        Message:
          type: string
    NodeInterfaceMappingCreateRequest:
      type: object
      properties:
        LogicalInterfaceName:
          type: string
          description: Specify one of the logicalInterfaceNames that you created in the Cluster that this node belongs to. For example, my-Inputs-Interface.
        NetworkInterfaceMode:
          type: string
          enum:
          - NAT
          - BRIDGE
          description: The style of the network -- NAT or BRIDGE.
        PhysicalInterfaceName:
          type: string
          description: Specify the physical name that corresponds to the logicalInterfaceName that you specified in this interface mapping. For example, Eth1 or ENO1234EXAMPLE.
    CreateNodeResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the Node. It is automatically assigned when the Node is created.
        ChannelPlacementGroups:
          type: array
          items:
            type: string
          description: An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups.
        ClusterId:
          type: string
          description: The ID of the Cluster that the Node belongs to.
        ConnectionState:
          type: string
          enum:
          - CONNECTED
          - DISCONNECTED
          description: The current connection state of the Node.
        Id:
          type: string
          description: The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN.
        InstanceArn:
          type: string
          description: The ARN of the EC2 instance hosting the Node.
        Name:
          type: string
          description: The name that you specified for the Node.
        NodeInterfaceMappings:
          type: array
          items:
            $ref: '#/components/schemas/NodeInterfaceMapping'
          description: Documentation update needed
        Role:
          type: string
          enum:
          - BACKUP
          - ACTIVE
          description: The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.
        State:
          type: string
          enum:
          - CREATED
          - REGISTERING
          - READY_TO_ACTIVATE
          - REGISTRATION_FAILED
          - ACTIVATION_FAILED
          - ACTIVE
          - READY
          - IN_USE
          - DEREGISTERING
          - DRAINING
          - DEREGISTRATION_FAILED
          - DEREGISTERED
          description: The current state of the Node.
        SdiSourceMappings:
          type: array
          items:
            $ref: '#/components/schemas/SdiSourceMapping'
          description: An array of SDI source mappings. Each mapping connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses.
    BadRequestException:
      type: object
      properties:
        Message:
          type: string
    DescribeNodeRequest:
      type: object
      properties:
        ClusterId:
          type: string
          description: The ID of the cluster
        NodeId:
          type: string
          description: The ID of the node.
      required:
      - ClusterId
      - NodeId
    InternalServerErrorException:
      type: object
      properties:
        Message:
          type: string
    BadGatewayException:
      type: object
      properties:
        Message:
          type: string
    DescribeNodeResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the Node. It is automatically assigned when the Node is created.
        ChannelPlacementGroups:
          type: array
          items:
            type: string
          description: An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups.
        ClusterId:
          type: string
          description: The ID of the Cluster that the Node belongs to.
        ConnectionState:
          type: string
          enum:
          - CONNECTED
          - DISCONNECTED
          description: The current connection state of the Node.
        Id:
          type: string
          description: The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN.
        InstanceArn:
          type: string
          description: The ARN of the EC2 instance hosting the Node.
        Name:
          type: string
          description: The name that you specified for the Node.
        NodeInterfaceMappings:
          type: array
          items:
            $ref: '#/components/schemas/NodeInterfaceMapping'
          description: Documentation update needed
        Role:
          type: string
          enum:
          - BACKUP
          - ACTIVE
          description: The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.
        State:
          type: string
          enum:
          - CREATED
          - REGISTERING
          - READY_TO_ACTIVATE
          - REGISTRATION_FAILED
          - ACTIVATION_FAILED
          - ACTIVE
          - READY
          - IN_USE
          - DEREGISTERING
          - DRAINING
          - DEREGISTRATION_FAILED
          - DEREGISTERED
          description: The current state of the Node.
        SdiSourceMappings:
          type: array
          items:
            $ref: '#/components/schemas/SdiSourceMapping'
          description: An array of SDI source mappings. Each mapping connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses.
    CreateNodeRequest:
      type: object
      properties:
        ClusterId:
          type: string
          description: The ID of the cluster.
        Name:
          type: string
          description: The user-specified name of the Node to be created.
        NodeInterfaceMappings:
          type: array
          items:
            $ref: '#/components/schemas/NodeInterfaceMappingCreateRequest'
          description: Documentation update needed
        RequestId:
          type: string
          description: An ID that you assign to a create request. This ID ensures idempotency when creating resources.
        Role:
          type: string
          enum:
          - BACKUP
          - ACTIVE
          description: The initial role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: A collection of key-value pairs.
      required:
      - ClusterId
    DescribeNodeSummary:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the Node. It is automatically assigned when the Node is created.
        ChannelPlacementGroups:
          type: array
          items:
            type: string
          description: An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups.
        ClusterId:
          type: string
          description: The ID of the Cluster that the Node belongs to.
        ConnectionState:
          type: string
          enum:
          - CONNECTED
          - DISCONNECTED
          description: The current connection state of the Node.
        Id:
          type: string
          description: The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN.
        InstanceArn:
          type: string
          description: The EC2 ARN of the Instance associated with the Node.
        ManagedInstanceId:
          type: string
          description: At the routing layer will get it from the callerId/context for use with bring your own device.
        Name:
          type: string
          description: The name that you specified for the Node.
        NodeInterfaceMappings:
          type: array
          items:
            $ref: '#/components/schemas/NodeInterfaceMapping'
          description: Documentation update needed
        Role:
          type: string
          enum:
          - BACKUP
          - ACTIVE
          description: The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.
        State:
          type: string
          enum:
          - CREATED
          - REGISTERING
          - READY_TO_ACTIVATE
          - REGISTRATION_FAILED
          - ACTIVATION_FAILED
          - ACTIVE
          - READY
          - IN_USE
          - DEREGISTERING
          - DRAINING
          - DEREGISTRATION_FAILED
          - DEREGISTERED
          description: The current state of the Node.
        SdiSourceMappings:
          type: array
          items:
            $ref: '#/components/schemas/SdiSourceMapping'
          description: An array of SDI source mappings. Each mapping connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses.
    UpdateNodeRequest:
      type: object
      properties:
        ClusterId:
          type: string
          description: The ID of the cluster
        Name:
          type: string
          description: Include this parameter only if you want to change the current name of the Node. Specify a name that is unique in the Cluster. You can't change the name. Names are case-sensitive.
        NodeId:
          type: string
          description: The ID of the node.
        Role:
          type: string
          enum:
          - BACKUP
          - ACTIVE
          description: The initial role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.
        SdiSourceMappings:
          type: array
          items:
            $ref: '#/components/schemas/SdiSourceMappingUpdateRequest'
          description: The mappings of a SDI capture card port to a logical SDI data stream
      required:
      - ClusterId
      - NodeId
    SdiSourceMappingUpdateRequest:
      type: object
      properties:
        CardNumber:
          type: integer
          description: A number that uniquely identifies the SDI card on the node hardware. For information about how physical cards are identified on your node hardware, see the documentation for your node hardware. The numbering always starts at 1.
        ChannelNumber:
          type: integer
          description: A number that uniquely identifies a port on the card. This must be an SDI port (not a timecode port, for example). For information about how ports are identified on physical cards, see the documentation for your node hardware.
        SdiSource:
          type: string
          description: The ID of a SDI source streaming on the given SDI capture card port.
    NodeInterfaceMapping:
      type: object
      properties:
        LogicalInterfaceName:
          type: string
          description: A uniform logical interface name to address in a MediaLive channel configuration.
        NetworkInterfaceMode:
          type: string
          enum:
          - NAT
          - BRIDGE
        PhysicalInterfaceName:
          type: string
          description: The name of the physical interface on the hardware that will be running Elemental anywhere.
        PhysicalInterfaceIpAddresses:
          type: array
          items:
            type: string
          description: The IP addresses associated with the physical interface on the node hardware.
    ListNodesResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: Token for the next result.
        Nodes:
          type: array
          items:
            $ref: '#/components/schemas/DescribeNodeSummary'
          description: An array of Nodes that exist in the Cluster.
    UnprocessableEntityException:
      type: object
      properties:
        Message:
          type: string
          description: The error message.
        ValidationErrors:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
          description: A collection of validation error responses.
    UpdateNodeResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the Node. It is automatically assigned when the Node is created.
        ChannelPlacementGroups:
          type: array
          items:
            type: string
          description: An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups.
        ClusterId:
          type: string
          description: The ID of the Cluster that the Node belongs to.
        ConnectionState:
          type: string
          enum:
          - CONNECTED
          - DISCONNECTED
          description: The current connection state of the Node.
        Id:
          type: string
          description: The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN.
        InstanceArn:
          type: string
          description: The ARN of the EC2 instance hosting the Node.
        Name:
          type: string
          description: The name that you specified for the Node.
        NodeInterfaceMappings:
          type: array
          items:
            $ref: '#/components/schemas/NodeInterfaceMapping'
          description: Documentation update needed
        Role:
          type: string
          enum:
          - BACKUP
          - ACTIVE
          description: The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.
        State:
          type: string
          enum:
          - CREATED
          - REGISTERING
          - READY_TO_ACTIVATE
          - REGISTRATION_FAILED
          - ACTIVATION_FAILED
          - ACTIVE
          - READY
          - IN_USE
          - DEREGISTERING
          - DRAINING
          - DEREGISTRATION_FAILED
          - DEREGISTERED
          description: The current state of the Node.
        SdiSourceMappings:
          type: array
          items:
            $ref: '#/components/schemas/SdiSourceMapping'
          description: An array of SDI source mappings. Each mapping connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses.
    ConflictException:
      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)