UpdateModel - Amazon API Gateway

UpdateModel

Changes information about a model.

Request Syntax

PATCH /restapis/restapi_id/models/model_name HTTP/1.1 Content-type: application/json { "patchOperations": [ { "from": "string", "op": "string", "path": "string", "value": "string" } ] }

URI Request Parameters

The request uses the following URI parameters.

model_name

The name of the model to update.

Required: Yes

restapi_id

The string identifier of the associated RestApi.

Required: Yes

Request Body

The request accepts the following data in JSON format.

patchOperations

For more information about supported patch operations, see Patch Operations.

Type: Array of PatchOperation objects

Required: No

Response Syntax

HTTP/1.1 200 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 200 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

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

Update the schema definition of a model

This example illustrates one usage of UpdateModel.

Sample Request

PATCH /restapis/uojnr9hd57/models/output HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160614T004253Z 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} { "patchOperations" : [ { "op" : "replace", "path" : "/schema", "value" : "{\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" } ] }

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/output?flatten=false" }, "model:create": { "href": "/restapis/uojnr9hd57/models" }, "model:delete": { "href": "/restapis/uojnr9hd57/models/output" }, "model:generate-template": { "href": "/restapis/uojnr9hd57/models/output/default_template" }, "model:update": { "href": "/restapis/uojnr9hd57/models/output" } }, "contentType": "application/json", "id": "hkhn0z", "name": "output", "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" }

See Also

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