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.DeleteUsagePlanKey
Description
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
Synopsis
- data DeleteUsagePlanKey = DeleteUsagePlanKey' {
- usagePlanId :: Text
- keyId :: Text
- newDeleteUsagePlanKey :: Text -> Text -> DeleteUsagePlanKey
- deleteUsagePlanKey_usagePlanId :: Lens' DeleteUsagePlanKey Text
- deleteUsagePlanKey_keyId :: Lens' DeleteUsagePlanKey Text
- data DeleteUsagePlanKeyResponse = DeleteUsagePlanKeyResponse' {
- newDeleteUsagePlanKeyResponse :: DeleteUsagePlanKeyResponse
Creating a Request
data DeleteUsagePlanKey Source #
The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.
See: newDeleteUsagePlanKey
smart constructor.
Constructors
DeleteUsagePlanKey' | |
Fields
|
Instances
newDeleteUsagePlanKey Source #
Arguments
:: Text | |
-> Text | |
-> DeleteUsagePlanKey |
Create a value of DeleteUsagePlanKey
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:usagePlanId:DeleteUsagePlanKey'
, deleteUsagePlanKey_usagePlanId
- [Required] The Id of the UsagePlan resource representing the usage plan
containing the to-be-deleted UsagePlanKey resource representing a plan
customer.
$sel:keyId:DeleteUsagePlanKey'
, deleteUsagePlanKey_keyId
- [Required] The Id of the UsagePlanKey resource to be deleted.
Request Lenses
deleteUsagePlanKey_usagePlanId :: Lens' DeleteUsagePlanKey Text Source #
- Required
- The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.
deleteUsagePlanKey_keyId :: Lens' DeleteUsagePlanKey Text Source #
- Required
- The Id of the UsagePlanKey resource to be deleted.
Destructuring the Response
data DeleteUsagePlanKeyResponse Source #
See: newDeleteUsagePlanKeyResponse
smart constructor.
Constructors
DeleteUsagePlanKeyResponse' | |
Instances
newDeleteUsagePlanKeyResponse :: DeleteUsagePlanKeyResponse Source #
Create a value of DeleteUsagePlanKeyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.