Amazonka.ApiGatewayV2.Types.Model

Documentation

data Model

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

• contentType :: Maybe Text

  The content-type for the model, for example, "application/json".

• description :: Maybe Text

  The description of the model.

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

• name :: Text

  The name of the model. Must be alphanumeric.

Instances

FromJSON Model

Defined in Amazonka.ApiGatewayV2.Types.Model

Methods

parseJSON :: Value -> Parser Model

parseJSONList :: Value -> Parser [Model]

Generic Model

Defined in Amazonka.ApiGatewayV2.Types.Model

Associated Types

type Rep Model :: Type -> Type

Methods

from :: Model -> Rep Model x

to :: Rep Model x -> Model

Read Model

Defined in Amazonka.ApiGatewayV2.Types.Model

Methods

readsPrec :: Int -> ReadS Model

readList :: ReadS [Model]

readPrec :: ReadPrec Model

readListPrec :: ReadPrec [Model]

Show Model

Defined in Amazonka.ApiGatewayV2.Types.Model

Methods

showsPrec :: Int -> Model -> ShowS

show :: Model -> String

showList :: [Model] -> ShowS

NFData Model

Defined in Amazonka.ApiGatewayV2.Types.Model

Methods

rnf :: Model -> ()

Eq Model

Defined in Amazonka.ApiGatewayV2.Types.Model

Methods

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

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

Hashable Model

Defined in Amazonka.ApiGatewayV2.Types.Model

Methods

hashWithSalt :: Int -> Model -> Int

hash :: Model -> Int

type Rep Model

Defined in Amazonka.ApiGatewayV2.Types.Model

type Rep Model = D1 ('MetaData "Model" "Amazonka.ApiGatewayV2.Types.Model" "amazonka-apigatewayv2-2.0-4MZ8oueToeLOWomgegceF" '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 "modelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newModel

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:contentType:Model', model_contentType - The content-type for the model, for example, "application/json".

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

$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:name:Model', model_name - The name of the model. Must be alphanumeric.

model_contentType :: Lens' Model (Maybe Text)

The content-type for the model, for example, "application/json".

model_description :: Lens' Model (Maybe Text)

The description of the model.

model_modelId :: Lens' Model (Maybe Text)

The model identifier.

model_schema :: Lens' Model (Maybe Text)

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

model_name :: Lens' Model Text

The name of the model. Must be alphanumeric.