delete_document

delete_document(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_document(
    Name='string',
    DocumentVersion='string',
    VersionName='string',
    Force=True|False
)

Parameters

• Name (string) --

  [REQUIRED]

  The name of the document.

• DocumentVersion (string) -- The version of the document that you want to delete. If not provided, all versions of the document are deleted.
• VersionName (string) -- The version name of the document that you want to delete. If not provided, all versions of the document are deleted.
• Force (boolean) -- 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.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

Exceptions

• SSM.Client.exceptions.InternalServerError
• SSM.Client.exceptions.InvalidDocument
• SSM.Client.exceptions.InvalidDocumentOperation
• SSM.Client.exceptions.AssociatedInstances