Skip to content

Delete Document

ssm_delete_document R Documentation

Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document

Description

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 delete_association to disassociate all managed nodes that are associated with the document.

Usage

ssm_delete_document(Name, DocumentVersion, VersionName, Force)

Arguments

Name

[required] The name of the document.

DocumentVersion

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

VersionName

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

Force

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.

Value

An empty list.

Request syntax

svc$delete_document(
  Name = "string",
  DocumentVersion = "string",
  VersionName = "string",
  Force = TRUE|FALSE
)