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.

Implementation for accessing WorkDocs The WorkDocs API is designed for the following use cases:

All Amazon WorkDocs APIs are Amazon authenticated, certificate-signed APIs. They not only require the use of the AWS SDK, but also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkDocs site, the IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as set in the IAM policy). This includes, but is not limited to, the ability to modify file permissions and upload any file to any user. This allows developers to perform the three use cases above, as well as give users the ability to grant access on a selective basis using the IAM model.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.WorkDocs.AmazonWorkDocsClient

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

Syntax

C#
public class AmazonWorkDocsClient : AmazonServiceClient
         IAmazonService, IAmazonWorkDocs, IDisposable

The AmazonWorkDocsClient type exposes the following members

Constructors

NameDescription
Public Method AmazonWorkDocsClient()

Constructs AmazonWorkDocsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonWorkDocsClient(RegionEndpoint)

Constructs AmazonWorkDocsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonWorkDocsClient(AmazonWorkDocsConfig)

Constructs AmazonWorkDocsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonWorkDocsClient(AWSCredentials)

Constructs AmazonWorkDocsClient with AWS Credentials

Public Method AmazonWorkDocsClient(AWSCredentials, RegionEndpoint)

Constructs AmazonWorkDocsClient with AWS Credentials

Public Method AmazonWorkDocsClient(AWSCredentials, AmazonWorkDocsConfig)

Constructs AmazonWorkDocsClient with AWS Credentials and an AmazonWorkDocsClient Configuration object.

Public Method AmazonWorkDocsClient(string, string)

Constructs AmazonWorkDocsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonWorkDocsClient(string, string, RegionEndpoint)

Constructs AmazonWorkDocsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonWorkDocsClient(string, string, AmazonWorkDocsConfig)

Constructs AmazonWorkDocsClient with AWS Access Key ID, AWS Secret Key and an AmazonWorkDocsClient Configuration object.

Public Method AmazonWorkDocsClient(string, string, string)

Constructs AmazonWorkDocsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonWorkDocsClient(string, string, string, RegionEndpoint)

Constructs AmazonWorkDocsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonWorkDocsClient(string, string, string, AmazonWorkDocsConfig)

Constructs AmazonWorkDocsClient with AWS Access Key ID, AWS Secret Key and an AmazonWorkDocsClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AbortDocumentVersionUpload(AbortDocumentVersionUploadRequest)

Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload. The client should make this call only when it no longer intends to upload the document version, or fails to do so.

Public Method AbortDocumentVersionUploadAsync(AbortDocumentVersionUploadRequest, CancellationToken)

Initiates the asynchronous execution of the AbortDocumentVersionUpload operation.

Public Method ActivateUser(ActivateUserRequest)

Activates the specified user. Only active users can access Amazon WorkDocs.

Public Method ActivateUserAsync(ActivateUserRequest, CancellationToken)

Initiates the asynchronous execution of the ActivateUser operation.

Public Method AddResourcePermissions(AddResourcePermissionsRequest)

Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.

Public Method AddResourcePermissionsAsync(AddResourcePermissionsRequest, CancellationToken)

Initiates the asynchronous execution of the AddResourcePermissions operation.

Public Method CreateComment(CreateCommentRequest)

Adds a new comment to the specified document version.

Public Method CreateCommentAsync(CreateCommentRequest, CancellationToken)

Initiates the asynchronous execution of the CreateComment operation.

Public Method CreateCustomMetadata(CreateCustomMetadataRequest)

Adds one or more custom properties to the specified resource (a folder, document, or version).

Public Method CreateCustomMetadataAsync(CreateCustomMetadataRequest, CancellationToken)

Initiates the asynchronous execution of the CreateCustomMetadata operation.

Public Method CreateFolder(CreateFolderRequest)

Creates a folder with the specified name and parent folder.

Public Method CreateFolderAsync(CreateFolderRequest, CancellationToken)

Initiates the asynchronous execution of the CreateFolder operation.

Public Method CreateLabels(CreateLabelsRequest)

Adds the specified list of labels to the given resource (a document or folder)

