Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.APIGateway.UpdateApiKey

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Changes information about an ApiKey resource.

Synopsis

data UpdateApiKey = UpdateApiKey' {
- patchOperations :: Maybe [PatchOperation]
- apiKey :: Text
}
newUpdateApiKey :: Text -> UpdateApiKey
updateApiKey_patchOperations :: Lens' UpdateApiKey (Maybe [PatchOperation])
updateApiKey_apiKey :: Lens' UpdateApiKey Text
data ApiKey = ApiKey' {
- enabled :: Maybe Bool
- value :: Maybe Text
- customerId :: Maybe Text
- createdDate :: Maybe POSIX
- name :: Maybe Text
- id :: Maybe Text
- stageKeys :: Maybe [Text]
- lastUpdatedDate :: Maybe POSIX
- description :: Maybe Text
- tags :: Maybe (HashMap Text Text)
}
newApiKey :: ApiKey
apiKey_enabled :: Lens' ApiKey (Maybe Bool)
apiKey_value :: Lens' ApiKey (Maybe Text)
apiKey_customerId :: Lens' ApiKey (Maybe Text)
apiKey_createdDate :: Lens' ApiKey (Maybe UTCTime)
apiKey_name :: Lens' ApiKey (Maybe Text)
apiKey_id :: Lens' ApiKey (Maybe Text)
apiKey_stageKeys :: Lens' ApiKey (Maybe [Text])
apiKey_lastUpdatedDate :: Lens' ApiKey (Maybe UTCTime)
apiKey_description :: Lens' ApiKey (Maybe Text)
apiKey_tags :: Lens' ApiKey (Maybe (HashMap Text Text))

Creating a Request

data UpdateApiKey Source #

A request to change information about an ApiKey resource.

See: newUpdateApiKey smart constructor.

Constructors

UpdateApiKey'
Fields patchOperations :: Maybe [PatchOperation] A list of update operations to be applied to the specified resource and in the order specified in this list. apiKey :: Text Required The identifier of the ApiKey resource to be updated.

Instances

Instances details

