| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.APIGateway.GetModel
Description
Describes an existing model defined for a RestApi resource.
Synopsis
- data GetModel = GetModel' {}
- newGetModel :: Text -> Text -> GetModel
- getModel_flatten :: Lens' GetModel (Maybe Bool)
- getModel_restApiId :: Lens' GetModel Text
- getModel_modelName :: Lens' GetModel Text
- data Model = Model' {}
- newModel :: Model
- model_schema :: Lens' Model (Maybe Text)
- model_name :: Lens' Model (Maybe Text)
- model_id :: Lens' Model (Maybe Text)
- model_description :: Lens' Model (Maybe Text)
- model_contentType :: Lens' Model (Maybe Text)
Creating a Request
Request to list information about a model in an existing RestApi resource.
See: newGetModel smart constructor.
Constructors
| GetModel' | |
Fields
| |
Instances
Create a value of GetModel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:flatten:GetModel', getModel_flatten - A query parameter of a Boolean value to resolve (true) all external
model references and returns a flattened model schema or not (false)
The default is false.
$sel:restApiId:GetModel', getModel_restApiId - [Required] The RestApi identifier under which the Model exists.
$sel:modelName:GetModel', getModel_modelName - [Required] The name of the model as an identifier.
Request Lenses
getModel_flatten :: Lens' GetModel (Maybe Bool) Source #
A query parameter of a Boolean value to resolve (true) all external
model references and returns a flattened model schema or not (false)
The default is false.
getModel_restApiId :: Lens' GetModel Text Source #
- Required
- The RestApi identifier under which the Model exists.
Destructuring the Response
Represents the data structure of a method's request or response payload.
A request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end.
A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.
Method, MethodResponse, Models and Mappings
See: newModel smart constructor.
Constructors
| Model' | |
Fields
| |
Instances
Create a value of Model with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:schema:Model', model_schema - 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.
$sel:name:Model', model_name - The name of the model. Must be an alphanumeric string.
$sel:id:Model', model_id - The identifier for the model resource.
$sel:description:Model', model_description - The description of the model.
$sel:contentType:Model', model_contentType - The content-type for the model.
Response Lenses
model_schema :: Lens' Model (Maybe Text) Source #
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.