Amazon MediaLive

Amazon MediaLive Medialive Channelplacementgroups API

The Medialive Channelplacementgroups API from Amazon MediaLive — 2 operation(s) for medialive channelplacementgroups.

Documentation GitHub OpenAPI

Operations 5

POST /prod/clusters/{ClusterId}/channelplacementgroups Create Channel Placement Group #

GET /prod/clusters/{ClusterId}/channelplacementgroups List Channel Placement Groups #

DELETE /prod/clusters/{ClusterId}/channelplacementgroups/{ChannelPlacementGroupId} Delete Channel Placement Group #

GET /prod/clusters/{ClusterId}/channelplacementgroups/{ChannelPlacementGroupId} Describe Channel Placement Group #

PUT /prod/clusters/{ClusterId}/channelplacementgroups/{ChannelPlacementGroupId} Update Channel Placement Group #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/amazon-medialive/openapi/amazon-medialive-channelplacementgroups-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

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-channelplacementgroups-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 Channelplacementgroups 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: Channelplacementgroups
paths:
  /prod/clusters/{ClusterId}/channelplacementgroups:
    post:
      operationId: CreateChannelPlacementGroup
      summary: Create Channel Placement Group
      description: Create a ChannelPlacementGroup in the specified Cluster. As part of the create operation, you specify the Nodes to attach the group to.After you create a ChannelPlacementGroup, you add Channels to the group (you do this by modifying the Channels to add them to a specific group). You now have an association of Channels to ChannelPlacementGroup, and ChannelPlacementGroup to Nodes. This association means that all the Channels in the group are able to run on any of the Nodes associated with the group.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateChannelPlacementGroupResponse'
        '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/CreateChannelPlacementGroupRequest'
      tags:
      - Channelplacementgroups
    get:
      operationId: ListChannelPlacementGroups
      summary: List Channel Placement Groups
      description: Retrieve the list of ChannelPlacementGroups in the specified Cluster.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListChannelPlacementGroupsResponse'
        '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/ListChannelPlacementGroupsRequest'
      tags:
      - Channelplacementgroups
  /prod/clusters/{ClusterId}/channelplacementgroups/{ChannelPlacementGroupId}:
    delete:
      operationId: DeleteChannelPlacementGroup
      summary: Delete Channel Placement Group
      description: Delete the specified ChannelPlacementGroup that exists in the specified Cluster.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteChannelPlacementGroupResponse'
        '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/DeleteChannelPlacementGroupRequest'
      tags:
      - Channelplacementgroups
    get:
      operationId: DescribeChannelPlacementGroup
      summary: Describe Channel Placement Group
      description: Get details about a ChannelPlacementGroup.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeChannelPlacementGroupResponse'
        '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/DescribeChannelPlacementGroupRequest'
      tags:
      - Channelplacementgroups
    put:
      operationId: UpdateChannelPlacementGroup
      summary: Update Channel Placement Group
      description: Change the settings for a ChannelPlacementGroup.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateChannelPlacementGroupResponse'
        '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'
        '422':
          description: UnprocessableEntityException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateChannelPlacementGroupRequest'
      tags:
      - Channelplacementgroups
