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.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDeleteDocument and EndDeleteDocument.

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

Syntax

C#
public virtual Task<DeleteDocumentResponse> DeleteDocumentAsync(
         String name,
         CancellationToken cancellationToken
)

Parameters

name
Type: System.String

The name of the document.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the DeleteDocument service method, as returned by SimpleSystemsManagement.

Exceptions

ExceptionCondition
AssociatedInstancesException You must disassociate a document from all managed nodes before you can delete it.
InternalServerErrorException An error occurred on the server side.
InvalidDocumentException The specified SSM document doesn't exist.
InvalidDocumentOperationException You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also