Copyright	(c) 2013-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.APIGateway.GetModel

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes an existing model defined for a RestApi resource.

Synopsis

Creating a Request

getModel Source #

Arguments

:: Text	`ggRestAPIId`
-> Text	`ggModelName`
-> GetModel

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

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

data GetModel Source #

Request to list information about a model in an existing RestApi resource.

See: getModel smart constructor.

Instances

Eq GetModel Source #
Methods (==) :: GetModel -> GetModel -> Bool # (/=) :: GetModel -> GetModel -> Bool #
Data GetModel Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetModel -> c GetModel # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetModel # toConstr :: GetModel -> Constr # dataTypeOf :: GetModel -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c GetModel) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetModel) # gmapT :: (forall b. Data b => b -> b) -> GetModel -> GetModel # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetModel -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetModel -> r # gmapQ :: (forall d. Data d => d -> u) -> GetModel -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetModel -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetModel -> m GetModel # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetModel -> m GetModel # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetModel -> m GetModel #
Read GetModel Source #
Methods readsPrec :: Int -> ReadS GetModel # readList :: ReadS [GetModel] # readPrec :: ReadPrec GetModel # readListPrec :: ReadPrec [GetModel] #
Show GetModel Source #
Methods showsPrec :: Int -> GetModel -> ShowS # show :: GetModel -> String # showList :: [GetModel] -> ShowS #
Generic GetModel Source #
Associated Types type Rep GetModel :: * -> * # Methods from :: GetModel -> Rep GetModel x # to :: Rep GetModel x -> GetModel #
Hashable GetModel Source #
Methods hashWithSalt :: Int -> GetModel -> Int # hash :: GetModel -> Int #
NFData GetModel Source #
Methods rnf :: GetModel -> () #
AWSRequest GetModel Source #
Associated Types type Rs GetModel :: * # Methods request :: GetModel -> Request GetModel # response :: MonadResource m => Logger -> Service -> Proxy * GetModel -> ClientResponse -> m (Response GetModel) #
ToPath GetModel Source #
Methods toPath :: GetModel -> ByteString #
ToHeaders GetModel Source #
Methods toHeaders :: GetModel -> [Header] #
ToQuery GetModel Source #
Methods toQuery :: GetModel -> QueryString #
type Rep GetModel Source #
type Rep GetModel = D1 (MetaData "GetModel" "Network.AWS.APIGateway.GetModel" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "GetModel'" PrefixI True) ((::) (S1 (MetaSel (Just Symbol "_ggFlatten") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((::) (S1 (MetaSel (Just Symbol "_ggRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ggModelName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs GetModel Source #
type Rs GetModel = Model

Request Lenses

ggFlatten :: Lens' GetModel (Maybe Bool) Source #

Resolves all external model references and returns a flattened model schema.

ggRestAPIId :: Lens' GetModel Text Source #

The RestApi identifier under which the Model exists.

ggModelName :: Lens' GetModel Text Source #

The name of the model as an identifier.

Destructuring the Response

model :: Model Source #

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:

data Model Source #

Represents the structure of a request or response payload for a method.

See: model smart constructor.

Instances

Eq Model Source #
Methods (==) :: Model -> Model -> Bool # (/=) :: Model -> Model -> Bool #
Data Model Source #
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 Source #
Methods readsPrec :: Int -> ReadS Model # readList :: ReadS [Model] # readPrec :: ReadPrec Model # readListPrec :: ReadPrec [Model] #
Show Model Source #
Methods showsPrec :: Int -> Model -> ShowS # show :: Model -> String # showList :: [Model] -> ShowS #
Generic Model Source #
Associated Types type Rep Model :: * -> * # Methods from :: Model -> Rep Model x # to :: Rep Model x -> Model #
FromJSON Model Source #
Methods parseJSON :: Value -> Parser Model #
Hashable Model Source #
Methods hashWithSalt :: Int -> Model -> Int # hash :: Model -> Int #
NFData Model Source #
Methods rnf :: Model -> () #
type Rep Model Source #
type Rep Model = D1 (MetaData "Model" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "Model'" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "_mSchema") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_mName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((::) (S1 (MetaSel (Just Symbol "_mId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((::) (S1 (MetaSel (Just Symbol "_mDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_mContentType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

Response Lenses

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

The schema for the model. For 'application\/json' models, this should be JSON-schema draft v4 model.

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

The name of the model.

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

The identifier for the model resource.

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

The description of the model.

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

The content-type for the model.