components:
  schemas:
    DescribeChannelPlacementGroupRequest:
      type: object
      properties:
        ChannelPlacementGroupId:
          type: string
          description: The ID of the channel placement group.
        ClusterId:
          type: string
          description: The ID of the cluster.
      required:
      - ChannelPlacementGroupId
      - ClusterId
    DescribeChannelPlacementGroupResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of this ChannelPlacementGroup. It is automatically assigned when the ChannelPlacementGroup is created.
        Channels:
          type: array
          items:
            type: string
          description: Used in ListChannelPlacementGroupsResult
        ClusterId:
          type: string
          description: The ID of the Cluster that the Node belongs to.
        Id:
          type: string
          description: The ID of the ChannelPlacementGroup. Unique in the AWS account. The ID is the resource-id portion of the ARN.
        Name:
          type: string
          description: The name that you specified for the ChannelPlacementGroup.
        Nodes:
          type: array
          items:
            type: string
          description: An array with one item, which is the single Node that is associated with the ChannelPlacementGroup.
        State:
          type: string
          enum:
          - UNASSIGNED
          - ASSIGNING
          - ASSIGNED
          - DELETING
          - DELETE_FAILED
          - DELETED
          - UNASSIGNING
          description: The current state of the ChannelPlacementGroup.
    CreateChannelPlacementGroupResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of this ChannelPlacementGroup. It is automatically assigned when the ChannelPlacementGroup is created.
        Channels:
          type: array
          items:
            type: string
          description: Used in ListChannelPlacementGroupsResult
        ClusterId:
          type: string
          description: The ID of the Cluster that the Node belongs to.
        Id:
          type: string
          description: The ID of the ChannelPlacementGroup. Unique in the AWS account. The ID is the resource-id portion of the ARN.
        Name:
          type: string
          description: The name that you specified for the ChannelPlacementGroup.
        Nodes:
          type: array
          items:
            type: string
          description: An array with one item, which is the single Node that is associated with the ChannelPlacementGroup.
        State:
          type: string
          enum:
          - UNASSIGNED
          - ASSIGNING
          - ASSIGNED
          - DELETING
          - DELETE_FAILED
          - DELETED
          - UNASSIGNING
          description: The current state of the ChannelPlacementGroup.
    DescribeChannelPlacementGroupSummary:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of this ChannelPlacementGroup. It is automatically assigned when the ChannelPlacementGroup is created.
        Channels:
          type: array
          items:
            type: string
          description: Used in ListChannelPlacementGroupsResult
        ClusterId:
          type: string
          description: The ID of the Cluster that the Node belongs to.
        Id:
          type: string
          description: The ID of the ChannelPlacementGroup. Unique in the AWS account. The ID is the resource-id portion of the ARN.
        Name:
          type: string
          description: The name that you specified for the ChannelPlacementGroup.
        Nodes:
          type: array
          items:
            type: string
          description: An array with one item, which is the single Node that is associated with the ChannelPlacementGroup.
        State:
          type: string
          enum:
          - UNASSIGNED
          - ASSIGNING
          - ASSIGNED
          - DELETING
          - DELETE_FAILED
          - DELETED
          - UNASSIGNING
          description: The current state of the ChannelPlacementGroup.
    TooManyRequestsException:
      type: object
      properties:
        Message:
          type: string
    UpdateChannelPlacementGroupResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of this ChannelPlacementGroup. It is automatically assigned when the ChannelPlacementGroup is created.
        Channels:
          type: array
          items:
            type: string
          description: Used in ListChannelPlacementGroupsResult
        ClusterId:
          type: string
          description: The ID of the Cluster that the Node belongs to.
        Id:
          type: string
          description: The ID of the ChannelPlacementGroup. Unique in the AWS account. The ID is the resource-id portion of the ARN.
        Name:
          type: string
          description: The name that you specified for the ChannelPlacementGroup.
        Nodes:
          type: array
          items:
            type: string
          description: An array with one item, which is the single Node that is associated with the ChannelPlacementGroup.
        State:
          type: string
          enum:
          - UNASSIGNED
          - ASSIGNING
          - ASSIGNED
          - DELETING
          - DELETE_FAILED
          - DELETED
          - UNASSIGNING
          description: The current state of the ChannelPlacementGroup.
    NotFoundException:
      type: object
      properties:
        Message:
          type: string
    ListChannelPlacementGroupsResponse:
      type: object
      properties:
        ChannelPlacementGroups:
          type: array
          items:
            $ref: '#/components/schemas/DescribeChannelPlacementGroupSummary'
          description: An array of ChannelPlacementGroups that exist in the Cluster.
        NextToken:
          type: string
          description: Token for the next result.
    ForbiddenException:
      type: object
      properties:
        Message:
          type: string
    ValidationError:
      type: object
      properties:
        ElementPath:
          type: string
          description: Path to the source of the error.
        ErrorMessage:
          type: string
          description: The error message.
    GatewayTimeoutException:
      type: object
      properties:
        Message:
          type: string
    CreateChannelPlacementGroupRequest:
      type: object
      properties:
        ClusterId:
          type: string
          description: The ID of the cluster.
        Name:
          type: string
          description: Specify a name that is unique in the Cluster. You can't change the name. Names are case-sensitive.
        Nodes:
          type: array
          items:
            type: string
          description: An array of one ID for the Node that you want to associate with the ChannelPlacementGroup. (You can't associate more than one Node with the ChannelPlacementGroup.) The Node and the ChannelPlacementGroup must be in the same Cluster.
        RequestId:
          type: string
          description: An ID that you assign to a create request. This ID ensures idempotency when creating resources. the request.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: A collection of key-value pairs.
      required:
      - ClusterId
    BadRequestException:
      type: object
      properties:
        Message:
          type: string
    InternalServerErrorException:
      type: object
      properties:
        Message:
          type: string
    BadGatewayException:
      type: object
      properties:
        Message:
          type: string
    DeleteChannelPlacementGroupRequest:
      type: object
      properties:
        ChannelPlacementGroupId:
          type: string
          description: The ID of the channel placement group.
        ClusterId:
          type: string
          description: The ID of the cluster.
      required:
      - ChannelPlacementGroupId
      - ClusterId
    DeleteChannelPlacementGroupResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of this ChannelPlacementGroup. It is automatically assigned when the ChannelPlacementGroup is created.
        Channels:
          type: array
          items:
            type: string
          description: Used in ListChannelPlacementGroupsResult
        ClusterId:
          type: string
          description: The ID of the Cluster that the Node belongs to.
        Id:
          type: string
          description: The ID of the ChannelPlacementGroup. Unique in the AWS account. The ID is the resource-id portion of the ARN.
        Name:
          type: string
          description: The name that you specified for the ChannelPlacementGroup.
        Nodes:
          type: array
          items:
            type: string
          description: An array with one item, which is the single Node that is associated with the ChannelPlacementGroup.
        State:
          type: string
          enum:
          - UNASSIGNED
          - ASSIGNING
          - ASSIGNED
          - DELETING
          - DELETE_FAILED
          - DELETED
          - UNASSIGNING
          description: The current state of the ChannelPlacementGroup.
    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.
    UpdateChannelPlacementGroupRequest:
      type: object
      properties:
        ChannelPlacementGroupId:
          type: string
          description: The ID of the channel placement group.
        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 ChannelPlacementGroup. Specify a name that is unique in the Cluster. You can't change the name. Names are case-sensitive.
        Nodes:
          type: array
          items:
            type: string
          description: Include this parameter only if you want to change the list of Nodes that are associated with the ChannelPlacementGroup.
      required:
      - ChannelPlacementGroupId
      - ClusterId
    ListChannelPlacementGroupsRequest:
      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
    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)