/ - Amazon Simple Systems Manager (SSM)

Deletes the Amazon Web Services 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.

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "Name": "string", "DocumentVersion": "string", "VersionName": "string", "Force": true }'

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

Name

string

required

The name of the document.

Match pattern:

^[a-zA-Z0-9_\-.]{3,128}$

DocumentVersion

string

optional

The version of the document that you want to delete. If not provided, all versions of the document are deleted.

Match pattern:

([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)

VersionName

string

optional

The version name of the document that you want to delete. If not provided, all versions of the document are deleted.

Match pattern:

^[a-zA-Z0-9_\-.]{1,128}$

Force

boolean

optional

Some SSM document types require that you specify a Force flag before you can delete the document. For example, you must specify a Force flag to delete a document of type ApplicationConfigurationSchema. You can restrict access to the Force flag in an Identity and Access Management (IAM) policy.

Examples

/

Request

Responses