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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about the current ApiKey resource.

Synopsis

Creating a Request

getAPIKey Source #

Arguments

:: Text	`gakApiKey`
-> GetAPIKey

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

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

gakApiKey

data GetAPIKey Source #

A request to get information about the current ApiKey resource.

See: getAPIKey smart constructor.

Instances

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

Request Lenses

gakApiKey :: Lens' GetAPIKey Text Source #

The identifier of the ApiKey resource.

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 #
Methods readsPrec :: Int -> ReadS APIKey # readList :: ReadS [APIKey] # readPrec :: ReadPrec APIKey # readListPrec :: ReadPrec [APIKey] #
Show APIKey Source #
Methods showsPrec :: Int -> APIKey -> ShowS # show :: APIKey -> String # showList :: [APIKey] -> ShowS #
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 #
Methods parseJSON :: Value -> Parser APIKey # parseJSONList :: Value -> Parser [APIKey] #
NFData APIKey Source #
Methods rnf :: APIKey -> () #
type Rep APIKey Source #
type Rep APIKey = D1 (MetaData "APIKey" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.3-GVOaWI3QK1e6b27bXNOifn" False) (C1 (MetaCons "APIKey'" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "_akEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((::) (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)))))))

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.