DeleteParameterCommand

Suggest an Edit

Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.

Example Syntax

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

import { SSMClient, DeleteParameterCommand } from "@aws-sdk/client-ssm"; // ES Modules import
// const { SSMClient, DeleteParameterCommand } = require("@aws-sdk/client-ssm"); // CommonJS import
const client = new SSMClient(config);
const input = { // DeleteParameterRequest
  Name: "STRING_VALUE", // required
};
const command = new DeleteParameterCommand(input);
const response = await client.send(command);
// {};

DeleteParameterCommand Input

See DeleteParameterCommandInput for more details

Parameter
Type
Description
Name
Required
string | undefined

The name of the parameter to delete.

You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.

DeleteParameterCommand Output

See DeleteParameterCommandOutput for details

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

Throws

Name
Fault
Details
InternalServerError
server

An error occurred on the server side.

ParameterNotFound
client

The parameter couldn't be found. Verify the name and try again.

For the DeleteParameter and GetParameter actions, if the specified parameter doesn't exist, the ParameterNotFound exception is not recorded in CloudTrail event logs.

SSMServiceException
Base exception class for all service exceptions from SSM service.