libZSservicesZSamazonka-apigatewayZSamazonka-apigateway
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.APIGateway.UpdateModel

Description

Changes information about a model.

Synopsis

Creating a Request

data UpdateModel Source #

Request to update an existing model in an existing RestApi resource.

See: newUpdateModel smart constructor.

Constructors

UpdateModel' 

Fields

Instances

Instances details
Eq UpdateModel Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateModel

Read UpdateModel Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateModel

Show UpdateModel Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateModel

Generic UpdateModel Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateModel

Associated Types

type Rep UpdateModel :: Type -> Type #

NFData UpdateModel Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateModel

Methods

rnf :: UpdateModel -> () #

Hashable UpdateModel Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateModel

ToJSON UpdateModel Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateModel

AWSRequest UpdateModel Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateModel

Associated Types

type AWSResponse UpdateModel #

ToHeaders UpdateModel Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateModel

Methods

toHeaders :: UpdateModel -> [Header] #

ToPath UpdateModel Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateModel

ToQuery UpdateModel Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateModel

type Rep UpdateModel Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateModel

type Rep UpdateModel = D1 ('MetaData "UpdateModel" "Amazonka.APIGateway.UpdateModel" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "UpdateModel'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :*: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "modelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse UpdateModel Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateModel

newUpdateModel Source #

Create a value of UpdateModel 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:patchOperations:UpdateModel', updateModel_patchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.

$sel:restApiId:UpdateModel', updateModel_restApiId - [Required] The string identifier of the associated RestApi.

$sel:modelName:UpdateModel', updateModel_modelName - [Required] The name of the model to update.

Request Lenses

updateModel_patchOperations :: Lens' UpdateModel (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateModel_restApiId :: Lens' UpdateModel Text Source #

Required
The string identifier of the associated RestApi.

updateModel_modelName :: Lens' UpdateModel Text Source #

Required
The name of the model to update.

Destructuring the Response

data Model Source #

Represents the data structure of a method's request or response payload.

A request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end.

A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.

Method, MethodResponse, Models and Mappings

See: newModel smart constructor.

Constructors

Model' 

Fields

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

  • name :: Maybe Text

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

  • id :: Maybe Text

    The identifier for the model resource.

  • description :: Maybe Text

    The description of the model.

  • contentType :: Maybe Text

    The content-type for the model.

Instances

Instances details
Eq Model Source # 
Instance details

Defined in Amazonka.APIGateway.Types.Model

Methods

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

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

Read Model Source # 
Instance details

Defined in Amazonka.APIGateway.Types.Model

Show Model Source # 
Instance details

Defined in Amazonka.APIGateway.Types.Model

Methods

showsPrec :: Int -> Model -> ShowS #

show :: Model -> String #

showList :: [Model] -> ShowS #

Generic Model Source # 
Instance details

Defined in Amazonka.APIGateway.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.APIGateway.Types.Model

Methods

rnf :: Model -> () #

Hashable Model Source # 
Instance details

Defined in Amazonka.APIGateway.Types.Model

Methods

hashWithSalt :: Int -> Model -> Int #

hash :: Model -> Int #

FromJSON Model Source # 
Instance details

Defined in Amazonka.APIGateway.Types.Model

type Rep Model Source # 
Instance details

Defined in Amazonka.APIGateway.Types.Model

type Rep Model = D1 ('MetaData "Model" "Amazonka.APIGateway.Types.Model" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "Model'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "id") '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))))))

newModel :: Model Source #

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

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

$sel:id:Model', model_id - The identifier for the model resource.

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

$sel:contentType:Model', model_contentType - The content-type for the model.

Response Lenses

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

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_name :: Lens' Model (Maybe Text) Source #

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

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

The identifier for the model resource.

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.