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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Create an ApiKey resource.

AWS CLI

Synopsis

Creating a Request

createAPIKey :: CreateAPIKey #

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:

cakEnabled - Specifies whether the ApiKey can be used by callers.
cakValue - Specifies a value of the API key.
cakCustomerId - An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
cakGenerateDistinctId - Specifies whether (true ) or not (false ) the key identifier is distinct from the created API key value.
cakName - The name of the ApiKey .
cakStageKeys - DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
cakDescription - The description of the ApiKey .

data CreateAPIKey #

Request to create an ApiKey resource.

See: createAPIKey smart constructor.

Instances

Eq CreateAPIKey #
Methods (==) :: CreateAPIKey -> CreateAPIKey -> Bool # (/=) :: CreateAPIKey -> CreateAPIKey -> Bool #
Data CreateAPIKey #
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 #
Methods readsPrec :: Int -> ReadS CreateAPIKey # readList :: ReadS [CreateAPIKey] # readPrec :: ReadPrec CreateAPIKey # readListPrec :: ReadPrec [CreateAPIKey] #
Show CreateAPIKey #
Methods showsPrec :: Int -> CreateAPIKey -> ShowS # show :: CreateAPIKey -> String # showList :: [CreateAPIKey] -> ShowS #
Generic CreateAPIKey #
Associated Types type Rep CreateAPIKey :: * -> * # Methods from :: CreateAPIKey -> Rep CreateAPIKey x # to :: Rep CreateAPIKey x -> CreateAPIKey #
Hashable CreateAPIKey #
Methods hashWithSalt :: Int -> CreateAPIKey -> Int # hash :: CreateAPIKey -> Int #
ToJSON CreateAPIKey #
Methods toJSON :: CreateAPIKey -> Value # toEncoding :: CreateAPIKey -> Encoding # toJSONList :: [CreateAPIKey] -> Value # toEncodingList :: [CreateAPIKey] -> Encoding #
NFData CreateAPIKey #
Methods rnf :: CreateAPIKey -> () #
AWSRequest CreateAPIKey #
Associated Types type Rs CreateAPIKey :: * # Methods request :: CreateAPIKey -> Request CreateAPIKey # response :: MonadResource m => Logger -> Service -> Proxy * CreateAPIKey -> ClientResponse -> m (Response CreateAPIKey) #
ToQuery CreateAPIKey #
Methods toQuery :: CreateAPIKey -> QueryString #
ToPath CreateAPIKey #
Methods toPath :: CreateAPIKey -> ByteString #
ToHeaders CreateAPIKey #
Methods toHeaders :: CreateAPIKey -> [Header] #
type Rep CreateAPIKey #
type Rep CreateAPIKey = D1 (MetaData "CreateAPIKey" "Network.AWS.APIGateway.CreateAPIKey" "amazonka-apigateway-1.4.5-5OCToOwmZjEH3FMiU9Yogu" False) (C1 (MetaCons "CreateAPIKey'" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "_cakEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((::) (S1 (MetaSel (Just Symbol "_cakValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cakCustomerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((::) ((::) (S1 (MetaSel (Just Symbol "_cakGenerateDistinctId") 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 #
type Rs CreateAPIKey = APIKey

Request Lenses

cakEnabled :: Lens' CreateAPIKey (Maybe Bool) #

Specifies whether the ApiKey can be used by callers.

cakValue :: Lens' CreateAPIKey (Maybe Text) #

Specifies a value of the API key.

cakCustomerId :: Lens' CreateAPIKey (Maybe Text) #

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

cakGenerateDistinctId :: Lens' CreateAPIKey (Maybe Bool) #

Specifies whether (true ) or not (false ) the key identifier is distinct from the created API key value.

cakName :: Lens' CreateAPIKey (Maybe Text) #

The name of the ApiKey .

cakStageKeys :: Lens' CreateAPIKey [StageKey] #

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

cakDescription :: Lens' CreateAPIKey (Maybe Text) #

The description of the ApiKey .

Destructuring the Response

apiKey :: APIKey #

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:

akEnabled - Specifies whether the API Key can be used by callers.
akValue - The value of the API Key.
akCustomerId - An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
akCreatedDate - The date when the API Key was created, in ISO 8601 format .
akName - The name of the API Key.
akId - The identifier of the API Key.
akStageKeys - A list of Stage resources that are associated with the ApiKey resource.
akLastUpdatedDate - When the API Key was last updated, in ISO 8601 format.
akDescription - The description of the API Key.

data APIKey #

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.

Use API Keys

See: apiKey smart constructor.

Instances

Eq APIKey #
Methods (==) :: APIKey -> APIKey -> Bool # (/=) :: APIKey -> APIKey -> Bool #
Data APIKey #
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 #
Methods readsPrec :: Int -> ReadS APIKey # readList :: ReadS [APIKey] # readPrec :: ReadPrec APIKey # readListPrec :: ReadPrec [APIKey] #
Show APIKey #
Methods showsPrec :: Int -> APIKey -> ShowS # show :: APIKey -> String # showList :: [APIKey] -> ShowS #
Generic APIKey #
Associated Types type Rep APIKey :: * -> * # Methods from :: APIKey -> Rep APIKey x # to :: Rep APIKey x -> APIKey #
Hashable APIKey #
Methods hashWithSalt :: Int -> APIKey -> Int # hash :: APIKey -> Int #
FromJSON APIKey #
Methods parseJSON :: Value -> Parser APIKey # parseJSONList :: Value -> Parser [APIKey] #
NFData APIKey #
Methods rnf :: APIKey -> () #
type Rep APIKey #
type Rep APIKey = D1 (MetaData "APIKey" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.5-5OCToOwmZjEH3FMiU9Yogu" False) (C1 (MetaCons "APIKey'" PrefixI True) ((::) ((::) ((::) (S1 (MetaSel (Just Symbol "_akEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_akValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((::) (S1 (MetaSel (Just Symbol "_akCustomerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_akCreatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))))) ((::) ((::) (S1 (MetaSel (Just Symbol "_akName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_akId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((::) (S1 (MetaSel (Just Symbol "_akStageKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((::) (S1 (MetaSel (Just Symbol "_akLastUpdatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) (S1 (MetaSel (Just Symbol "_akDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))