DeleteParameter - AWS Systems Manager

DeleteParameter

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

Request Syntax

{ "Name": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Name

The name of the parameter to delete.

Note

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

ParameterNotFound

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

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DeleteParameter.

Sample Request

POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 28 X-Amz-Target: AmazonSSM.DeleteParameter X-Amz-Date: 20240316T010702Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240316/us-east-2/ssm/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "Name": "EC2DevServerType" }

Sample Response

{}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: