Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DeleteParameters

Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.

Request Syntax


{
   "Names": [ "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.

Names

The names of the parameters to delete. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.

Note

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

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

Required: Yes

Response Syntax


{
   "DeletedParameters": [ "string" ],
   "InvalidParameters": [ "string" ]
}

Response Elements

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

The following data is returned in JSON format by the service.

DeletedParameters

The names of the deleted parameters.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

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

InvalidParameters

The names of parameters that weren't deleted because the parameters aren't valid.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

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

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

Examples

Example

This example illustrates one usage of DeleteParameters.

Sample Request


POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 53
X-Amz-Target: AmazonSSM.DeleteParameters
X-Amz-Date: 20240316T010844Z
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

{
    "Names": [
        "EC2TestServerType",
        "EC2ProdServerType"
    ]
}

Sample Response


{
    "DeletedParameters": [
        "EC2ProdServerType",
        "EC2TestServerType"
    ],
    "InvalidParameters": []
}