models_list_only
Lists models
in a region or regions, for all properties use models
Overview
Name | models_list_only |
Type | Resource |
Description | The 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*. |
Id | aws.apigatewayv2.models_list_only |
Fields
Name | Datatype | Description |
---|---|---|
model_id | string | |
description | string | The description of the model. |
content_type | string | The content-type for the model, for example, "application/json". |
schema | object | The schema for the model. For application/json models, this should be JSON schema draft 4 model. |
api_id | string | The API identifier. |
name | string | The name of the model. |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
list_resources | SELECT | region |
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