Network.AWS.APIGateway.UpdateModel

Changes information about a model.

Creating a Request

updateModel

Arguments

:: Text

uRestAPIId

-> Text

uModelName

-> UpdateModel

Creates a value of UpdateModel with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• uPatchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.
• uRestAPIId - [Required] The string identifier of the associated RestApi .
• uModelName - [Required] The name of the model to update.

data UpdateModel

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

See: updateModel smart constructor.

Instances

Eq UpdateModel

Defined in Network.AWS.APIGateway.UpdateModel

Methods

(==) :: UpdateModel -> UpdateModel -> Bool

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

Data UpdateModel

Defined in Network.AWS.APIGateway.UpdateModel

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateModel -> c UpdateModel

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateModel

toConstr :: UpdateModel -> Constr

dataTypeOf :: UpdateModel -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateModel)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateModel)

gmapT :: (forall b. Data b => b -> b) -> UpdateModel -> UpdateModel

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateModel -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateModel -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateModel -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateModel -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateModel -> m UpdateModel

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateModel -> m UpdateModel

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateModel -> m UpdateModel

Read UpdateModel

Defined in Network.AWS.APIGateway.UpdateModel

Methods

readsPrec :: Int -> ReadS UpdateModel

readList :: ReadS [UpdateModel]

readPrec :: ReadPrec UpdateModel

readListPrec :: ReadPrec [UpdateModel]

Show UpdateModel

Defined in Network.AWS.APIGateway.UpdateModel

Methods

showsPrec :: Int -> UpdateModel -> ShowS

show :: UpdateModel -> String

showList :: [UpdateModel] -> ShowS

Generic UpdateModel

Defined in Network.AWS.APIGateway.UpdateModel

Associated Types

type Rep UpdateModel :: Type -> Type

Methods

from :: UpdateModel -> Rep UpdateModel x

to :: Rep UpdateModel x -> UpdateModel

Hashable UpdateModel

Defined in Network.AWS.APIGateway.UpdateModel

Methods

hashWithSalt :: Int -> UpdateModel -> Int

hash :: UpdateModel -> Int

ToJSON UpdateModel

Defined in Network.AWS.APIGateway.UpdateModel

Methods

toJSON :: UpdateModel -> Value

toEncoding :: UpdateModel -> Encoding

toJSONList :: [UpdateModel] -> Value

toEncodingList :: [UpdateModel] -> Encoding

AWSRequest UpdateModel

Defined in Network.AWS.APIGateway.UpdateModel

Associated Types

type Rs UpdateModel :: Type

Methods

request :: UpdateModel -> Request UpdateModel

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy UpdateModel -> ClientResponse -> m (Response UpdateModel)

ToHeaders UpdateModel

Defined in Network.AWS.APIGateway.UpdateModel

Methods

toHeaders :: UpdateModel -> [Header]

ToPath UpdateModel

Defined in Network.AWS.APIGateway.UpdateModel

Methods

toPath :: UpdateModel -> ByteString

ToQuery UpdateModel

Defined in Network.AWS.APIGateway.UpdateModel

Methods

toQuery :: UpdateModel -> QueryString

NFData UpdateModel

Defined in Network.AWS.APIGateway.UpdateModel

Methods

rnf :: UpdateModel -> ()

type Rep UpdateModel

Defined in Network.AWS.APIGateway.UpdateModel

type Rep UpdateModel = D1 (MetaData "UpdateModel" "Network.AWS.APIGateway.UpdateModel" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" False) (C1 (MetaCons "UpdateModel'" PrefixI True) (S1 (MetaSel (Just "_uPatchOperations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PatchOperation])) :*: (S1 (MetaSel (Just "_uRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_uModelName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs UpdateModel

Defined in Network.AWS.APIGateway.UpdateModel

type Rs UpdateModel = Model

Request Lenses

uPatchOperations :: Lens' UpdateModel [PatchOperation]

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

uRestAPIId :: Lens' UpdateModel Text

Required

The string identifier of the associated RestApi .

uModelName :: Lens' UpdateModel Text

Required

The name of the model to update.

Destructuring the Response

model :: Model

Creates a value of Model with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• mSchema - 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.
• mName - The name of the model. Must be an alphanumeric string.
• mId - The identifier for the model resource.
• mDescription - The description of the model.
• mContentType - The content-type for the model.

data Model

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: model smart constructor.

Instances

Eq Model

Defined in Network.AWS.APIGateway.Types.Product

Methods

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

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

Data Model

Defined in Network.AWS.APIGateway.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Model -> c Model

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Model

toConstr :: Model -> Constr

dataTypeOf :: Model -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Model)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Model)

gmapT :: (forall b. Data b => b -> b) -> Model -> Model

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Model -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Model -> r

gmapQ :: (forall d. Data d => d -> u) -> Model -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Model -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Model -> m Model

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Model -> m Model

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Model -> m Model

Read Model

Defined in Network.AWS.APIGateway.Types.Product

Methods

readsPrec :: Int -> ReadS Model

readList :: ReadS [Model]

readPrec :: ReadPrec Model

readListPrec :: ReadPrec [Model]

Show Model

Defined in Network.AWS.APIGateway.Types.Product

Methods

showsPrec :: Int -> Model -> ShowS

show :: Model -> String

showList :: [Model] -> ShowS

Generic Model

Defined in Network.AWS.APIGateway.Types.Product

Associated Types

type Rep Model :: Type -> Type

Methods

from :: Model -> Rep Model x

to :: Rep Model x -> Model

Hashable Model

Defined in Network.AWS.APIGateway.Types.Product

Methods

hashWithSalt :: Int -> Model -> Int

hash :: Model -> Int

FromJSON Model

Defined in Network.AWS.APIGateway.Types.Product

Methods

parseJSON :: Value -> Parser Model

parseJSONList :: Value -> Parser [Model]

NFData Model

Defined in Network.AWS.APIGateway.Types.Product

Methods

rnf :: Model -> ()

type Rep Model

Defined in Network.AWS.APIGateway.Types.Product

type Rep Model = D1 (MetaData "Model" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" False) (C1 (MetaCons "Model'" PrefixI True) ((S1 (MetaSel (Just "_mSchema") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_mName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_mId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_mDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_mContentType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

Response Lenses

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

mName :: Lens' Model (Maybe Text)

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

mId :: Lens' Model (Maybe Text)

The identifier for the model resource.

mDescription :: Lens' Model (Maybe Text)

The description of the model.

mContentType :: Lens' Model (Maybe Text)

The content-type for the model.