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
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' {}
- 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
|
Instances
Arguments
:: Text | |
-> 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
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: newApiKey
smart constructor.
Constructors
ApiKey' | |
Fields
|
Instances
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_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_stageKeys :: Lens' ApiKey (Maybe [Text]) Source #
A list of Stage resources that are associated with the ApiKey resource.