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

Contents

Description

Create an ApiKey resource.

Synopsis

Creating a Request

createAPIKey :: CreateAPIKey Source #

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

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

data CreateAPIKey Source #

Request to create an ApiKey resource.

See: createAPIKey smart constructor.

Instances

Eq CreateAPIKey Source # 
Data CreateAPIKey Source # 

Methods

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

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

toConstr :: CreateAPIKey -> Constr #

dataTypeOf :: CreateAPIKey -> DataType #

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

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

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

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

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

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

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

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

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

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

Read CreateAPIKey Source # 
Show CreateAPIKey Source # 
Generic CreateAPIKey Source # 

Associated Types

type Rep CreateAPIKey :: * -> * #

Hashable CreateAPIKey Source # 
ToJSON CreateAPIKey Source # 
NFData CreateAPIKey Source # 

Methods

rnf :: CreateAPIKey -> () #

AWSRequest CreateAPIKey Source # 
ToQuery CreateAPIKey Source # 
ToPath CreateAPIKey Source # 
ToHeaders CreateAPIKey Source # 
type Rep CreateAPIKey Source # 
type Rep CreateAPIKey = D1 (MetaData "CreateAPIKey" "Network.AWS.APIGateway.CreateAPIKey" "amazonka-apigateway-1.4.3-GVOaWI3QK1e6b27bXNOifn" False) (C1 (MetaCons "CreateAPIKey'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cakEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_cakName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_cakStageKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [StageKey]))) (S1 (MetaSel (Just Symbol "_cakDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Rs CreateAPIKey Source # 

Request Lenses

cakEnabled :: Lens' CreateAPIKey (Maybe Bool) Source #

Specifies whether the ApiKey can be used by callers.

cakStageKeys :: Lens' CreateAPIKey [StageKey] Source #

Specifies whether the ApiKey can be used by callers.

Destructuring the Response

apiKey :: APIKey Source #

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

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

data APIKey Source #

A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

See: apiKey smart constructor.

Instances

Eq APIKey Source # 

Methods

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

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

Data APIKey Source # 

Methods

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

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

toConstr :: APIKey -> Constr #

dataTypeOf :: APIKey -> DataType #

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

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

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

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

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

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

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

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

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

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

Read APIKey Source # 
Show APIKey Source # 
Generic APIKey Source # 

Associated Types

type Rep APIKey :: * -> * #

Methods

from :: APIKey -> Rep APIKey x #

to :: Rep APIKey x -> APIKey #

Hashable APIKey Source # 

Methods

hashWithSalt :: Int -> APIKey -> Int #

hash :: APIKey -> Int #

FromJSON APIKey Source # 
NFData APIKey Source # 

Methods

rnf :: APIKey -> () #

type Rep APIKey Source # 

Response Lenses

akEnabled :: Lens' APIKey (Maybe Bool) Source #

Specifies whether the API Key can be used by callers.

akCreatedDate :: Lens' APIKey (Maybe UTCTime) Source #

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

akName :: Lens' APIKey (Maybe Text) Source #

The name of the API Key.

akId :: Lens' APIKey (Maybe Text) Source #

The identifier of the API Key.

akStageKeys :: Lens' APIKey [Text] Source #

A list of Stage resources that are associated with the ApiKey resource.

akLastUpdatedDate :: Lens' APIKey (Maybe UTCTime) Source #

When the API Key was last updated, in ISO 8601 format.

akDescription :: Lens' APIKey (Maybe Text) Source #

The description of the API Key.