amazonka-apigateway-1.4.5: Amazon API Gateway SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.APIGateway.CreateModel

Contents

Description

Adds a new Model resource to an existing RestApi resource.

Synopsis

Creating a Request

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:

data CreateModel #

Request to add a new Model to an existing RestApi resource.

See: createModel smart constructor.

Instances

Eq CreateModel # 
Data CreateModel # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateModel -> c CreateModel #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateModel #

toConstr :: CreateModel -> Constr #

dataTypeOf :: CreateModel -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateModel) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateModel) #

gmapT :: (forall b. Data b => b -> b) -> CreateModel -> CreateModel #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateModel -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateModel -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateModel -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateModel -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateModel -> m CreateModel #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateModel -> m CreateModel #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateModel -> m CreateModel #

Read CreateModel # 
Show CreateModel # 
Generic CreateModel # 

Associated Types

type Rep CreateModel :: * -> * #

Hashable CreateModel # 
ToJSON CreateModel # 
NFData CreateModel # 

Methods

rnf :: CreateModel -> () #

AWSRequest CreateModel # 
ToQuery CreateModel # 
ToPath CreateModel # 
ToHeaders CreateModel # 

Methods

toHeaders :: CreateModel -> [Header] #

type Rep CreateModel # 
type Rep CreateModel = D1 (MetaData "CreateModel" "Network.AWS.APIGateway.CreateModel" "amazonka-apigateway-1.4.5-5OCToOwmZjEH3FMiU9Yogu" False) (C1 (MetaCons "CreateModel'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cmSchema") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cmDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_cmRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_cmName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cmContentType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))
type Rs CreateModel # 

Request Lenses

cmSchema :: Lens' CreateModel (Maybe Text) #

The schema for the model. For application/json models, this should be JSON-schema draft v4 model.

cmDescription :: Lens' CreateModel (Maybe Text) #

The description of the model.

cmRestAPIId :: Lens' CreateModel Text #

The RestApi identifier under which the Model will be created.

cmName :: Lens' CreateModel Text #

The name of the model.

cmContentType :: Lens' CreateModel Text #

The content-type for the model.

Destructuring the Response

model :: Model #

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. For application/json models, this should be JSON-schema draft v4 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.
  • mId - The identifier for the model resource.
  • mDescription - The description of the model.
  • mContentType - The content-type for the model.

data 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 # 

Methods

(==) :: Model -> Model -> Bool #

(/=) :: Model -> Model -> Bool #

Data Model # 

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 #

toConstr :: Model -> Constr #

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 # 

Methods

showsPrec :: Int -> Model -> ShowS #

show :: Model -> String #

showList :: [Model] -> ShowS #

Generic Model # 

Associated Types

type Rep Model :: * -> * #

Methods

from :: Model -> Rep Model x #

to :: Rep Model x -> Model #

Hashable Model # 

Methods

hashWithSalt :: Int -> Model -> Int #

hash :: Model -> Int #

FromJSON Model # 
NFData Model # 

Methods

rnf :: Model -> () #

type Rep Model # 

Response Lenses

mSchema :: Lens' Model (Maybe Text) #

The schema for the model. For application/json models, this should be JSON-schema draft v4 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 :: Lens' Model (Maybe Text) #

The name of the model.

mId :: Lens' Model (Maybe Text) #

The identifier for the model resource.

mDescription :: Lens' Model (Maybe Text) #

The description of the model.

mContentType :: Lens' Model (Maybe Text) #

The content-type for the model.