Skip to main content

models_list_only

Lists models in a region or regions, for all properties use models

Overview

Namemodels_list_only
TypeResource
DescriptionThe AWS::ApiGatewayV2::Model resource updates data model for a WebSocket API. For more information, see [Model Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-model-selection-expressions) in the *API Gateway Developer Guide*.
Idaws.apigatewayv2.models_list_only

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

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all models in a region.

SELECT
region,
api_id,
model_id
FROM aws.apigatewayv2.models_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the models_list_only resource, see models