amazonka-apigateway-1.6.1: Amazon API Gateway SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.APIGateway.UpdateAPIKey

Contents

Description

Changes information about an ApiKey resource.

Synopsis

Creating a Request

updateAPIKey Source #

Arguments

:: Text

uakApiKey

-> UpdateAPIKey 

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

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

  • uakPatchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.
  • uakApiKey - [Required] The identifier of the ApiKey resource to be updated.

data UpdateAPIKey Source #

A request to change information about an ApiKey resource.

See: updateAPIKey smart constructor.

Instances
Eq UpdateAPIKey Source # 
Instance details

Defined in Network.AWS.APIGateway.UpdateAPIKey

Data UpdateAPIKey Source # 
Instance details

Defined in Network.AWS.APIGateway.UpdateAPIKey

Methods

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

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

toConstr :: UpdateAPIKey -> Constr #

dataTypeOf :: UpdateAPIKey -> DataType #

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

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

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

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

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

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

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

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

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

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

Read UpdateAPIKey Source # 
Instance details

Defined in Network.AWS.APIGateway.UpdateAPIKey

Show UpdateAPIKey Source # 
Instance details

Defined in Network.AWS.APIGateway.UpdateAPIKey

Generic UpdateAPIKey Source # 
Instance details

Defined in Network.AWS.APIGateway.UpdateAPIKey

Associated Types

type Rep UpdateAPIKey :: Type -> Type #

Hashable UpdateAPIKey Source # 
Instance details

Defined in Network.AWS.APIGateway.UpdateAPIKey

ToJSON UpdateAPIKey Source # 
Instance details

Defined in Network.AWS.APIGateway.UpdateAPIKey

AWSRequest UpdateAPIKey Source # 
Instance details

Defined in Network.AWS.APIGateway.UpdateAPIKey

Associated Types

type Rs UpdateAPIKey :: Type #

ToHeaders UpdateAPIKey Source # 
Instance details

Defined in Network.AWS.APIGateway.UpdateAPIKey

ToPath UpdateAPIKey Source # 
Instance details

Defined in Network.AWS.APIGateway.UpdateAPIKey

ToQuery UpdateAPIKey Source # 
Instance details

Defined in Network.AWS.APIGateway.UpdateAPIKey

NFData UpdateAPIKey Source # 
Instance details

Defined in Network.AWS.APIGateway.UpdateAPIKey

Methods

rnf :: UpdateAPIKey -> () #

type Rep UpdateAPIKey Source # 
Instance details

Defined in Network.AWS.APIGateway.UpdateAPIKey

type Rep UpdateAPIKey = D1 (MetaData "UpdateAPIKey" "Network.AWS.APIGateway.UpdateAPIKey" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" False) (C1 (MetaCons "UpdateAPIKey'" PrefixI True) (S1 (MetaSel (Just "_uakPatchOperations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PatchOperation])) :*: S1 (MetaSel (Just "_uakApiKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))
type Rs UpdateAPIKey Source # 
Instance details

Defined in Network.AWS.APIGateway.UpdateAPIKey

Request Lenses

uakPatchOperations :: Lens' UpdateAPIKey [PatchOperation] Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

uakApiKey :: Lens' UpdateAPIKey Text Source #

Required
The identifier of the ApiKey resource to be updated.

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:

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

Use API Keys

See: apiKey smart constructor.

Instances
Eq APIKey Source # 
Instance details

Defined in Network.AWS.APIGateway.Types.Product

Methods

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

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

Data APIKey Source # 
Instance details

Defined in Network.AWS.APIGateway.Types.Product

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 # 
Instance details

Defined in Network.AWS.APIGateway.Types.Product

Show APIKey Source # 
Instance details

Defined in Network.AWS.APIGateway.Types.Product

Generic APIKey Source # 
Instance details

Defined in Network.AWS.APIGateway.Types.Product

Associated Types

type Rep APIKey :: Type -> Type #

Methods

from :: APIKey -> Rep APIKey x #

to :: Rep APIKey x -> APIKey #

Hashable APIKey Source # 
Instance details

Defined in Network.AWS.APIGateway.Types.Product

Methods

hashWithSalt :: Int -> APIKey -> Int #

hash :: APIKey -> Int #

FromJSON APIKey Source # 
Instance details

Defined in Network.AWS.APIGateway.Types.Product

NFData APIKey Source # 
Instance details

Defined in Network.AWS.APIGateway.Types.Product

Methods

rnf :: APIKey -> () #

type Rep APIKey Source # 
Instance details

Defined in Network.AWS.APIGateway.Types.Product

Response Lenses

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

Specifies whether the API Key can be used by callers.

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

The value of the API Key.

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

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

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

The timestamp when the API Key was created.

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 #

The timestamp when the API Key was last updated.

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

The description of the API Key.