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 a user from WorkMail and all subsequent systems. Before you can delete a user, the user state must be DISABLED. Use the DescribeUser action to confirm the user state.

Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.

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 BeginDeleteUser and EndDeleteUser.

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

Syntax

C#
public virtual Task<DeleteUserResponse> DeleteUserAsync(
         DeleteUserRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.WorkMail.Model.DeleteUserRequest

Container for the necessary parameters to execute the DeleteUser service method.

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 DeleteUser service method, as returned by WorkMail.

Exceptions

ExceptionCondition
DirectoryServiceAuthenticationFailedException The directory service doesn't recognize the credentials supplied by WorkMail.
DirectoryUnavailableException The directory is unavailable. It might be located in another Region or deleted.
EntityStateException You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
InvalidParameterException One or more of the input parameters don't match the service's restrictions.
OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
OrganizationStateException The organization must have a valid state to perform certain operations on the organization or its members.
UnsupportedOperationException You can't perform a write operation against a read-only directory.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also