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 an object and its associated attributes. Only objects with no children and no parents can be deleted. The maximum number of attributes that can be deleted during an object deletion is 30. For more information, see Amazon Cloud Directory Limits.

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 BeginDeleteObject and EndDeleteObject.

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

Syntax

C#
public abstract Task<DeleteObjectResponse> DeleteObjectAsync(
         DeleteObjectRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CloudDirectory.Model.DeleteObjectRequest

Container for the necessary parameters to execute the DeleteObject 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 DeleteObject service method, as returned by CloudDirectory.

Exceptions

ExceptionCondition
AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
DirectoryNotEnabledException Operations are only permitted on enabled directories.
InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
InvalidArnException Indicates that the provided ARN value is not valid.
LimitExceededException Indicates that limits are exceeded. See Limits for more information.
ObjectNotDetachedException Indicates that the requested operation cannot be completed because the object has not been detached from the tree.
ResourceNotFoundException The specified resource could not be found.
RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
ValidationException Indicates that your request is malformed in some manner. See the exception message.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also