Network.AWS.APIGateway.CreateRestAPI

Creates a new RestApi resource.

Creating a Request

createRestAPI

Arguments

:: Text

craName

-> CreateRestAPI

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

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

• craCloneFrom
• craDescription
• craName

data CreateRestAPI

The POST Request to add a new RestApi resource to your collection.

See: createRestAPI smart constructor.

Instances

Eq CreateRestAPI

Methods

(==) :: CreateRestAPI -> CreateRestAPI -> Bool

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

Data CreateRestAPI

Methods

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

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

toConstr :: CreateRestAPI -> Constr

dataTypeOf :: CreateRestAPI -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateRestAPI

Methods

readsPrec :: Int -> ReadS CreateRestAPI

readList :: ReadS [CreateRestAPI]

readPrec :: ReadPrec CreateRestAPI

readListPrec :: ReadPrec [CreateRestAPI]

Show CreateRestAPI

Methods

showsPrec :: Int -> CreateRestAPI -> ShowS

show :: CreateRestAPI -> String

showList :: [CreateRestAPI] -> ShowS

Generic CreateRestAPI

Associated Types

type Rep CreateRestAPI :: * -> *

Methods

from :: CreateRestAPI -> Rep CreateRestAPI x

to :: Rep CreateRestAPI x -> CreateRestAPI

ToJSON CreateRestAPI

Methods

toJSON :: CreateRestAPI -> Value

toEncoding :: CreateRestAPI -> Encoding

Hashable CreateRestAPI

Methods

hashWithSalt :: Int -> CreateRestAPI -> Int

hash :: CreateRestAPI -> Int

NFData CreateRestAPI

Methods

rnf :: CreateRestAPI -> ()

AWSRequest CreateRestAPI

Associated Types

type Rs CreateRestAPI :: *

Methods

request :: CreateRestAPI -> Request CreateRestAPI

response :: MonadResource m => Logger -> Service -> Proxy * CreateRestAPI -> ClientResponse -> m (Response CreateRestAPI)

ToPath CreateRestAPI

Methods

toPath :: CreateRestAPI -> ByteString

ToHeaders CreateRestAPI

Methods

toHeaders :: CreateRestAPI -> [Header]

ToQuery CreateRestAPI

Methods

toQuery :: CreateRestAPI -> QueryString

type Rep CreateRestAPI

type Rep CreateRestAPI = D1 (MetaData "CreateRestAPI" "Network.AWS.APIGateway.CreateRestAPI" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "CreateRestAPI'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_craCloneFrom") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_craDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_craName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs CreateRestAPI

type Rs CreateRestAPI = RestAPI

Request Lenses

craCloneFrom :: Lens' CreateRestAPI (Maybe Text)

The Id of the RestApi that you want to clone from.

craDescription :: Lens' CreateRestAPI (Maybe Text)

The description of the RestApi.

craName :: Lens' CreateRestAPI Text

The name of the RestApi.

Destructuring the Response

restAPI :: RestAPI

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:

• raWarnings
• raCreatedDate
• raName
• raId
• raDescription

data RestAPI

Represents a REST API.

See: restAPI smart constructor.

Instances

Eq RestAPI

Methods

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

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

Data RestAPI

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

Methods

readsPrec :: Int -> ReadS RestAPI

readList :: ReadS [RestAPI]

readPrec :: ReadPrec RestAPI

readListPrec :: ReadPrec [RestAPI]

Show RestAPI

Methods

showsPrec :: Int -> RestAPI -> ShowS

show :: RestAPI -> String

showList :: [RestAPI] -> ShowS

Generic RestAPI

Associated Types

type Rep RestAPI :: * -> *

Methods

from :: RestAPI -> Rep RestAPI x

to :: Rep RestAPI x -> RestAPI

FromJSON RestAPI

Methods

parseJSON :: Value -> Parser RestAPI

Hashable RestAPI

Methods

hashWithSalt :: Int -> RestAPI -> Int

hash :: RestAPI -> Int

NFData RestAPI

Methods

rnf :: RestAPI -> ()

type Rep RestAPI

type Rep RestAPI = D1 (MetaData "RestAPI" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" 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 ISO8601)))) ((:*:) (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]

Undocumented member.

raCreatedDate :: Lens' RestAPI (Maybe UTCTime)

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

raName :: Lens' RestAPI (Maybe Text)

The API's name.

raId :: Lens' RestAPI (Maybe Text)

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

raDescription :: Lens' RestAPI (Maybe Text)

The API's description.