Public Method CreateLabelsAsync(CreateLabelsRequest, CancellationToken)

Initiates the asynchronous execution of the CreateLabels operation.

Public Method CreateNotificationSubscription(CreateNotificationSubscriptionRequest)

Configure WorkDocs to use Amazon SNS notifications.

The endpoint receives a confirmation message, and must confirm the subscription. For more information, see Confirm the Subscription in the Amazon Simple Notification Service Developer Guide.

Public Method CreateNotificationSubscriptionAsync(CreateNotificationSubscriptionRequest, CancellationToken)

Initiates the asynchronous execution of the CreateNotificationSubscription operation.

Public Method CreateUser(CreateUserRequest)

Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is "ACTIVE". New users can access Amazon WorkDocs.

Public Method CreateUserAsync(CreateUserRequest, CancellationToken)

Initiates the asynchronous execution of the CreateUser operation.

Public Method DeactivateUser(DeactivateUserRequest)

Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.

Public Method DeactivateUserAsync(DeactivateUserRequest, CancellationToken)

Initiates the asynchronous execution of the DeactivateUser operation.

Public Method DeleteComment(DeleteCommentRequest)

Deletes the specified comment from the document version.

Public Method DeleteCommentAsync(DeleteCommentRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteComment operation.

Public Method DeleteCustomMetadata(DeleteCustomMetadataRequest)

Deletes custom metadata from the specified resource.

Public Method DeleteCustomMetadataAsync(DeleteCustomMetadataRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteCustomMetadata operation.

Public Method DeleteDocument(DeleteDocumentRequest)

Permanently deletes the specified document and its associated metadata.

Public Method DeleteDocumentAsync(DeleteDocumentRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteDocument operation.

Public Method DeleteFolder(DeleteFolderRequest)

Permanently deletes the specified folder and its contents.

Public Method DeleteFolderAsync(DeleteFolderRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteFolder operation.

Public Method DeleteFolderContents(DeleteFolderContentsRequest)

Deletes the contents of the specified folder.

Public Method DeleteFolderContentsAsync(DeleteFolderContentsRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteFolderContents operation.

Public Method DeleteLabels(DeleteLabelsRequest)

Deletes the specified list of labels from a resource.

Public Method DeleteLabelsAsync(DeleteLabelsRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteLabels operation.

Public Method DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest)

Deletes the specified subscription from the specified organization.

Public Method DeleteNotificationSubscriptionAsync(DeleteNotificationSubscriptionRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteNotificationSubscription operation.

Public Method DeleteUser(DeleteUserRequest)

Deletes the specified user from a Simple AD or Microsoft AD directory.

Public Method DeleteUserAsync(DeleteUserRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteUser operation.

Public Method DescribeActivities(DescribeActivitiesRequest)

Describes the user activities in a specified time period.

Public Method DescribeActivitiesAsync(DescribeActivitiesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeActivities operation.

Public Method DescribeComments(DescribeCommentsRequest)

List all the comments for the specified document version.

Public Method DescribeCommentsAsync(DescribeCommentsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeComments operation.

Public Method DescribeDocumentVersions(DescribeDocumentVersionsRequest)

Retrieves the document versions for the specified document.

By default, only active versions are returned.

Public Method DescribeDocumentVersionsAsync(DescribeDocumentVersionsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDocumentVersions operation.

Public Method DescribeFolderContents(DescribeFolderContentsRequest)

Describes the contents of the specified folder, including its documents and subfolders.

By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents.

Public Method DescribeFolderContentsAsync(DescribeFolderContentsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeFolderContents operation.

Public Method DescribeNotificationSubscriptions(DescribeNotificationSubscriptionsRequest)

Lists the specified notification subscriptions.

Public Method DescribeNotificationSubscriptionsAsync(DescribeNotificationSubscriptionsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeNotificationSubscriptions operation.

Public Method DescribeResourcePermissions(DescribeResourcePermissionsRequest)

Describes the permissions of a specified resource.

Public Method DescribeResourcePermissionsAsync(DescribeResourcePermissionsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeResourcePermissions operation.

Public Method DescribeRootFolders(DescribeRootFoldersRequest)

Describes the current user's special folders; the RootFolder and the RecyleBin. RootFolder is the root of user's files and folders and RecyleBin is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients.

Public Method DescribeRootFoldersAsync(DescribeRootFoldersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeRootFolders operation.

Public Method DescribeUsers(DescribeUsersRequest)

Describes the specified users. You can describe all users or filter the results (for example, by status or organization).

By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.

Public Method DescribeUsersAsync(DescribeUsersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeUsers operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetCurrentUser(GetCurrentUserRequest)

Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients.

Public Method GetCurrentUserAsync(GetCurrentUserRequest, CancellationToken)

Initiates the asynchronous execution of the GetCurrentUser operation.

Public Method GetDocument(GetDocumentRequest)

Retrieves details of a document.

Public Method GetDocumentAsync(GetDocumentRequest, CancellationToken)

Initiates the asynchronous execution of the GetDocument operation.

Public Method GetDocumentPath(GetDocumentPathRequest)

Retrieves the path information (the hierarchy from the root folder) for the requested document.

By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders.

Public Method GetDocumentPathAsync(GetDocumentPathRequest, CancellationToken)

Initiates the asynchronous execution of the GetDocumentPath operation.

Public Method GetDocumentVersion(GetDocumentVersionRequest)

Retrieves version metadata for the specified document.

Public Method GetDocumentVersionAsync(GetDocumentVersionRequest, CancellationToken)

Initiates the asynchronous execution of the GetDocumentVersion operation.

Public Method GetFolder(GetFolderRequest)

Retrieves the metadata of the specified folder.

Public Method GetFolderAsync(GetFolderRequest, CancellationToken)

Initiates the asynchronous execution of the GetFolder operation.

Public Method GetFolderPath(GetFolderPathRequest)

Retrieves the path information (the hierarchy from the root folder) for the specified folder.

By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names.

Public Method GetFolderPathAsync(GetFolderPathRequest, CancellationToken)

Initiates the asynchronous execution of the GetFolderPath operation.

Public Method InitiateDocumentVersionUpload(InitiateDocumentVersionUploadRequest)

Creates a new document object and version object.

The client specifies the parent folder ID and name of the document to upload. The ID is optionally specified when creating a new version of an existing document. This is the first step to upload a document. Next, upload the document to the URL returned from the call, and then call UpdateDocumentVersion.

To cancel the document upload, call AbortDocumentVersionUpload.

Public Method InitiateDocumentVersionUploadAsync(InitiateDocumentVersionUploadRequest, CancellationToken)

Initiates the asynchronous execution of the InitiateDocumentVersionUpload operation.

Public Method RemoveAllResourcePermissions(RemoveAllResourcePermissionsRequest)

Removes all the permissions from the specified resource.

Public Method RemoveAllResourcePermissionsAsync(RemoveAllResourcePermissionsRequest, CancellationToken)

Initiates the asynchronous execution of the RemoveAllResourcePermissions operation.

Public Method RemoveResourcePermission(RemoveResourcePermissionRequest)

Removes the permission for the specified principal from the specified resource.

Public Method RemoveResourcePermissionAsync(RemoveResourcePermissionRequest, CancellationToken)

Initiates the asynchronous execution of the RemoveResourcePermission operation.

Public Method UpdateDocument(UpdateDocumentRequest)

Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.

Public Method UpdateDocumentAsync(UpdateDocumentRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateDocument operation.

Public Method UpdateDocumentVersion(UpdateDocumentVersionRequest)

Changes the status of the document version to ACTIVE.

Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document upload, after the client uploads the document to an S3-presigned URL returned by InitiateDocumentVersionUpload.

Public Method UpdateDocumentVersionAsync(UpdateDocumentVersionRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateDocumentVersion operation.

Public Method UpdateFolder(UpdateFolderRequest)

Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.

Public Method UpdateFolderAsync(UpdateFolderRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateFolder operation.

Public Method UpdateUser(UpdateUserRequest)

Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.

Public Method UpdateUserAsync(UpdateUserRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateUser operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.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