Network.AWS.APIGateway.UpdateAPIKey

Changes information about an ApiKey resource.

Creating a Request

updateAPIKey

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

data UpdateAPIKey

A request to change information about an ApiKey resource.

See: updateAPIKey smart constructor.

Instances

Eq UpdateAPIKey

Methods

(==) :: UpdateAPIKey -> UpdateAPIKey -> Bool

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

Data 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

Methods

readsPrec :: Int -> ReadS UpdateAPIKey

readList :: ReadS [UpdateAPIKey]

readPrec :: ReadPrec UpdateAPIKey

readListPrec :: ReadPrec [UpdateAPIKey]

Show UpdateAPIKey

Methods

showsPrec :: Int -> UpdateAPIKey -> ShowS

show :: UpdateAPIKey -> String

showList :: [UpdateAPIKey] -> ShowS

Generic UpdateAPIKey

Associated Types

type Rep UpdateAPIKey :: * -> *

Methods

from :: UpdateAPIKey -> Rep UpdateAPIKey x

to :: Rep UpdateAPIKey x -> UpdateAPIKey

ToJSON UpdateAPIKey

Methods

toJSON :: UpdateAPIKey -> Value

toEncoding :: UpdateAPIKey -> Encoding

Hashable UpdateAPIKey

Methods

hashWithSalt :: Int -> UpdateAPIKey -> Int

hash :: UpdateAPIKey -> Int

NFData UpdateAPIKey

Methods

rnf :: UpdateAPIKey -> ()

AWSRequest UpdateAPIKey

Associated Types

type Rs UpdateAPIKey :: *

Methods

request :: UpdateAPIKey -> Request UpdateAPIKey

response :: MonadResource m => Logger -> Service -> Proxy * UpdateAPIKey -> ClientResponse -> m (Response UpdateAPIKey)

ToPath UpdateAPIKey

Methods

toPath :: UpdateAPIKey -> ByteString

ToHeaders UpdateAPIKey

Methods

toHeaders :: UpdateAPIKey -> [Header]

ToQuery UpdateAPIKey

Methods

toQuery :: UpdateAPIKey -> QueryString

type Rep UpdateAPIKey

type Rep UpdateAPIKey = D1 (MetaData "UpdateAPIKey" "Network.AWS.APIGateway.UpdateAPIKey" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "UpdateAPIKey'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_uakPatchOperations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PatchOperation]))) (S1 (MetaSel (Just Symbol "_uakApiKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs UpdateAPIKey

type Rs UpdateAPIKey = APIKey

Request Lenses

uakPatchOperations :: Lens' UpdateAPIKey [PatchOperation]

A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.

uakApiKey :: Lens' UpdateAPIKey Text

The identifier of the ApiKey resource to be updated.

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
• akCreatedDate
• akName
• akId
• akStageKeys
• akLastUpdatedDate
• akDescription

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.

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

FromJSON APIKey

Methods

parseJSON :: Value -> Parser APIKey

Hashable APIKey

Methods

hashWithSalt :: Int -> APIKey -> Int

hash :: APIKey -> Int

NFData APIKey

Methods

rnf :: APIKey -> ()

type Rep APIKey

type Rep APIKey = D1 (MetaData "APIKey" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" 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 ISO8601))) (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 ISO8601))) (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.

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.