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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a Model for an API.

Synopsis

data CreateModel = CreateModel' {
- description :: Maybe Text
- contentType :: Maybe Text
- apiId :: Text
- schema :: Text
- name :: Text
}
newCreateModel :: Text -> Text -> Text -> CreateModel
createModel_description :: Lens' CreateModel (Maybe Text)
createModel_contentType :: Lens' CreateModel (Maybe Text)
createModel_apiId :: Lens' CreateModel Text
createModel_schema :: Lens' CreateModel Text
createModel_name :: Lens' CreateModel Text
data CreateModelResponse = CreateModelResponse' {
- modelId :: Maybe Text
- schema :: Maybe Text
- name :: Maybe Text
- description :: Maybe Text
- contentType :: Maybe Text
- httpStatus :: Int
}
newCreateModelResponse :: Int -> CreateModelResponse
createModelResponse_modelId :: Lens' CreateModelResponse (Maybe Text)
createModelResponse_schema :: Lens' CreateModelResponse (Maybe Text)
createModelResponse_name :: Lens' CreateModelResponse (Maybe Text)
createModelResponse_description :: Lens' CreateModelResponse (Maybe Text)
createModelResponse_contentType :: Lens' CreateModelResponse (Maybe Text)
createModelResponse_httpStatus :: Lens' CreateModelResponse Int

Creating a Request

data CreateModel Source #

Creates a new Model.

See: newCreateModel smart constructor.

Constructors

CreateModel'
Fields description :: Maybe Text The description of the model. contentType :: Maybe Text The content-type for the model, for example, "application/json". 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

Instances details

Eq CreateModel Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateModel Methods (==) :: CreateModel -> CreateModel -> Bool # (/=) :: CreateModel -> CreateModel -> Bool #
Read CreateModel Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateModel Methods readsPrec :: Int -> ReadS CreateModel # readList :: ReadS [CreateModel] # readPrec :: ReadPrec CreateModel # readListPrec :: ReadPrec [CreateModel] #
Show CreateModel Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateModel Methods showsPrec :: Int -> CreateModel -> ShowS # show :: CreateModel -> String # showList :: [CreateModel] -> ShowS #
Generic CreateModel Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateModel Associated Types type Rep CreateModel :: Type -> Type # Methods from :: CreateModel -> Rep CreateModel x # to :: Rep CreateModel x -> CreateModel #
NFData CreateModel Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateModel Methods rnf :: CreateModel -> () #
Hashable CreateModel Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateModel Methods hashWithSalt :: Int -> CreateModel -> Int # hash :: CreateModel -> Int #
ToJSON CreateModel Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateModel Methods toJSON :: CreateModel -> Value # toEncoding :: CreateModel -> Encoding # toJSONList :: [CreateModel] -> Value # toEncodingList :: [CreateModel] -> Encoding #
AWSRequest CreateModel Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateModel Associated Types type AWSResponse CreateModel # Methods request :: CreateModel -> Request CreateModel # response :: MonadResource m => Logger -> Service -> Proxy CreateModel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateModel))) #
ToHeaders CreateModel Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateModel Methods toHeaders :: CreateModel -> [Header] #
ToPath CreateModel Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateModel Methods toPath :: CreateModel -> ByteString #
ToQuery CreateModel Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateModel Methods toQuery :: CreateModel -> QueryString #
type Rep CreateModel Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateModel type Rep CreateModel = D1 ('MetaData "CreateModel" "Amazonka.ApiGatewayV2.CreateModel" "libZSservicesZSamazonka-apigatewayv2ZSamazonka-apigatewayv2" 'False) (C1 ('MetaCons "CreateModel'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "contentType") '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)))))
type AWSResponse CreateModel Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateModel type AWSResponse CreateModel = CreateModelResponse

newCreateModel Source #

Arguments

:: Text	`$sel:apiId:CreateModel'`
-> Text	`$sel:schema:CreateModel'`
-> Text	`$sel:name: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:

$sel:description:CreateModel', createModel_description - The description of the model.

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

$sel:apiId:CreateModel', createModel_apiId - The API identifier.

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

$sel:name:CreateModel', createModel_name - The name of the model. Must be alphanumeric.

Request Lenses

createModel_description :: Lens' CreateModel (Maybe Text) Source #

The description of the model.

createModel_contentType :: Lens' CreateModel (Maybe Text) Source #

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

createModel_apiId :: Lens' CreateModel Text Source #

The API identifier.

createModel_schema :: Lens' CreateModel Text Source #

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

createModel_name :: Lens' CreateModel Text Source #

The name of the model. Must be alphanumeric.

Destructuring the Response

data CreateModelResponse Source #

See: newCreateModelResponse smart constructor.

Constructors

CreateModelResponse'

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.
name :: Maybe Text
The name of the model. Must be alphanumeric.
description :: Maybe Text
The description of the model.
contentType :: Maybe Text
The content-type for the model, for example, "application/json".
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq CreateModelResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateModel Methods (==) :: CreateModelResponse -> CreateModelResponse -> Bool # (/=) :: CreateModelResponse -> CreateModelResponse -> Bool #
Read CreateModelResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateModel Methods readsPrec :: Int -> ReadS CreateModelResponse # readList :: ReadS [CreateModelResponse] # readPrec :: ReadPrec CreateModelResponse # readListPrec :: ReadPrec [CreateModelResponse] #
Show CreateModelResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateModel Methods showsPrec :: Int -> CreateModelResponse -> ShowS # show :: CreateModelResponse -> String # showList :: [CreateModelResponse] -> ShowS #
Generic CreateModelResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateModel Associated Types type Rep CreateModelResponse :: Type -> Type # Methods from :: CreateModelResponse -> Rep CreateModelResponse x # to :: Rep CreateModelResponse x -> CreateModelResponse #
NFData CreateModelResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateModel Methods rnf :: CreateModelResponse -> () #
type Rep CreateModelResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateModel type Rep CreateModelResponse = D1 ('MetaData "CreateModelResponse" "Amazonka.ApiGatewayV2.CreateModel" "libZSservicesZSamazonka-apigatewayv2ZSamazonka-apigatewayv2" 'False) (C1 ('MetaCons "CreateModelResponse'" '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 "name") '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 "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateModelResponse Source #

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:

$sel:modelId:CreateModelResponse', createModelResponse_modelId - The model identifier.

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

$sel:name:CreateModel', createModelResponse_name - The name of the model. Must be alphanumeric.

$sel:description:CreateModel', createModelResponse_description - The description of the model.

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

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

Response Lenses

createModelResponse_modelId :: Lens' CreateModelResponse (Maybe Text) Source #

The model identifier.

createModelResponse_schema :: Lens' CreateModelResponse (Maybe Text) Source #

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

createModelResponse_name :: Lens' CreateModelResponse (Maybe Text) Source #

The name of the model. Must be alphanumeric.

createModelResponse_description :: Lens' CreateModelResponse (Maybe Text) Source #

The description of the model.

createModelResponse_contentType :: Lens' CreateModelResponse (Maybe Text) Source #

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

createModelResponse_httpStatus :: Lens' CreateModelResponse Int Source #

The response's http status code.