| Copyright | (c) 2013-2018 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 |
| Language | Haskell2010 |
Network.AWS.APIGateway.CreateModel
Description
Adds a new Model resource to an existing RestApi resource.
Synopsis
- createModel :: Text -> Text -> Text -> CreateModel
- data CreateModel
- cmSchema :: Lens' CreateModel (Maybe Text)
- cmDescription :: Lens' CreateModel (Maybe Text)
- cmRestAPIId :: Lens' CreateModel Text
- cmName :: Lens' CreateModel Text
- cmContentType :: Lens' CreateModel Text
- model :: Model
- data Model
- mSchema :: Lens' Model (Maybe Text)
- mName :: Lens' Model (Maybe Text)
- mId :: Lens' Model (Maybe Text)
- mDescription :: Lens' Model (Maybe Text)
- mContentType :: Lens' Model (Maybe Text)
Creating a Request
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CreateModel |
Creates a value of CreateModel with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cmSchema- The schema for the model. Forapplication/jsonmodels, this should be JSON schema draft 4 model.cmDescription- The description of the model.cmRestAPIId- [Required] TheRestApiidentifier under which theModelwill be created.cmName- [Required] The name of the model. Must be alphanumeric.cmContentType- [Required] The content-type for the model.
data CreateModel #
Request to add a new Model to an existing RestApi resource.
See: createModel smart constructor.
Instances
Request Lenses
cmSchema :: Lens' CreateModel (Maybe Text) #
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
cmDescription :: Lens' CreateModel (Maybe Text) #
The description of the model.
cmRestAPIId :: Lens' CreateModel Text #
- Required
- The
RestApiidentifier under which theModelwill be created.
cmName :: Lens' CreateModel Text #
- Required
- The name of the model. Must be alphanumeric.
cmContentType :: Lens' CreateModel Text #
- Required
- The content-type for the model.
Destructuring the Response
Creates a value of Model with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mSchema- The schema for the model. Forapplication/jsonmodels, 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.mName- The name of the model. Must be an alphanumeric string.mId- The identifier for the model resource.mDescription- The description of the model.mContentType- The content-type for the model.
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: model smart constructor.
Instances
| Eq Model # | |
| Data Model # | |
Defined in Network.AWS.APIGateway.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Model -> c Model # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Model # dataTypeOf :: Model -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Model) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Model) # gmapT :: (forall b. Data b => b -> b) -> Model -> Model # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Model -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Model -> r # gmapQ :: (forall d. Data d => d -> u) -> Model -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Model -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Model -> m Model # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Model -> m Model # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Model -> m Model # | |
| Read Model # | |
| Show Model # | |
| Generic Model # | |
| Hashable Model # | |
Defined in Network.AWS.APIGateway.Types.Product | |
| FromJSON Model # | |
| NFData Model # | |
Defined in Network.AWS.APIGateway.Types.Product | |
| type Rep Model # | |
Defined in Network.AWS.APIGateway.Types.Product type Rep Model = D1 (MetaData "Model" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.6.1-GnuuEYf06xY7QozOa1xsLf" False) (C1 (MetaCons "Model'" PrefixI True) ((S1 (MetaSel (Just "_mSchema") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_mName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_mId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_mDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_mContentType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) | |
Response Lenses
mSchema :: Lens' Model (Maybe Text) #
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.