amazonka-apigateway-1.4.5: 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.GetAPIKey

Contents

Description

Gets information about the current ApiKey resource.

Synopsis

Creating a Request

getAPIKey #

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:

  • gakIncludeValue - A boolean flag to specify whether (true ) or not (false ) the result contains the key value.
  • gakApiKey - The identifier of the ApiKey resource.

data GetAPIKey #

A request to get information about the current ApiKey resource.

See: getAPIKey smart constructor.

Instances

Eq GetAPIKey # 
Data GetAPIKey # 

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 # 
Show GetAPIKey # 
Generic GetAPIKey # 

Associated Types

type Rep GetAPIKey :: * -> * #

Hashable GetAPIKey # 
NFData GetAPIKey # 

Methods

rnf :: GetAPIKey -> () #

AWSRequest GetAPIKey # 
ToQuery GetAPIKey # 
ToPath GetAPIKey # 
ToHeaders GetAPIKey # 

Methods

toHeaders :: GetAPIKey -> [Header] #

type Rep GetAPIKey # 
type Rep GetAPIKey = D1 (MetaData "GetAPIKey" "Network.AWS.APIGateway.GetAPIKey" "amazonka-apigateway-1.4.5-5OCToOwmZjEH3FMiU9Yogu" False) (C1 (MetaCons "GetAPIKey'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gakIncludeValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_gakApiKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs GetAPIKey # 

Request Lenses

gakIncludeValue :: Lens' GetAPIKey (Maybe Bool) #

A boolean flag to specify whether (true ) or not (false ) the result contains the key value.

gakApiKey :: Lens' GetAPIKey Text #

The identifier of the ApiKey resource.

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:

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 # 
Show APIKey # 
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 # 
NFData APIKey # 

Methods

rnf :: APIKey -> () #

type Rep APIKey # 

Response Lenses

akEnabled :: Lens' APIKey (Maybe Bool) #

Specifies whether the API Key can be used by callers.

akValue :: Lens' APIKey (Maybe Text) #

The value of the API Key.

akCustomerId :: Lens' APIKey (Maybe Text) #

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

akCreatedDate :: Lens' APIKey (Maybe UTCTime) #

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

akName :: Lens' APIKey (Maybe Text) #

The name of the API Key.

akId :: Lens' APIKey (Maybe Text) #

The identifier of the API Key.

akStageKeys :: Lens' APIKey [Text] #

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

akLastUpdatedDate :: Lens' APIKey (Maybe UTCTime) #

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

akDescription :: Lens' APIKey (Maybe Text) #

The description of the API Key.