Network.AWS.APIGateway.CreateModel

Adds a new Model resource to an existing RestApi resource.

Creating a Request

createModel

Arguments

:: Text

cmRestAPIId

-> Text

cmName

-> Text

cmContentType

-> 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. For application/json models, this should be JSON schema draft 4 model.
• cmDescription - The description of the model.
• cmRestAPIId - [Required] The RestApi identifier under which the Model will 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

Eq CreateModel

Methods

(==) :: CreateModel -> CreateModel -> Bool

(/=) :: CreateModel -> CreateModel -> Bool

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

Methods

readsPrec :: Int -> ReadS CreateModel

readList :: ReadS [CreateModel]

readPrec :: ReadPrec CreateModel

readListPrec :: ReadPrec [CreateModel]

Show CreateModel

Methods

showsPrec :: Int -> CreateModel -> ShowS

show :: CreateModel -> String

showList :: [CreateModel] -> ShowS

Generic CreateModel

Associated Types

type Rep CreateModel :: * -> *

Methods

from :: CreateModel -> Rep CreateModel x

to :: Rep CreateModel x -> CreateModel

Hashable CreateModel

Methods

hashWithSalt :: Int -> CreateModel -> Int

hash :: CreateModel -> Int

ToJSON CreateModel

Methods

toJSON :: CreateModel -> Value

toEncoding :: CreateModel -> Encoding

toJSONList :: [CreateModel] -> Value

toEncodingList :: [CreateModel] -> Encoding

NFData CreateModel

Methods

rnf :: CreateModel -> ()

AWSRequest CreateModel

Associated Types

type Rs CreateModel :: *

Methods

request :: CreateModel -> Request CreateModel

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CreateModel -> ClientResponse -> m (Response CreateModel)

ToHeaders CreateModel

Methods

toHeaders :: CreateModel -> [Header]

ToPath CreateModel

Methods

toPath :: CreateModel -> ByteString

ToQuery CreateModel

Methods

toQuery :: CreateModel -> QueryString

type Rep CreateModel

type Rep CreateModel = D1 * (MetaData "CreateModel" "Network.AWS.APIGateway.CreateModel" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" 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

type Rs CreateModel = Model

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 RestApi identifier under which the Model will 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

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 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.

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

Methods

readsPrec :: Int -> ReadS Model

readList :: ReadS [Model]

readPrec :: ReadPrec Model

readListPrec :: ReadPrec [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

Methods

parseJSON :: Value -> Parser Model

parseJSONList :: Value -> Parser [Model]

NFData Model

Methods

rnf :: Model -> ()

type Rep Model

type Rep Model = D1 * (MetaData "Model" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" False) (C1 * (MetaCons "Model'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_mSchema") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_mName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_mId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_mDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_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.

mName :: Lens' Model (Maybe Text)

The name of the model. Must be an alphanumeric string.

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.