Copyright	(c) 2013-2021 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

Amazonka.APIGateway.Types.Model

Description

Synopsis

data Model = Model' {
- schema :: Maybe Text
- name :: Maybe Text
- id :: Maybe Text
- description :: Maybe Text
- contentType :: Maybe Text
}
newModel :: Model
model_schema :: Lens' Model (Maybe Text)
model_name :: Lens' Model (Maybe Text)
model_id :: Lens' Model (Maybe Text)
model_description :: Lens' Model (Maybe Text)
model_contentType :: Lens' Model (Maybe Text)

Documentation

data Model Source #

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: newModel smart constructor.

Constructors

Model'

Fields

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

Instances

Instances details

Eq Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods (==) :: Model -> Model -> Bool # (/=) :: Model -> Model -> Bool #
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 #
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 #
NFData Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods rnf :: Model -> () #
Hashable Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods hashWithSalt :: Int -> Model -> Int # hash :: Model -> Int #
FromJSON Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods parseJSON :: Value -> Parser Model # parseJSONList :: Value -> Parser [Model] #
type Rep Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model type Rep Model = D1 ('MetaData "Model" "Amazonka.APIGateway.Types.Model" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "Model'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "contentType") '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: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.

$sel:name:Model', model_name - The name of the model. Must be an alphanumeric string.

$sel:id:Model', model_id - The identifier for the model resource.

$sel:description:Model', model_description - The description of the model.

$sel:contentType:Model', model_contentType - The content-type for the model.

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.

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

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

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

The identifier for the model resource.

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

The description of the model.

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

The content-type for the model.