Amazon API Gateway Models API

Operations for managing API data models

GitHub OpenAPI

Operations 10

POST /restapis/{restApiId}/models Create Model #
GET /restapis/{restApiId}/models Get Models #
DELETE /restapis/{restApiId}/models/{modelName} Delete Model #
GET /restapis/{restApiId}/models/{modelName} Get Model #
PATCH /restapis/{restApiId}/models/{modelName} Update Model #
POST /v2/apis/{ApiId}/models Create Model #
GET /v2/apis/{ApiId}/models Get Models #
DELETE /v2/apis/{ApiId}/models/{ModelId} Delete Model #
GET /v2/apis/{ApiId}/models/{ModelId} Get Model #
PATCH /v2/apis/{ApiId}/models/{ModelId} Update Model #

Documentation

Specifications

Schemas & Data

Other Resources

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/aws-api-gateway:aws-api-gateway-models-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

aws-api-gateway-models-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon API Gateway Models API
  version: '2015-07-09'
  description: Generated from AWS's published Smithy model for Amazon API Gateway. 10 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://apigateway.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /restapis/{restApiId}/models:
    post:
      operationId: CreateModel
      summary: Create Model
      description: Adds a new Model resource to an existing RestApi resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '429':
          description: LimitExceededException; TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateModelRequest'
      tags:
      - Models
    get:
      operationId: GetModels
      summary: Get Models
      description: Describes existing Models defined for a RestApi resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Models'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetModelsRequest'
      tags:
      - Models
  /restapis/{restApiId}/models/{modelName}:
    delete:
      operationId: DeleteModel
      summary: Delete Model
      description: Deletes a model.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteModelRequest'
      tags:
      - Models
    get:
      operationId: GetModel
      summary: Get Model
      description: Describes an existing model defined for a RestApi resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetModelRequest'
      tags:
      - Models
    patch:
      operationId: UpdateModel
      summary: Update Model
      description: Changes information about a model. The maximum size of the model is 400 KB.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '429':
          description: LimitExceededException; TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateModelRequest'
      tags:
      - Models
  /v2/apis/{ApiId}/models:
    post:
      operationId: CreateModel
      summary: Create Model
      description: Creates a Model for an API.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateModelResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApigatewayBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApigatewayConflictException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApigatewayNotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApigatewayTooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApigatewayCreateModelRequest'
      tags:
      - Models
      servers:
      - url: https://apigateway.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
    get:
      operationId: GetModels
      summary: Get Models
      description: Gets the Models for an API.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetModelsResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApigatewayBadRequestException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApigatewayNotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApigatewayTooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApigatewayGetModelsRequest'
      tags:
      - Models
      servers:
      - url: https://apigateway.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
  /v2/apis/{ApiId}/models/{ModelId}:
    delete:
      operationId: DeleteModel
      summary: Delete Model
      description: Deletes a Model.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApigatewayNotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApigatewayTooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApigatewayDeleteModelRequest'
      tags:
      - Models
      servers:
      - url: https://apigateway.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
    get:
      operationId: GetModel
      summary: Get Model
      description: Gets a Model.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetModelResponse'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApigatewayNotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApigatewayTooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApigatewayGetModelRequest'
      tags:
      - Models
      servers:
      - url: https://apigateway.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
    patch:
      operationId: UpdateModel
      summary: Update Model
      description: Updates a Model.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateModelResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApigatewayBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApigatewayConflictException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApigatewayNotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApigatewayTooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApigatewayUpdateModelRequest'
      tags:
      - Models
      servers:
      - url: https://apigateway.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
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: apigateway
  schemas:
    ApigatewayBadRequestException:
      type: object
      properties:
        Message:
          type: string
          description: Describes the error encountered.
    ApigatewayConflictException:
      type: object
      properties:
        Message:
          type: string
          description: Describes the error encountered.
    ApigatewayCreateModelRequest:
      type: object
      properties:
        ApiId:
          type: string
          description: The API identifier.
        ContentType:
          type: string
          description: The content-type for the model, for example, "application/json".
        Description:
          type: string
          description: The description of the model.
        Name:
          type: string
          description: The name of the model. Must be alphanumeric.
        Schema:
          type: string
          description: The schema for the model. For application/json models, this should be JSON schema draft 4 model.
      required:
      - ApiId
      - Name
      - Schema
    ApigatewayDeleteModelRequest:
      type: object
      properties:
        ApiId:
          type: string
          description: The API identifier.
        ModelId:
          type: string
          description: The model ID.
      required:
      - ApiId
      - ModelId
    ApigatewayGetModelRequest:
      type: object
      properties:
        ApiId:
          type: string
          description: The API identifier.
        ModelId:
          type: string
          description: The model ID.
      required:
      - ApiId
      - ModelId
    ApigatewayGetModelsRequest:
      type: object
      properties:
        ApiId:
          type: string
          description: The API identifier.
        MaxResults:
          type: string
          description: The maximum number of elements to be returned for this resource.
        NextToken:
          type: string
          description: The next page of elements from this collection. Not valid for the last element of the collection.
      required:
      - ApiId
    ApigatewayModel:
      type: object
      properties:
        ContentType:
          type: string
          description: The content-type for the model, for example, "application/json".
        Description:
          type: string
          description: The description of the model.
        ModelId:
          type: string
          description: The model identifier.
        Name:
          type: string
          description: The name of the model. Must be alphanumeric.
        Schema:
          type: string
          description: The schema for the model. For application/json models, this should be JSON schema draft 4 model.
      required:
      - Name
    ApigatewayNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: Describes the error encountered.
        ResourceType:
          type: string
          description: The resource type.
    ApigatewayTooManyRequestsException:
      type: object
      properties:
        LimitType:
          type: string
          description: The limit type.
        Message:
          type: string
          description: Describes the error encountered.
    ApigatewayUpdateModelRequest:
      type: object
      properties:
        ApiId:
          type: string
          description: The API identifier.
        ContentType:
          type: string
          description: The content-type for the model, for example, "application/json".
        Description:
          type: string
          description: The description of the model.
        ModelId:
          type: string
          description: The model ID.
        Name:
          type: string
          description: The name of the model.
        Schema:
          type: string
          description: The schema for the model. For application/json models, this should be JSON schema draft 4 model.
      required:
      - ApiId
      - ModelId
    BadRequestException:
      type: object
      properties:
        message:
          type: string
    ConflictException:
      type: object
      properties:
        message:
          type: string
    CreateModelRequest:
      type: object
      properties:
        restApiId:
          type: string
          description: The RestApi identifier under which the Model will be created.
        name:
          type: string
          description: The name of the model. Must be alphanumeric.
        description:
          type: string
          description: The description of the model.
        schema:
          type: string
          description: The schema for the model. For application/json models, this should be JSON schema draft 4 model. The
            maximum size of the model is 400 KB.
        contentType:
          type: string
          description: The content-type for the model.
      required:
      - restApiId
      - name
      - contentType
    CreateModelResponse:
      type: object
      properties:
        ContentType:
          type: string
          description: The content-type for the model, for example, "application/json".
        Description:
          type: string
          description: The description of the model.
        ModelId:
          type: string
          description: The model identifier.
        Name:
          type: string
          description: The name of the model. Must be alphanumeric.
        Schema:
          type: string
          description: The schema for the model. For application/json models, this should be JSON schema draft 4 model.
    DeleteModelRequest:
      type: object
      properties:
        restApiId:
          type: string
          description: The string identifier of the associated RestApi.
        modelName:
          type: string
          description: The name of the model to delete.
      required:
      - restApiId
      - modelName
    GetModelRequest:
      type: object
      properties:
        restApiId:
          type: string
          description: The RestApi identifier under which the Model exists.
        modelName:
          type: string
          description: The name of the model as an identifier.
        flatten:
          type: boolean
          description: A query parameter of a Boolean value to resolve (true) all external model references and returns a
            flattened model schema or not (false) The default is false.
      required:
      - restApiId
      - modelName
    GetModelResponse:
      type: object
      properties:
        ContentType:
          type: string
          description: The content-type for the model, for example, "application/json".
        Description:
          type: string
          description: The description of the model.
        ModelId:
          type: string
          description: The model identifier.
        Name:
          type: string
          description: The name of the model. Must be alphanumeric.
        Schema:
          type: string
          description: The schema for the model. For application/json models, this should be JSON schema draft 4 model.
    GetModelsRequest:
      type: object
      properties:
        restApiId:
          type: string
          description: The string identifier of the associated RestApi.
        position:
          type: string
          description: The current pagination position in the paged result set.
        limit:
          type: integer
          description: The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
      required:
      - restApiId
    GetModelsResponse:
      type: object
      properties:
        Items:
          type: array
          items:
            $ref: '#/components/schemas/ApigatewayModel'
          description: The elements from this collection.
        NextToken:
          type: string
          description: The next page of elements from this collection. Not valid for the last element of the collection.
    LimitExceededException:
      type: object
      properties:
        retryAfterSeconds:
          type: string
        message:
          type: string
    Model:
      type: object
      properties:
        id:
          type: string
          description: The identifier for the model resource.
        name:
          type: string
          description: The name of the model. Must be an alphanumeric string.
        description:
          type: string
          description: The description of the model.
        schema:
          type: string
          description: The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do
            not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted
            as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of
            your API's SDK generated by API Gateway to fail.
        contentType:
          type: string
          description: The content-type for the model.
    Models:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Model'
          description: The current page of elements from this collection.
        position:
          type: string
          description: The current pagination position in the paged result set.
    NotFoundException:
      type: object
      properties:
        message:
          type: string
    PatchOperation:
      type: object
      properties:
        op:
          type: string
          enum:
          - add
          - remove
          - replace
          - move
          - copy
          - test
          description: An update operation to be performed with this PATCH request. The valid value can be add, remove, replace
            or copy. Not all valid operations are supported for a given resource. Support of the operations depends on specific
            operational contexts. Attempts to apply an unsupported operation on a resource will return an error message..
        path:
          type: string
          description: 'The op operation''s target, as identified by a JSON Pointer value that references a location within
            the targeted resource. For example, if the target resource has an updateable property of {"name":"value"}, the
            path for this property is /name. If the name property value is a JSON object (e.g., {"name": {"child/name": "child-value"}}),
            the path for the child/name property will be /name/child~1name. Any slash ("/") character appearing in path names
            must be escaped with "~1", as shown in the example above. Each op operation can have only one path associated
            with it.'
        value:
          type: string
          description: 'The new target value of the update operation. It is applicable for the add or replace operation. When
            using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a
            Linux shell, e.g., ''{"a": ...}''.'
        from:
          type: string
          description: The copy update operation's source as identified by a JSON-Pointer value referencing the location within
            the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary
            deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with "op":"copy",
            "from":"/canarySettings/deploymentId" and "path":"/deploymentId".
    TooManyRequestsException:
      type: object
      properties:
        retryAfterSeconds:
          type: string
        message:
          type: string
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
    UpdateModelRequest:
      type: object
      properties:
        restApiId:
          type: string
          description: The string identifier of the associated RestApi.
        modelName:
          type: string
          description: The name of the model to update.
        patchOperations:
          type: array
          items:
            $ref: '#/components/schemas/PatchOperation'
          description: For more information about supported patch operations, see Patch Operations.
      required:
      - restApiId
      - modelName
    UpdateModelResponse:
      type: object
      properties:
        ContentType:
          type: string
          description: The content-type for the model, for example, "application/json".
        Description:
          type: string
          description: The description of the model.
        ModelId:
          type: string
          description: The model identifier.
        Name:
          type: string
          description: The name of the model. Must be alphanumeric.
        Schema:
          type: string
          description: The schema for the model. For application/json models, this should be JSON schema draft 4 model.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/api-gateway/service/2015-07-09/api-gateway-2015-07-09.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)
  sources:
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/api-gateway/service/2015-07-09/api-gateway-2015-07-09.json
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/apigatewayv2/service/2018-11-29/apigatewayv2-2018-11-29.json