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 Systems Manager document and all instance associations to the document.

Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances 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 abstract 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 instances before you can delete it.
InternalServerErrorException An error occurred on the server side.
InvalidDocumentException The specified document does not 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 Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also