Amazon MediaConnect Gateway Instances API

The Gateway Instances API from Amazon MediaConnect — 2 operation(s) for gateway instances.

GitHub OpenAPI

Operations 4

GET /v1/gateway-instances/{GatewayInstanceArn} Describe Gateway Instance #
PUT /v1/gateway-instances/{GatewayInstanceArn} Update Gateway Instance #
DELETE /v1/gateway-instances/{GatewayInstanceArn} Deregister Gateway Instance #
GET /v1/gateway-instances List Gateway Instances #

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-mediaconnect:amazon-mediaconnect-gateway-instances-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.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-mediaconnect-gateway-instances-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS MediaConnect Gateway Instances API
  version: '2018-11-14'
  description: Generated from AWS's published Smithy model for AWS MediaConnect. 4 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://mediaconnect.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /v1/gateway-instances/{GatewayInstanceArn}:
    get:
      operationId: DescribeGatewayInstance
      summary: Describe Gateway Instance
      description: Displays the details of an instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeGatewayInstanceResponse'
        '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'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeGatewayInstanceRequest'
      tags:
      - Gateway Instances
    put:
      operationId: UpdateGatewayInstance
      summary: Update Gateway Instance
      description: Updates an existing gateway instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateGatewayInstanceResponse'
        '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'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateGatewayInstanceRequest'
      tags:
      - Gateway Instances
    delete:
      operationId: DeregisterGatewayInstance
      summary: Deregister Gateway Instance
      description: Deregisters an instance. Before you deregister an instance, all bridges running on the instance must be
        stopped. If you want to deregister an instance without stopping the bridges, you must use the --force option.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeregisterGatewayInstanceResponse'
        '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'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeregisterGatewayInstanceRequest'
      tags:
      - Gateway Instances
  /v1/gateway-instances:
    get:
      operationId: ListGatewayInstances
      summary: List Gateway Instances
      description: Displays a list of instances associated with the Amazon Web Services account. This request returns a paginated
        result. You can use the filterArn property to display only the instances associated with the selected Gateway Amazon
        Resource Name (ARN).
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListGatewayInstancesResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListGatewayInstancesRequest'
      tags:
      - Gateway Instances
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: mediaconnect
  schemas:
    BadRequestException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ConflictException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    DeregisterGatewayInstanceRequest:
      type: object
      properties:
        Force:
          type: boolean
          description: Force the deregistration of an instance. Force will deregister an instance, even if there are bridges
            running on it.
        GatewayInstanceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the gateway that contains the instance that you want to deregister.
      required:
      - GatewayInstanceArn
    DeregisterGatewayInstanceResponse:
      type: object
      properties:
        GatewayInstanceArn:
          type: string
          description: The ARN of the instance.
        InstanceState:
          type: string
          enum:
          - REGISTERING
          - ACTIVE
          - DEREGISTERING
          - DEREGISTERED
          - REGISTRATION_ERROR
          - DEREGISTRATION_ERROR
          description: The status of the instance.
    DescribeGatewayInstanceRequest:
      type: object
      properties:
        GatewayInstanceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the gateway instance that you want to describe.
      required:
      - GatewayInstanceArn
    DescribeGatewayInstanceResponse:
      type: object
      properties:
        GatewayInstance:
          $ref: '#/components/schemas/GatewayInstance'
    ForbiddenException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    GatewayInstance:
      type: object
      properties:
        BridgePlacement:
          type: string
          enum:
          - AVAILABLE
          - LOCKED
          description: The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or
            AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can
            be deployed to this instance.
        ConnectionStatus:
          type: string
          enum:
          - CONNECTED
          - DISCONNECTED
          description: The connection state of the instance.
        GatewayArn:
          type: string
          description: The Amazon Resource Name (ARN) of the instance.
        GatewayInstanceArn:
          type: string
          description: The ARN of the gateway.
        InstanceId:
          type: string
          description: The instance ID generated by the SSM install. This will begin with "mi-".
        InstanceMessages:
          type: array
          items:
            $ref: '#/components/schemas/MessageDetail'
          description: Messages with information about the gateway.
        InstanceState:
          type: string
          enum:
          - REGISTERING
          - ACTIVE
          - DEREGISTERING
          - DEREGISTERED
          - REGISTRATION_ERROR
          - DEREGISTRATION_ERROR
          description: The status of the instance.
        RunningBridgeCount:
          type: integer
          description: The running bridge count.
      required:
      - BridgePlacement
      - ConnectionStatus
      - GatewayArn
      - GatewayInstanceArn
      - InstanceId
      - InstanceState
      - RunningBridgeCount
    InternalServerErrorException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ListGatewayInstancesRequest:
      type: object
      properties:
        FilterArn:
          type: string
          description: Filter the list results to display only the instances associated with the selected Gateway ARN.
        MaxResults:
          type: integer
          description: The maximum number of results to return per API request. For example, you submit a ListInstances request
            with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items.
            (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service
            might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service
            defaults to pagination with a maximum of 10 results per page.
        NextToken:
          type: string
          description: The token that identifies the batch of results that you want to see. For example, you submit a ListInstances
            request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value.
            To see the next batch of results, you can submit the ListInstances request a second time and specify the NextToken
            value.
    ListGatewayInstancesResponse:
      type: object
      properties:
        Instances:
          type: array
          items:
            $ref: '#/components/schemas/ListedGatewayInstance'
          description: A list of instance summaries.
        NextToken:
          type: string
          description: The token that identifies the batch of results that you want to see. For example, you submit a ListInstances
            request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value.
            To see the next batch of results, you can submit the ListInstances request a second time and specify the NextToken
            value.
    ListedGatewayInstance:
      type: object
      properties:
        GatewayArn:
          type: string
          description: The Amazon Resource Name (ARN) of the gateway.
        GatewayInstanceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the instance.
        InstanceId:
          type: string
          description: The managed instance ID generated by the SSM install. This will begin with "mi-".
        InstanceState:
          type: string
          enum:
          - REGISTERING
          - ACTIVE
          - DEREGISTERING
          - DEREGISTERED
          - REGISTRATION_ERROR
          - DEREGISTRATION_ERROR
          description: The status of the instance.
      required:
      - GatewayArn
      - GatewayInstanceArn
      - InstanceId
    MessageDetail:
      type: object
      properties:
        Code:
          type: string
          description: The error code.
        Message:
          type: string
          description: The specific error message that MediaConnect returns to help you understand the reason that the request
            did not succeed.
        ResourceName:
          type: string
          description: The name of the resource.
      required:
      - Code
      - Message
    NotFoundException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ServiceUnavailableException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    TooManyRequestsException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    UpdateGatewayInstanceRequest:
      type: object
      properties:
        BridgePlacement:
          type: string
          enum:
          - AVAILABLE
          - LOCKED
          description: The state of the instance. ACTIVE or INACTIVE.
        GatewayInstanceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the gateway instance that you want to update.
      required:
      - GatewayInstanceArn
    UpdateGatewayInstanceResponse:
      type: object
      properties:
        BridgePlacement:
          type: string
          enum:
          - AVAILABLE
          - LOCKED
          description: The state of the instance. ACTIVE or INACTIVE.
        GatewayInstanceArn:
          type: string
          description: The ARN of the instance that was updated.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/mediaconnect/service/2018-11-14/mediaconnect-2018-11-14.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)