model

Gets an individual model resource

Overview

Name	model
Type	Resource
Description	model
Id	awscc.apigateway.model

Fields

Name	Datatype	Description
content_type	string	The content-type for the model.
description	string	The description of the model.
name	string	A name for the model. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the model name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
rest_api_id	string	The string identifier of the associated RestApi.
schema	object	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.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
content_type,
description,
name,
rest_api_id,
schema
FROM awscc.apigateway.model
WHERE data__Identifier = '<RestApiId>|<Name>';

Permissions

To operate on the model resource, the following permissions are required:

Read

apigateway:GET

Update

apigateway:PATCH,
apigateway:GET

Delete

apigateway:GET,
apigateway:DELETE