DeleteDBParameterGroupCommand

Suggest an Edit

Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.

Example Syntax

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

import { NeptuneClient, DeleteDBParameterGroupCommand } from "@aws-sdk/client-neptune"; // ES Modules import
// const { NeptuneClient, DeleteDBParameterGroupCommand } = require("@aws-sdk/client-neptune"); // CommonJS import
const client = new NeptuneClient(config);
const input = { // DeleteDBParameterGroupMessage
  DBParameterGroupName: "STRING_VALUE", // required
};
const command = new DeleteDBParameterGroupCommand(input);
const response = await client.send(command);
// {};

DeleteDBParameterGroupCommand Input

See DeleteDBParameterGroupCommandInput for more details

Parameter
Type
Description
DBParameterGroupName
Required
string | undefined

The name of the DB parameter group.

Constraints:

  • Must be the name of an existing DB parameter group

  • You can't delete a default DB parameter group

  • Cannot be associated with any DB instances

DeleteDBParameterGroupCommand Output

See DeleteDBParameterGroupCommandOutput for details

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

Throws

Name
Fault
Details
DBParameterGroupNotFoundFault
client

DBParameterGroupName does not refer to an existing DB parameter group.

InvalidDBParameterGroupStateFault
client

The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.

NeptuneServiceException
Base exception class for all service exceptions from Neptune service.