amazonka-apigateway-1.4.3: Amazon API Gateway SDK.

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

Network.AWS.APIGateway.ImportRestAPI

Contents

Description

A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.

Synopsis

Creating a Request

importRestAPI Source #

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

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

data ImportRestAPI Source #

A POST request to import an API to Amazon API Gateway using an input of an API definition file.

See: importRestAPI smart constructor.

Instances

Eq ImportRestAPI Source # 
Data ImportRestAPI Source # 

Methods

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

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

toConstr :: ImportRestAPI -> Constr #

dataTypeOf :: ImportRestAPI -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ImportRestAPI) #

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

gmapT :: (forall b. Data b => b -> b) -> ImportRestAPI -> ImportRestAPI #

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

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

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

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

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

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

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

Show ImportRestAPI Source # 
Generic ImportRestAPI Source # 

Associated Types

type Rep ImportRestAPI :: * -> * #

Hashable ImportRestAPI Source # 
NFData ImportRestAPI Source # 

Methods

rnf :: ImportRestAPI -> () #

AWSRequest ImportRestAPI Source # 
ToBody ImportRestAPI Source # 
ToQuery ImportRestAPI Source # 
ToPath ImportRestAPI Source # 
ToHeaders ImportRestAPI Source # 
type Rep ImportRestAPI Source # 
type Rep ImportRestAPI = D1 (MetaData "ImportRestAPI" "Network.AWS.APIGateway.ImportRestAPI" "amazonka-apigateway-1.4.3-GVOaWI3QK1e6b27bXNOifn" False) (C1 (MetaCons "ImportRestAPI'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_iraFailOnWarnings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_iraParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) (S1 (MetaSel (Just Symbol "_iraBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (HashMap Text Value))))))
type Rs ImportRestAPI Source # 

Request Lenses

iraFailOnWarnings :: Lens' ImportRestAPI (Maybe Bool) Source #

A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.

iraParameters :: Lens' ImportRestAPI (HashMap Text Text) Source #

Custom header parameters as part of the request.

iraBody :: Lens' ImportRestAPI (HashMap Text Value) Source #

The POST request body containing external API definitions. Currently, only Swagger definition JSON files are supported.

Destructuring the Response

restAPI :: RestAPI Source #

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

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

data RestAPI Source #

Represents a REST API.

See: restAPI smart constructor.

Instances

Eq RestAPI Source # 

Methods

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

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

Data RestAPI Source # 

Methods

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

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

toConstr :: RestAPI -> Constr #

dataTypeOf :: RestAPI -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RestAPI) #

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

gmapT :: (forall b. Data b => b -> b) -> RestAPI -> RestAPI #

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

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

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

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

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

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

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

Read RestAPI Source # 
Show RestAPI Source # 
Generic RestAPI Source # 

Associated Types

type Rep RestAPI :: * -> * #

Methods

from :: RestAPI -> Rep RestAPI x #

to :: Rep RestAPI x -> RestAPI #

Hashable RestAPI Source # 

Methods

hashWithSalt :: Int -> RestAPI -> Int #

hash :: RestAPI -> Int #

FromJSON RestAPI Source # 
NFData RestAPI Source # 

Methods

rnf :: RestAPI -> () #

type Rep RestAPI Source # 
type Rep RestAPI = D1 (MetaData "RestAPI" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.3-GVOaWI3QK1e6b27bXNOifn" False) (C1 (MetaCons "RestAPI'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_raWarnings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_raCreatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)))) ((:*:) (S1 (MetaSel (Just Symbol "_raName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_raId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_raDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

Response Lenses

raWarnings :: Lens' RestAPI [Text] Source #

Undocumented member.

raCreatedDate :: Lens' RestAPI (Maybe UTCTime) Source #

The date when the API was created, in ISO 8601 format.

raName :: Lens' RestAPI (Maybe Text) Source #

The API's name.

raId :: Lens' RestAPI (Maybe Text) Source #

The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.

raDescription :: Lens' RestAPI (Maybe Text) Source #

The API's description.