Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

CreateModel

Adds a new Model resource to an existing RestApi resource.

Request Syntax


POST /restapis/restapi_id/models HTTP/1.1
Content-type: application/json

{
   "contentType": "string",
   "description": "string",
   "name": "string",
   "schema": "string"
}

URI Request Parameters

The request uses the following URI parameters.

restapi_id

The RestApi identifier under which the Model will be created.

Required: Yes

Request Body

The request accepts the following data in JSON format.

contentType

The content-type for the model.

Type: String

Required: Yes

description

The description of the model.

Type: String

Required: No

name

The name of the model. Must be alphanumeric.

Type: String

Required: Yes

schema

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.

Type: String

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "contentType": "string",
   "description": "string",
   "id": "string",
   "name": "string",
   "schema": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

contentType

The content-type for the model.

Type: String

description

The description of the model.

Type: String

id

The identifier for the model resource.

Type: String

name

The name of the model. Must be an alphanumeric string.

Type: String

schema

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

HTTP Status Code: 400

ConflictException

The request configuration has conflicts. For details, see the accompanying error message.

HTTP Status Code: 409

LimitExceededException

The request exceeded the rate limit. Retry after the specified time period.

HTTP Status Code: 429

NotFoundException

The requested resource is not found. Make sure that the request URI is correct.

HTTP Status Code: 404

TooManyRequestsException

The request has reached its throttling limit. Retry after the specified time period.

HTTP Status Code: 429

UnauthorizedException

The request is denied because the caller has insufficient permissions.

HTTP Status Code: 401

Examples

Create a model

This example illustrates one usage of CreateModel.

Sample Request


POST /restapis/uojnr9hd57/models HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160614T173659Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160614/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

{
  "name" : "CalcOutput",
  "description" : "Calc output model",
  "schema" : "{\n\t\"title\": \"Calc output\",\n\t\"type\": \"object\",\n\t\"properties\": {\n\t\t\"a\": {\n\t\t\t\"type\": \"number\"\n\t\t},\n\t\t\"b\": {\n\t\t\t\"type\": \"number\"\n\t\t},\n\t\t\"op\": {\n\t\t\t\"description\": \"operation of +, -, * or /\",\n\t\t\t\"type\": \"string\"\n\t\t},\n\t\t\"c\": {\n\t\t    \"type\": \"number\"\n\t\t}\n\t},\n\t\"required\": [\"a\", \"b\", \"op\"]\n}\n",
  "contentType" : "application/json"
}

Sample Response


{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-model-{rel}.html",
      "name": "model",
      "templated": true
    },
    "self": {
      "href": "/restapis/uojnr9hd57/models/CalcOutput?flatten=false"
    },
    "model:create": {
      "href": "/restapis/uojnr9hd57/models"
    },
    "model:delete": {
      "href": "/restapis/uojnr9hd57/models/CalcOutput"
    },
    "model:generate-template": {
      "href": "/restapis/uojnr9hd57/models/CalcOutput/default_template"
    },
    "model:update": {
      "href": "/restapis/uojnr9hd57/models/CalcOutput"
    }
  },
  "contentType": "application/json",
  "description": "Calc output model",
  "id": "mzy1a0",
  "name": "CalcOutput",
  "schema": "{\n\t\"title\": \"Calc output\",\n\t\"type\": \"object\",\n\t\"properties\": {\n\t\t\"a\": {\n\t\t\t\"type\": \"number\"\n\t\t},\n\t\t\"b\": {\n\t\t\t\"type\": \"number\"\n\t\t},\n\t\t\"op\": {\n\t\t\t\"description\": \"operation of +, -, * or /\",\n\t\t\t\"type\": \"string\"\n\t\t},\n\t\t\"c\": {\n\t\t    \"type\": \"number\"\n\t\t}\n\t},\n\t\"required\": [\"a\", \"b\", \"op\"]\n}\n"
}