Network.AWS.APIGateway.GetAPIKey

Gets information about the current ApiKey resource.

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 - [Required] 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

Methods

(==) :: GetAPIKey -> GetAPIKey -> Bool

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

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

Methods

readsPrec :: Int -> ReadS GetAPIKey

readList :: ReadS [GetAPIKey]

readPrec :: ReadPrec GetAPIKey

readListPrec :: ReadPrec [GetAPIKey]

Show GetAPIKey

Methods

showsPrec :: Int -> GetAPIKey -> ShowS

show :: GetAPIKey -> String

showList :: [GetAPIKey] -> ShowS

Generic GetAPIKey

Associated Types

type Rep GetAPIKey :: * -> *

Methods

from :: GetAPIKey -> Rep GetAPIKey x

to :: Rep GetAPIKey x -> GetAPIKey

Hashable GetAPIKey

Methods

hashWithSalt :: Int -> GetAPIKey -> Int

hash :: GetAPIKey -> Int

NFData GetAPIKey

Methods

rnf :: GetAPIKey -> ()

AWSRequest GetAPIKey

Associated Types

type Rs GetAPIKey :: *

Methods

request :: GetAPIKey -> Request GetAPIKey

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * GetAPIKey -> ClientResponse -> m (Response GetAPIKey)

ToHeaders GetAPIKey

Methods

toHeaders :: GetAPIKey -> [Header]

ToPath GetAPIKey

Methods

toPath :: GetAPIKey -> ByteString

ToQuery GetAPIKey

Methods

toQuery :: GetAPIKey -> QueryString

type Rep GetAPIKey

type Rep GetAPIKey = D1 * (MetaData "GetAPIKey" "Network.AWS.APIGateway.GetAPIKey" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" 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

type Rs GetAPIKey = APIKey

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

Required

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:

• 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 timestamp when the API Key was created.
• 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 - The timestamp when the API Key was last updated.
• 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.6.0-JJ9NJtNe0aRBcVRYpJCEA2" 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))))))))

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 timestamp when the API Key was created.

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)

The timestamp when the API Key was last updated.

akDescription :: Lens' APIKey (Maybe Text)

The description of the API Key.