DeleteKeyGroupCommand

Suggest an Edit

Deletes a key group.

You cannot delete a key group that is referenced in a cache behavior. First update your distributions to remove the key group from all cache behaviors, then delete the key group.

To delete a key group, you must provide the key group's identifier and version. To get these values, use ListKeyGroups followed by GetKeyGroup or GetKeyGroupConfig.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { CloudFrontClient, DeleteKeyGroupCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import
// const { CloudFrontClient, DeleteKeyGroupCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import
const client = new CloudFrontClient(config);
const input = { // DeleteKeyGroupRequest
  Id: "STRING_VALUE", // required
  IfMatch: "STRING_VALUE",
};
const command = new DeleteKeyGroupCommand(input);
const response = await client.send(command);
// {};

DeleteKeyGroupCommand Input

See DeleteKeyGroupCommandInput for more details

Parameter
Type
Description
Id
Required
string | undefined

The identifier of the key group that you are deleting. To get the identifier, use ListKeyGroups.

IfMatch
string | undefined

The version of the key group that you are deleting. The version is the key group's ETag value. To get the ETag, use GetKeyGroup or GetKeyGroupConfig.

DeleteKeyGroupCommand Output

See DeleteKeyGroupCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
InvalidIfMatchVersion
client

The If-Match version is missing or not valid.

NoSuchResource
client

A resource that was specified is not valid.

PreconditionFailed
client

The precondition in one or more of the request fields evaluated to false.

ResourceInUse
client

Cannot delete this resource because it is in use.

CloudFrontServiceException
Base exception class for all service exceptions from CloudFront service.