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::ApiGateway::Model resource defines the structure of a request or response payload for an API method. |
| Id | aws.apigateway.models_list_only |
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). 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
| Name | Accessible by | Required Params |
|---|---|---|
list_resources | SELECT | region |
SELECT examples
Lists all models in a region.
SELECT
region,
rest_api_id,
name
FROM aws.apigateway.models_list_only
WHERE region = 'us-east-1';
Permissions
For permissions required to operate on the models_list_only resource, see models