Amazonka.APIGateway.Types.Model

Documentation

data Model

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

FromJSON Model

Defined in Amazonka.APIGateway.Types.Model

Methods

parseJSON :: Value -> Parser Model

parseJSONList :: Value -> Parser [Model]

Generic Model

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

Defined in Amazonka.APIGateway.Types.Model

Methods

readsPrec :: Int -> ReadS Model

readList :: ReadS [Model]

readPrec :: ReadPrec Model

readListPrec :: ReadPrec [Model]

Show Model

Defined in Amazonka.APIGateway.Types.Model

Methods

showsPrec :: Int -> Model -> ShowS

show :: Model -> String

showList :: [Model] -> ShowS

NFData Model

Defined in Amazonka.APIGateway.Types.Model

Methods

rnf :: Model -> ()

Eq Model

Defined in Amazonka.APIGateway.Types.Model

Methods

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

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

Hashable Model

Defined in Amazonka.APIGateway.Types.Model

Methods

hashWithSalt :: Int -> Model -> Int

hash :: Model -> Int

type Rep Model

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

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.

model_contentType :: Lens' Model (Maybe Text)

The content-type for the model.

model_description :: Lens' Model (Maybe Text)

The description of the model.

model_id :: Lens' Model (Maybe Text)

The identifier for the model resource.

model_name :: Lens' Model (Maybe Text)

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

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