Amazonka.ApiGatewayV2.CreateModel

Creates a Model for an API.

Creating a Request

data CreateModel

Creates a new Model.

See: newCreateModel smart constructor.

Constructors

CreateModel'

Fields

• contentType :: Maybe Text

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

• description :: Maybe Text

  The description of the model.

• apiId :: Text

  The API identifier.

• schema :: 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

ToJSON CreateModel

Defined in Amazonka.ApiGatewayV2.CreateModel

Methods

toJSON :: CreateModel -> Value

toEncoding :: CreateModel -> Encoding

toJSONList :: [CreateModel] -> Value

toEncodingList :: [CreateModel] -> Encoding

ToHeaders CreateModel

Defined in Amazonka.ApiGatewayV2.CreateModel

Methods

toHeaders :: CreateModel -> [Header]

ToPath CreateModel

Defined in Amazonka.ApiGatewayV2.CreateModel

Methods

toPath :: CreateModel -> ByteString

ToQuery CreateModel

Defined in Amazonka.ApiGatewayV2.CreateModel

Methods

toQuery :: CreateModel -> QueryString

AWSRequest CreateModel

Defined in Amazonka.ApiGatewayV2.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

Defined in Amazonka.ApiGatewayV2.CreateModel

Associated Types

type Rep CreateModel :: Type -> Type

Methods

from :: CreateModel -> Rep CreateModel x

to :: Rep CreateModel x -> CreateModel

Read CreateModel

Defined in Amazonka.ApiGatewayV2.CreateModel

Methods

readsPrec :: Int -> ReadS CreateModel

readList :: ReadS [CreateModel]

readPrec :: ReadPrec CreateModel

readListPrec :: ReadPrec [CreateModel]

Show CreateModel

Defined in Amazonka.ApiGatewayV2.CreateModel

Methods

showsPrec :: Int -> CreateModel -> ShowS

show :: CreateModel -> String

showList :: [CreateModel] -> ShowS

NFData CreateModel

Defined in Amazonka.ApiGatewayV2.CreateModel

Methods

rnf :: CreateModel -> ()

Eq CreateModel

Defined in Amazonka.ApiGatewayV2.CreateModel

Methods

(==) :: CreateModel -> CreateModel -> Bool

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

Hashable CreateModel

Defined in Amazonka.ApiGatewayV2.CreateModel

Methods

hashWithSalt :: Int -> CreateModel -> Int

hash :: CreateModel -> Int

type AWSResponse CreateModel

Defined in Amazonka.ApiGatewayV2.CreateModel

type AWSResponse CreateModel = CreateModelResponse

type Rep CreateModel

Defined in Amazonka.ApiGatewayV2.CreateModel

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

newCreateModel

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_contentType - The content-type for the model, for example, "application/json".

CreateModel, createModel_description - The description of the model.

CreateModel, createModel_apiId - The API identifier.

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

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

Request Lenses

createModel_contentType :: Lens' CreateModel (Maybe Text)

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

createModel_description :: Lens' CreateModel (Maybe Text)

The description of the model.

createModel_apiId :: Lens' CreateModel Text

The API identifier.

createModel_schema :: Lens' CreateModel Text

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

createModel_name :: Lens' CreateModel Text

The name of the model. Must be alphanumeric.

Destructuring the Response

data CreateModelResponse

See: newCreateModelResponse smart constructor.

Constructors

CreateModelResponse'

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.

• name :: Maybe Text

  The name of the model. Must be alphanumeric.

• schema :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateModelResponse

Defined in Amazonka.ApiGatewayV2.CreateModel

Associated Types

type Rep CreateModelResponse :: Type -> Type

Methods

from :: CreateModelResponse -> Rep CreateModelResponse x

to :: Rep CreateModelResponse x -> CreateModelResponse

Read CreateModelResponse

Defined in Amazonka.ApiGatewayV2.CreateModel

Methods

readsPrec :: Int -> ReadS CreateModelResponse

readList :: ReadS [CreateModelResponse]

readPrec :: ReadPrec CreateModelResponse

readListPrec :: ReadPrec [CreateModelResponse]

Show CreateModelResponse

Defined in Amazonka.ApiGatewayV2.CreateModel

Methods

showsPrec :: Int -> CreateModelResponse -> ShowS

show :: CreateModelResponse -> String

showList :: [CreateModelResponse] -> ShowS

NFData CreateModelResponse

Defined in Amazonka.ApiGatewayV2.CreateModel

Methods

rnf :: CreateModelResponse -> ()

Eq CreateModelResponse

Defined in Amazonka.ApiGatewayV2.CreateModel

Methods

(==) :: CreateModelResponse -> CreateModelResponse -> Bool

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

type Rep CreateModelResponse

Defined in Amazonka.ApiGatewayV2.CreateModel

type Rep CreateModelResponse = D1 ('MetaData "CreateModelResponse" "Amazonka.ApiGatewayV2.CreateModel" "amazonka-apigatewayv2-2.0-4MZ8oueToeLOWomgegceF" 'False) (C1 ('MetaCons "CreateModelResponse'" '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 "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateModelResponse

Arguments

:: Int

$sel:httpStatus:CreateModelResponse'

-> CreateModelResponse

Create a value of CreateModelResponse 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, createModelResponse_contentType - The content-type for the model, for example, "application/json".

CreateModel, createModelResponse_description - The description of the model.

CreateModelResponse, createModelResponse_modelId - The model identifier.

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

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

$sel:httpStatus:CreateModelResponse', createModelResponse_httpStatus - The response's http status code.

Response Lenses

createModelResponse_contentType :: Lens' CreateModelResponse (Maybe Text)

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

createModelResponse_description :: Lens' CreateModelResponse (Maybe Text)

The description of the model.

createModelResponse_modelId :: Lens' CreateModelResponse (Maybe Text)

The model identifier.

createModelResponse_name :: Lens' CreateModelResponse (Maybe Text)

The name of the model. Must be alphanumeric.

createModelResponse_schema :: Lens' CreateModelResponse (Maybe Text)

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

createModelResponse_httpStatus :: Lens' CreateModelResponse Int

The response's http status code.