AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the DeleteDocument operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementRequest
      Amazon.SimpleSystemsManagement.Model.DeleteDocumentRequest

Namespace: Amazon.SimpleSystemsManagement.Model
Assembly: AWSSDK.SimpleSystemsManagement.dll
Version: 3.x.y.z

Syntax

C# 
public class DeleteDocumentRequest : AmazonSimpleSystemsManagementRequest
         IAmazonWebServiceRequest

The DeleteDocumentRequest type exposes the following members

Constructors

NameDescription
Public Method DeleteDocumentRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method DeleteDocumentRequest(string)

Instantiates DeleteDocumentRequest with the parameterized properties

Properties

NameTypeDescription
Public Property DocumentVersion System.String

Gets and sets the property DocumentVersion.

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

Public Property Force System.Boolean

Gets and sets the property 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.

Public Property Name System.String

Gets and sets the property Name.

The name of the document.

Public Property VersionName System.String

Gets and sets the property VersionName.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5