Skip to main content

model

Gets an individual model resource

Overview

Namemodel
TypeResource
Descriptionmodel
Idawscc.apigatewayv2.model

Fields

NameDatatypeDescription
model_idstring
descriptionstringThe description of the model.
content_typestringThe content-type for the model, for example, "application/json".
schemaobjectThe schema for the model. For application/json models, this should be JSON schema draft 4 model.
api_idstringThe API identifier.
namestringThe name of the model.
regionstringAWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
model_id,
description,
content_type,
schema,
api_id,
name
FROM awscc.apigatewayv2.model
WHERE data__Identifier = '<ApiId>|<ModelId>';

Permissions

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

Update

apigateway:PATCH,
apigateway:GET,
apigateway:PUT

Read

apigateway:GET

Delete

apigateway:GET,
apigateway:DELETE