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.ApiGatewayV2.Types.Model

Description

Synopsis

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

Documentation

data Model Source #

Represents a data model for an API. Supported only for WebSocket APIs. See Create Models and Mapping Templates for Request and Response Mappings.

See: newModel smart constructor.

Constructors

Model'
Fields modelId :: Maybe Text The model identifier. schema :: Maybe Text The schema for the model. For application/json models, this should be JSON schema draft 4 model. description :: Maybe Text The description of the model. contentType :: Maybe Text The content-type for the model, for example, "application/json". name :: Text The name of the model. Must be alphanumeric.

Instances

Instances details

Eq Model Source #
Instance details Defined in Amazonka.ApiGatewayV2.Types.Model Methods (==) :: Model -> Model -> Bool # (/=) :: Model -> Model -> Bool #
Read Model Source #
Instance details Defined in Amazonka.ApiGatewayV2.Types.Model Methods readsPrec :: Int -> ReadS Model # readList :: ReadS [Model] # readPrec :: ReadPrec Model # readListPrec :: ReadPrec [Model] #
Show Model Source #
Instance details Defined in Amazonka.ApiGatewayV2.Types.Model Methods showsPrec :: Int -> Model -> ShowS # show :: Model -> String # showList :: [Model] -> ShowS #
Generic Model Source #
Instance details Defined in Amazonka.ApiGatewayV2.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.ApiGatewayV2.Types.Model Methods rnf :: Model -> () #
Hashable Model Source #
Instance details Defined in Amazonka.ApiGatewayV2.Types.Model Methods hashWithSalt :: Int -> Model -> Int # hash :: Model -> Int #
FromJSON Model Source #
Instance details Defined in Amazonka.ApiGatewayV2.Types.Model Methods parseJSON :: Value -> Parser Model # parseJSONList :: Value -> Parser [Model] #
type Rep Model Source #
Instance details Defined in Amazonka.ApiGatewayV2.Types.Model type Rep Model = D1 ('MetaData "Model" "Amazonka.ApiGatewayV2.Types.Model" "libZSservicesZSamazonka-apigatewayv2ZSamazonka-apigatewayv2" 'False) (C1 ('MetaCons "Model'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "modelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "schema") '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)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newModel Source #

Arguments

:: Text	`$sel:name:Model'`
-> Model

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:modelId:Model', model_modelId - The model identifier.

$sel:schema:Model', model_schema - The schema for the model. For application/json models, this should be JSON schema draft 4 model.

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

$sel:contentType:Model', model_contentType - The content-type for the model, for example, "application/json".

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

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

The model identifier.

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

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

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, for example, "application/json".

model_name :: Lens' Model Text Source #

The name of the model. Must be alphanumeric.