Deletes the AWS Systems Manager document (SSM document) and all managed node associations to the document.
Before you delete the document, we recommend that you use DeleteAssociation to disassociate all managed nodes that are associated with the document.
Request Syntax
{
"DocumentVersion": "string",
"Force": boolean,
"Name": "string",
"VersionName": "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.
- DocumentVersion
-
The version of the document that you want to delete. If not provided, all versions of the document are deleted.
Type: String
Pattern:
([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)Required: No
- Force
-
Some SSM document types require that you specify a
Forceflag before you can delete the document. For example, you must specify aForceflag to delete a document of typeApplicationConfigurationSchema. You can restrict access to theForceflag in an AWS Identity and Access Management (IAM) policy.Type: Boolean
Required: No
- Name
-
The name of the document.
Type: String
Pattern:
^[a-zA-Z0-9_\-.]{3,128}$Required: Yes
- VersionName
-
The version name of the document that you want to delete. If not provided, all versions of the document are deleted.
Type: String
Pattern:
^[a-zA-Z0-9_\-.]{1,128}$Required: No
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.
- AssociatedInstances
-
You must disassociate a document from all managed nodes before you can delete it.
HTTP Status Code: 400
- InternalServerError
-
An error occurred on the server side.
HTTP Status Code: 500
- InvalidDocument
-
The specified SSM document doesn't exist.
HTTP Status Code: 400
- InvalidDocumentOperation
-
You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.
HTTP Status Code: 400
- TooManyUpdates
-
There are concurrent updates for a resource that supports one update at a time.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of DeleteDocument.
Sample Request
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DeleteDocument
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T151532Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 19
{
"Name": "Example"
}Sample Response
{}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
