Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Changes information about a model.
Synopsis
- data UpdateModel = UpdateModel' {
- patchOperations :: Maybe [PatchOperation]
- restApiId :: Text
- modelName :: Text
- newUpdateModel :: Text -> Text -> UpdateModel
- updateModel_patchOperations :: Lens' UpdateModel (Maybe [PatchOperation])
- updateModel_restApiId :: Lens' UpdateModel Text
- updateModel_modelName :: Lens' UpdateModel Text
- data Model = Model' {}
- newModel :: Model
- model_contentType :: Lens' Model (Maybe Text)
- model_description :: Lens' Model (Maybe Text)
- model_id :: Lens' Model (Maybe Text)
- model_name :: Lens' Model (Maybe Text)
- model_schema :: Lens' Model (Maybe Text)
Creating a Request
data UpdateModel Source #
Request to update an existing model in an existing RestApi resource.
See: newUpdateModel
smart constructor.
UpdateModel' | |
|
Instances
Create a value of UpdateModel
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:patchOperations:UpdateModel'
, updateModel_patchOperations
- For more information about supported patch operations, see
Patch Operations.
UpdateModel
, updateModel_restApiId
- The string identifier of the associated RestApi.
$sel:modelName:UpdateModel'
, updateModel_modelName
- The name of the model to update.
Request Lenses
updateModel_patchOperations :: Lens' UpdateModel (Maybe [PatchOperation]) Source #
For more information about supported patch operations, see Patch Operations.
updateModel_restApiId :: Lens' UpdateModel Text Source #
The string identifier of the associated RestApi.
updateModel_modelName :: Lens' UpdateModel Text Source #
The name of the model to update.
Destructuring the Response
Represents the data structure of a method's request or response payload.
See: newModel
smart constructor.
Model' | |
|
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:contentType:Model'
, model_contentType
- The content-type for the model.
$sel:description:Model'
, model_description
- The description of the model.
$sel:id:Model'
, model_id
- The identifier for the model resource.
$sel:name:Model'
, model_name
- The name of the model. Must be an alphanumeric string.
$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.
Response Lenses
model_name :: Lens' Model (Maybe Text) Source #
The name of the model. Must be an alphanumeric string.
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.