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

Amazonka.APIGateway.CreateModel

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Adds a new Model resource to an existing RestApi resource.

Synopsis

data CreateModel = CreateModel' {
- description :: Maybe Text
- schema :: Maybe Text
- restApiId :: Text
- name :: Text
- contentType :: Text
}
newCreateModel :: Text -> Text -> Text -> CreateModel
createModel_description :: Lens' CreateModel (Maybe Text)
createModel_schema :: Lens' CreateModel (Maybe Text)
createModel_restApiId :: Lens' CreateModel Text
createModel_name :: Lens' CreateModel Text
createModel_contentType :: Lens' CreateModel Text
data Model = Model' {
- contentType :: Maybe Text
- description :: Maybe Text
- id :: Maybe Text
- name :: Maybe Text
- schema :: Maybe Text
}
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 CreateModel Source #

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

See: newCreateModel smart constructor.

Constructors

CreateModel'
Fields description :: Maybe Text The description of the model. schema :: Maybe Text The schema for the model. For `application/json` models, this should be JSON schema draft 4 model. restApiId :: Text The RestApi identifier under which the Model will be created. name :: Text The name of the model. Must be alphanumeric. contentType :: Text The content-type for the model.

Instances

Instances details

ToJSON CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel Methods toJSON :: CreateModel -> Value # toEncoding :: CreateModel -> Encoding # toJSONList :: [CreateModel] -> Value # toEncodingList :: [CreateModel] -> Encoding #
ToHeaders CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel Methods toHeaders :: CreateModel -> [Header] #
ToPath CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel Methods toPath :: CreateModel -> ByteString #
ToQuery CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel Methods toQuery :: CreateModel -> QueryString #
AWSRequest CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel Associated Types type AWSResponse CreateModel # Methods request :: (Service -> Service) -> CreateModel -> Request CreateModel # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateModel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateModel))) #
Generic CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel Associated Types type Rep CreateModel :: Type -> Type # Methods from :: CreateModel -> Rep CreateModel x # to :: Rep CreateModel x -> CreateModel #
Read CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel Methods readsPrec :: Int -> ReadS CreateModel # readList :: ReadS [CreateModel] # readPrec :: ReadPrec CreateModel # readListPrec :: ReadPrec [CreateModel] #
Show CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel Methods showsPrec :: Int -> CreateModel -> ShowS # show :: CreateModel -> String # showList :: [CreateModel] -> ShowS #
NFData CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel Methods rnf :: CreateModel -> () #
Eq CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel Methods (==) :: CreateModel -> CreateModel -> Bool # (/=) :: CreateModel -> CreateModel -> Bool #
Hashable CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel Methods hashWithSalt :: Int -> CreateModel -> Int # hash :: CreateModel -> Int #
type AWSResponse CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel type AWSResponse CreateModel = Model
type Rep CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel type Rep CreateModel = D1 ('MetaData "CreateModel" "Amazonka.APIGateway.CreateModel" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "CreateModel'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateModel Source #

Arguments

:: Text	`CreateModel`
-> Text	`CreateModel`
-> Text	`CreateModel`
-> CreateModel

Create a value of CreateModel 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:

CreateModel, createModel_description - The description of the model.

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

CreateModel, createModel_restApiId - The RestApi identifier under which the Model will be created.

CreateModel, createModel_name - The name of the model. Must be alphanumeric.

CreateModel, createModel_contentType - The content-type for the model.

Request Lenses

createModel_description :: Lens' CreateModel (Maybe Text) Source #

The description of the model.

createModel_schema :: Lens' CreateModel (Maybe Text) Source #

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

createModel_restApiId :: Lens' CreateModel Text Source #

The RestApi identifier under which the Model will be created.

createModel_name :: Lens' CreateModel Text Source #

The name of the model. Must be alphanumeric.

createModel_contentType :: Lens' CreateModel Text Source #

The content-type for the model.

Destructuring the Response

data Model Source #

Represents the data structure of a method's request or response payload.

See: newModel smart constructor.

Constructors

Model'

Fields

contentType :: Maybe Text
The content-type for the model.
description :: Maybe Text
The description of the model.
id :: Maybe Text
The identifier for the model resource.
name :: Maybe Text
The name of the model. Must be an alphanumeric string.
schema :: 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.

Instances

Instances details

FromJSON Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods parseJSON :: Value -> Parser Model # parseJSONList :: Value -> Parser [Model] #
Generic Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Associated Types type Rep Model :: Type -> Type # Methods from :: Model -> Rep Model x # to :: Rep Model x -> Model #
Read Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods readsPrec :: Int -> ReadS Model # readList :: ReadS [Model] # readPrec :: ReadPrec Model # readListPrec :: ReadPrec [Model] #
Show Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods showsPrec :: Int -> Model -> ShowS # show :: Model -> String # showList :: [Model] -> ShowS #
NFData Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods rnf :: Model -> () #
Eq Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods (==) :: Model -> Model -> Bool # (/=) :: Model -> Model -> Bool #
Hashable Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods hashWithSalt :: Int -> Model -> Int # hash :: Model -> Int #
type Rep Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model type Rep Model = D1 ('MetaData "Model" "Amazonka.APIGateway.Types.Model" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Model'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newModel :: Model Source #

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_contentType :: Lens' Model (Maybe Text) Source #

The content-type for the model.

model_description :: Lens' Model (Maybe Text) Source #

The description of the model.

model_id :: Lens' Model (Maybe Text) Source #

The identifier for the model resource.

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.