The Gateways API from Amazon MediaConnect — 2 operation(s) for gateways.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/amazon-mediaconnect:amazon-mediaconnect-gateways-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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: 3.1.0
info:
title: AWS MediaConnect Gateways 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/gateways:
post:
operationId: CreateGateway
summary: Create Gateway
description: Creates a new gateway. The request must include at least one network (up to four).
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateGatewayResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'420':
description: CreateGateway420Exception
content:
application/json:
schema:
$ref: '#/components/schemas/CreateGateway420Exception'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'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/CreateGatewayRequest'
tags:
- Gateways
get:
operationId: ListGateways
summary: List Gateways
description: Displays a list of gateways that are associated with this account. This request returns a paginated result.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListGatewaysResponse'
'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/ListGatewaysRequest'
tags:
- Gateways
/v1/gateways/{GatewayArn}:
get:
operationId: DescribeGateway
summary: Describe Gateway
description: Displays the details of a gateway. The response includes the gateway Amazon Resource Name (ARN), name,
and CIDR blocks, as well as details about the networks.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeGatewayResponse'
'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/DescribeGatewayRequest'
tags:
- Gateways
delete:
operationId: DeleteGateway
summary: Delete Gateway
description: Deletes a gateway. Before you can delete a gateway, you must deregister its instances and delete its bridges.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteGatewayResponse'
'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/DeleteGatewayRequest'
tags:
- Gateways
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
CreateGateway420Exception:
type: object
properties:
Message:
type: string
required:
- Message
CreateGatewayRequest:
type: object
properties:
EgressCidrBlocks:
type: array
items:
type: string
description: The range of IP addresses that are allowed to contribute content or initiate output requests for flows
communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing
(CIDR) block; for example, 10.0.0.0/16.
Name:
type: string
description: The name of the gateway. This name can not be modified after the gateway is created.
Networks:
type: array
items:
$ref: '#/components/schemas/GatewayNetwork'
description: The list of networks that you want to add to the gateway.
required:
- EgressCidrBlocks
- Name
- Networks
CreateGatewayResponse:
type: object
properties:
Gateway:
$ref: '#/components/schemas/Gateway'
DeleteGatewayRequest:
type: object
properties:
GatewayArn:
type: string
description: The Amazon Resource Name (ARN) of the gateway that you want to delete.
required:
- GatewayArn
DeleteGatewayResponse:
type: object
properties:
GatewayArn:
type: string
description: The ARN of the gateway that was deleted.
DescribeGatewayRequest:
type: object
properties:
GatewayArn:
type: string
description: The ARN of the gateway that you want to describe.
required:
- GatewayArn
DescribeGatewayResponse:
type: object
properties:
Gateway:
$ref: '#/components/schemas/Gateway'
ForbiddenException:
type: object
properties:
Message:
type: string
required:
- Message
Gateway:
type: object
properties:
EgressCidrBlocks:
type: array
items:
type: string
description: The range of IP addresses that contribute content or initiate output requests for flows communicating
with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block;
for example, 10.0.0.0/16.
GatewayArn:
type: string
description: The Amazon Resource Name (ARN) of the gateway.
GatewayMessages:
type: array
items:
$ref: '#/components/schemas/MessageDetail'
description: Messages with information about the gateway.
GatewayState:
type: string
enum:
- CREATING
- ACTIVE
- UPDATING
- ERROR
- DELETING
- DELETED
description: The current status of the gateway.
Name:
type: string
description: The name of the gateway. This name can not be modified after the gateway is created.
Networks:
type: array
items:
$ref: '#/components/schemas/GatewayNetwork'
description: The list of networks in the gateway.
required:
- EgressCidrBlocks
- GatewayArn
- Name
- Networks
GatewayNetwork:
type: object
properties:
CidrBlock:
type: string
description: A unique IP address range to use for this network. These IP addresses should be in the form of a Classless
Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
Name:
type: string
description: The name of the network. This name is used to reference the network and must be unique among networks
in this gateway.
required:
- CidrBlock
- Name
InternalServerErrorException:
type: object
properties:
Message:
type: string
required:
- Message
ListGatewaysRequest:
type: object
properties:
MaxResults:
type: integer
description: The maximum number of results to return per API request. For example, you submit a ListGateways 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 ListGateways
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 ListGateways request a second time and specify the NextToken
value.
ListGatewaysResponse:
type: object
properties:
Gateways:
type: array
items:
$ref: '#/components/schemas/ListedGateway'
description: A list of gateway summaries.
NextToken:
type: string
description: The token that identifies the batch of results that you want to see. For example, you submit a ListGateways
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 ListGateways request a second time and specify the NextToken
value.
ListedGateway:
type: object
properties:
GatewayArn:
type: string
description: The Amazon Resource Name (ARN) of the gateway.
GatewayState:
type: string
enum:
- CREATING
- ACTIVE
- UPDATING
- ERROR
- DELETING
- DELETED
description: The status of the gateway.
Name:
type: string
description: The name of the gateway.
required:
- GatewayArn
- GatewayState
- Name
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
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/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)