ssm_delete_document: Deletes the Systems Manager document and all instance...

Description Usage Arguments Value Request syntax

View source: R/ssm_operations.R

Description

Deletes the Systems Manager document and all instance associations to the document.

Before you delete the document, we recommend that you use delete_association to disassociate all instances that are associated with the document.

Usage

1
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 AWS Identity and Access Management (IAM) policy.

Value

An empty list.

Request syntax

1
2
3
4
5
6
svc$delete_document(
  Name = "string",
  DocumentVersion = "string",
  VersionName = "string",
  Force = TRUE|FALSE
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.