Eq UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey Methods (==) :: UpdateApiKey -> UpdateApiKey -> Bool # (/=) :: UpdateApiKey -> UpdateApiKey -> Bool #
Read UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey Methods readsPrec :: Int -> ReadS UpdateApiKey # readList :: ReadS [UpdateApiKey] # readPrec :: ReadPrec UpdateApiKey # readListPrec :: ReadPrec [UpdateApiKey] #
Show UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey Methods showsPrec :: Int -> UpdateApiKey -> ShowS # show :: UpdateApiKey -> String # showList :: [UpdateApiKey] -> ShowS #
Generic UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey Associated Types type Rep UpdateApiKey :: Type -> Type # Methods from :: UpdateApiKey -> Rep UpdateApiKey x # to :: Rep UpdateApiKey x -> UpdateApiKey #
NFData UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey Methods rnf :: UpdateApiKey -> () #
Hashable UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey Methods hashWithSalt :: Int -> UpdateApiKey -> Int # hash :: UpdateApiKey -> Int #
ToJSON UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey Methods toJSON :: UpdateApiKey -> Value # toEncoding :: UpdateApiKey -> Encoding # toJSONList :: [UpdateApiKey] -> Value # toEncodingList :: [UpdateApiKey] -> Encoding #
AWSRequest UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey Associated Types type AWSResponse UpdateApiKey # Methods request :: UpdateApiKey -> Request UpdateApiKey # response :: MonadResource m => Logger -> Service -> Proxy UpdateApiKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateApiKey))) #
ToHeaders UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey Methods toHeaders :: UpdateApiKey -> [Header] #
ToPath UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey Methods toPath :: UpdateApiKey -> ByteString #
ToQuery UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey Methods toQuery :: UpdateApiKey -> QueryString #
type Rep UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey type Rep UpdateApiKey = D1 ('MetaData "UpdateApiKey" "Amazonka.APIGateway.UpdateApiKey" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "UpdateApiKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :*: S1 ('MetaSel ('Just "apiKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey type AWSResponse UpdateApiKey = ApiKey

newUpdateApiKey Source #

Arguments

:: Text	`$sel:apiKey:UpdateApiKey'`
-> UpdateApiKey

Create a value of UpdateApiKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateApiKey', updateApiKey_patchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.

$sel:apiKey:UpdateApiKey', updateApiKey_apiKey - [Required] The identifier of the ApiKey resource to be updated.

Request Lenses

updateApiKey_patchOperations :: Lens' UpdateApiKey (Maybe [PatchOperation]) Source #

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

updateApiKey_apiKey :: Lens' UpdateApiKey Text Source #

Required: The identifier of the ApiKey resource to be updated.

Destructuring the Response

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: newApiKey smart constructor.

Constructors

ApiKey'

Fields

enabled :: Maybe Bool
Specifies whether the API Key can be used by callers.
value :: Maybe Text
The value of the API Key.
customerId :: Maybe Text
An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
createdDate :: Maybe POSIX
The timestamp when the API Key was created.
name :: Maybe Text
The name of the API Key.
id :: Maybe Text
The identifier of the API Key.
stageKeys :: Maybe [Text]
A list of Stage resources that are associated with the ApiKey resource.
lastUpdatedDate :: Maybe POSIX
The timestamp when the API Key was last updated.
description :: Maybe Text
The description of the API Key.
tags :: Maybe (HashMap Text Text)
The collection of tags. Each tag element is associated with a given resource.

Instances

Instances details

Eq ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods (==) :: ApiKey -> ApiKey -> Bool # (/=) :: ApiKey -> ApiKey -> Bool #
Read ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods readsPrec :: Int -> ReadS ApiKey # readList :: ReadS [ApiKey] # readPrec :: ReadPrec ApiKey # readListPrec :: ReadPrec [ApiKey] #
Show ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods showsPrec :: Int -> ApiKey -> ShowS # show :: ApiKey -> String # showList :: [ApiKey] -> ShowS #
Generic ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Associated Types type Rep ApiKey :: Type -> Type # Methods from :: ApiKey -> Rep ApiKey x # to :: Rep ApiKey x -> ApiKey #
NFData ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods rnf :: ApiKey -> () #
Hashable ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods hashWithSalt :: Int -> ApiKey -> Int # hash :: ApiKey -> Int #
FromJSON ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods parseJSON :: Value -> Parser ApiKey # parseJSONList :: Value -> Parser [ApiKey] #
type Rep ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey type Rep ApiKey = D1 ('MetaData "ApiKey" "Amazonka.APIGateway.Types.ApiKey" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "ApiKey'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "customerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stageKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))))))

newApiKey :: ApiKey Source #

Create a value of ApiKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:enabled:ApiKey', apiKey_enabled - Specifies whether the API Key can be used by callers.

$sel:value:ApiKey', apiKey_value - The value of the API Key.

$sel:customerId:ApiKey', apiKey_customerId - An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

$sel:createdDate:ApiKey', apiKey_createdDate - The timestamp when the API Key was created.

$sel:name:ApiKey', apiKey_name - The name of the API Key.

$sel:id:ApiKey', apiKey_id - The identifier of the API Key.

$sel:stageKeys:ApiKey', apiKey_stageKeys - A list of Stage resources that are associated with the ApiKey resource.

$sel:lastUpdatedDate:ApiKey', apiKey_lastUpdatedDate - The timestamp when the API Key was last updated.

$sel:description:ApiKey', apiKey_description - The description of the API Key.

$sel:tags:ApiKey', apiKey_tags - The collection of tags. Each tag element is associated with a given resource.

Response Lenses

apiKey_enabled :: Lens' ApiKey (Maybe Bool) Source #

Specifies whether the API Key can be used by callers.

apiKey_value :: Lens' ApiKey (Maybe Text) Source #

The value of the API Key.

apiKey_customerId :: Lens' ApiKey (Maybe Text) Source #

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

apiKey_createdDate :: Lens' ApiKey (Maybe UTCTime) Source #

The timestamp when the API Key was created.

apiKey_name :: Lens' ApiKey (Maybe Text) Source #

The name of the API Key.

apiKey_id :: Lens' ApiKey (Maybe Text) Source #

The identifier of the API Key.

apiKey_stageKeys :: Lens' ApiKey (Maybe [Text]) Source #

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

apiKey_lastUpdatedDate :: Lens' ApiKey (Maybe UTCTime) Source #

The timestamp when the API Key was last updated.

apiKey_description :: Lens' ApiKey (Maybe Text) Source #

The description of the API Key.

apiKey_tags :: Lens' ApiKey (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.