Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon API Gateway Models API

Operations for managing API data models

Amazon API Gateway Models API is one of 18 APIs that Amazon API Gateway publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 8 JSON Schema definitions.

Tagged areas include Models. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, pricing, a getting-started guide, an API reference, a JSON-LD context, and 8 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 2015-07-09.

Requests are made against a single base URL, https://apigateway.{region}.amazonaws.com.

5 operations 2 paths 6 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2015-07-09
Base URL
https://apigateway.{region}.amazonaws.com
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Amazon API Gateway Models API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (sigv4). By default, every request must be authenticated.

  • sigv4 — AWS Signature Version 4 authentication

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Models 5

Operations for managing API data models

GET
/restapis/{restapi_id}/models
Amazon API Gateway List Models
GetModels 3 params → 200400404429
POST
/restapis/{restapi_id}/models
Amazon API Gateway Create a Model
CreateModel 1 param body → 201400404409429
GET
/restapis/{restapi_id}/models/{model_name}
Amazon API Gateway Get a Model
GetModel 3 params → 200404429
PATCH
/restapis/{restapi_id}/models/{model_name}
Amazon API Gateway Update a Model
UpdateModel 2 params body → 200400404409429
DELETE
/restapis/{restapi_id}/models/{model_name}
Amazon API Gateway Delete a Model
DeleteModel 2 params → 202404409429

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Model (5 properties), PatchOperation (4 properties), CreateModelRequest (4 properties), Error (2 properties). Each schema is shown below with its type and property counts.

Model
object
5 properties
CreateModelRequest
object
4 properties 2 required
Models
object
2 properties
PatchOperation
object
4 properties
PatchOperations
object
1 property
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-api-gateway-models-api-openapi.yml Raw ↑

Other APIs Amazon API Gateway publishes across the network.

Amazon API Gateway WebSocket API
Amazon API Gateway HTTP API
Amazon API Gateway Management API
Amazon API Gateway API Keys API
Amazon API Gateway Authorizers API
Amazon API Gateway Base Path Mappings API
Amazon API Gateway Deployments API
Amazon API Gateway Documentation API
Amazon API Gateway Domain Names API
Amazon API Gateway Gateway Responses API
Amazon API Gateway Methods API
Amazon API Gateway Request Validators API