GetModelTemplate - Amazon API Gateway


Generates a sample mapping template that can be used to transform a payload into the structure of a model.

Request Syntax

GET /restapis/restapi_id/models/model_name/default_template HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The name of the model for which to generate a template.

Required: Yes


The string identifier of the associated RestApi.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "value": "string" }

Response Elements

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

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


The Apache Velocity Template Language (VTL) template content used for the template resource.

Type: String


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


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


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

HTTP Status Code: 404


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

HTTP Status Code: 429


The request is denied because the caller has insufficient permissions.

HTTP Status Code: 401


Generate the sample template from a model

This example illustrates one usage of GetModelTemplate.

Sample Request

GET /restapis/uojnr9hd57/models/output/default_template HTTP/1.1 Content-Type: application/json Host: X-Amz-Date: 20160614T202448Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160614/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response

Sample Response

{ "_links": { "self": { "href": "/restapis/uojnr9hd57/models/output/default_template" } }, "value": "#set($inputRoot = $input.path('$'))\n{\n \"a\" : 3.1415,\n \"b\" : 3.1415,\n \"op\" : \"foo\",\n \"c\" : 3.1415\n}" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: