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.

Classes

NameDescription
Class AbortDocumentVersionUploadRequest

Container for the parameters to the AbortDocumentVersionUpload operation. 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.

Class AbortDocumentVersionUploadResponse

This is the response object from the AbortDocumentVersionUpload operation.

Class ActivateUserRequest

Container for the parameters to the ActivateUser operation. Activates the specified user. Only active users can access Amazon WorkDocs.

Class ActivateUserResponse

This is the response object from the ActivateUser operation.

Class Activity

Describes the activity information.

Class AddResourcePermissionsRequest

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

Class AddResourcePermissionsResponse

This is the response object from the AddResourcePermissions operation.

Class Comment

Describes a comment.

Class CommentMetadata

Describes the metadata of a comment.

Class ConcurrentModificationException

WorkDocs exception

Class CreateCommentRequest

Container for the parameters to the CreateComment operation. Adds a new comment to the specified document version.

Class CreateCommentResponse

This is the response object from the CreateComment operation.

Class CreateCustomMetadataRequest

Container for the parameters to the CreateCustomMetadata operation. Adds one or more custom properties to the specified resource (a folder, document, or version).

Class CreateCustomMetadataResponse

This is the response object from the CreateCustomMetadata operation.

Class CreateFolderRequest

Container for the parameters to the CreateFolder operation. Creates a folder with the specified name and parent folder.

Class CreateFolderResponse

This is the response object from the CreateFolder operation.

Class CreateLabelsRequest

Container for the parameters to the CreateLabels operation. Adds the specified list of labels to the given resource (a document or folder)

Class CreateLabelsResponse

This is the response object from the CreateLabels operation.

Class CreateNotificationSubscriptionRequest

Container for the parameters to the CreateNotificationSubscription operation. 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.

Class CreateNotificationSubscriptionResponse

This is the response object from the CreateNotificationSubscription operation.

Class CreateUserRequest

Container for the parameters to the CreateUser operation. 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.

Class CreateUserResponse

This is the response object from the CreateUser operation.

Class CustomMetadataLimitExceededException

WorkDocs exception

Class DeactivateUserRequest

Container for the parameters to the DeactivateUser operation. Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.

Class DeactivateUserResponse

This is the response object from the DeactivateUser operation.

Class DeactivatingLastSystemUserException

WorkDocs exception

Class DeleteCommentRequest

Container for the parameters to the DeleteComment operation. Deletes the specified comment from the document version.

Class DeleteCommentResponse

This is the response object from the DeleteComment operation.

Class DeleteCustomMetadataRequest

Container for the parameters to the DeleteCustomMetadata operation. Deletes custom metadata from the specified resource.

Class DeleteCustomMetadataResponse

This is the response object from the DeleteCustomMetadata operation.

Class DeleteDocumentRequest

Container for the parameters to the DeleteDocument operation. Permanently deletes the specified document and its associated metadata.

Class DeleteDocumentResponse

This is the response object from the DeleteDocument operation.

Class DeleteFolderContentsRequest

Container for the parameters to the DeleteFolderContents operation. Deletes the contents of the specified folder.

Class DeleteFolderContentsResponse

This is the response object from the DeleteFolderContents operation.

Class DeleteFolderRequest

Container for the parameters to the DeleteFolder operation. Permanently deletes the specified folder and its contents.

Class DeleteFolderResponse

This is the response object from the DeleteFolder operation.

Class DeleteLabelsRequest

Container for the parameters to the DeleteLabels operation. Deletes the specified list of labels from a resource.

Class DeleteLabelsResponse

This is the response object from the DeleteLabels operation.

Class DeleteNotificationSubscriptionRequest

Container for the parameters to the DeleteNotificationSubscription operation. Deletes the specified subscription from the specified organization.

Class DeleteNotificationSubscriptionResponse

This is the response object from the DeleteNotificationSubscription operation.

Class DeleteUserRequest

Container for the parameters to the DeleteUser operation. Deletes the specified user from a Simple AD or Microsoft AD directory.

Class DeleteUserResponse

This is the response object from the DeleteUser operation.

Class DescribeActivitiesRequest

Container for the parameters to the DescribeActivities operation. Describes the user activities in a specified time period.

Class DescribeActivitiesResponse

This is the response object from the DescribeActivities operation.

Class DescribeCommentsRequest

Container for the parameters to the DescribeComments operation. List all the comments for the specified document version.

Class DescribeCommentsResponse

This is the response object from the DescribeComments operation.

Class DescribeDocumentVersionsRequest

Container for the parameters to the DescribeDocumentVersions operation. Retrieves the document versions for the specified document.

By default, only active versions are returned.

Class DescribeDocumentVersionsResponse

This is the response object from the DescribeDocumentVersions operation.

Class DescribeFolderContentsRequest

Container for the parameters to the DescribeFolderContents operation. 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.

Class DescribeFolderContentsResponse

This is the response object from the DescribeFolderContents operation.

Class DescribeGroupsRequest

Container for the parameters to the DescribeGroups operation. Describes the groups specified by query.

Class DescribeGroupsResponse

This is the response object from the DescribeGroups operation.

Class DescribeNotificationSubscriptionsRequest

Container for the parameters to the DescribeNotificationSubscriptions operation. Lists the specified notification subscriptions.

Class DescribeNotificationSubscriptionsResponse

This is the response object from the DescribeNotificationSubscriptions operation.

Class DescribeResourcePermissionsRequest

Container for the parameters to the DescribeResourcePermissions operation. Describes the permissions of a specified resource.

Class DescribeResourcePermissionsResponse

This is the response object from the DescribeResourcePermissions operation.

Class DescribeRootFoldersRequest

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

Class DescribeRootFoldersResponse

This is the response object from the DescribeRootFolders operation.

Class DescribeUsersRequest

Container for the parameters to the DescribeUsers operation. 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.

Class DescribeUsersResponse

This is the response object from the DescribeUsers operation.

Class DocumentLockedForCommentsException

WorkDocs exception

Class DocumentMetadata

Describes the document.

Class DocumentVersionMetadata

Describes a version of a document.

Class DraftUploadOutOfSyncException

WorkDocs exception

Class EntityAlreadyExistsException

WorkDocs exception

Class EntityNotExistsException

WorkDocs exception

Class FailedDependencyException

WorkDocs exception

Class FolderMetadata

Describes a folder.

Class GetCurrentUserRequest

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

Class GetCurrentUserResponse

This is the response object from the GetCurrentUser operation.

Class GetDocumentPathRequest

Container for the parameters to the GetDocumentPath operation. 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.

Class GetDocumentPathResponse

This is the response object from the GetDocumentPath operation.

Class GetDocumentRequest

Container for the parameters to the GetDocument operation. Retrieves details of a document.

Class GetDocumentResponse

This is the response object from the GetDocument operation.

Class GetDocumentVersionRequest

Container for the parameters to the GetDocumentVersion operation. Retrieves version metadata for the specified document.

Class GetDocumentVersionResponse

This is the response object from the GetDocumentVersion operation.

Class GetFolderPathRequest

Container for the parameters to the GetFolderPath operation. 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.

Class GetFolderPathResponse

This is the response object from the GetFolderPath operation.

Class GetFolderRequest

Container for the parameters to the GetFolder operation. Retrieves the metadata of the specified folder.

Class GetFolderResponse

This is the response object from the GetFolder operation.

Class GroupMetadata

Describes the metadata of a user group.

Class IllegalUserStateException

WorkDocs exception

Class InitiateDocumentVersionUploadRequest

Container for the parameters to the InitiateDocumentVersionUpload operation. 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.

Class InitiateDocumentVersionUploadResponse

This is the response object from the InitiateDocumentVersionUpload operation.

Class InvalidArgumentException

WorkDocs exception

Class InvalidOperationException

WorkDocs exception

Class InvalidPasswordException

WorkDocs exception

Class LimitExceededException

WorkDocs exception

Class NotificationOptions

Set of options which defines notification preferences of given action.

Class Participants

Describes the users or user groups.

Class PermissionInfo

Describes the permissions.

Class Principal

Describes a resource.

Class ProhibitedStateException

WorkDocs exception

Class RemoveAllResourcePermissionsRequest

Container for the parameters to the RemoveAllResourcePermissions operation. Removes all the permissions from the specified resource.

Class RemoveAllResourcePermissionsResponse

This is the response object from the RemoveAllResourcePermissions operation.

Class RemoveResourcePermissionRequest

Container for the parameters to the RemoveResourcePermission operation. Removes the permission for the specified principal from the specified resource.

Class RemoveResourcePermissionResponse

This is the response object from the RemoveResourcePermission operation.

Class ResourceAlreadyCheckedOutException

WorkDocs exception

Class ResourceMetadata

Describes the metadata of a resource.

Class ResourcePath

Describes the path information of a resource.

Class ResourcePathComponent

Describes the resource path.

Class ServiceUnavailableException

WorkDocs exception

Class SharePrincipal

Describes the recipient type and ID, if available.

Class ShareResult

Describes the share results of a resource.

Class StorageLimitExceededException

WorkDocs exception

Class StorageLimitWillExceedException

WorkDocs exception

Class StorageRuleType

Describes the storage for a user.

Class Subscription

Describes a subscription.

Class TooManyLabelsException

WorkDocs exception

Class TooManySubscriptionsException

WorkDocs exception

Class UnauthorizedOperationException

WorkDocs exception

Class UnauthorizedResourceAccessException

WorkDocs exception

Class UpdateDocumentRequest

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

Class UpdateDocumentResponse

This is the response object from the UpdateDocument operation.

Class UpdateDocumentVersionRequest

Container for the parameters to the UpdateDocumentVersion operation. 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.

Class UpdateDocumentVersionResponse

This is the response object from the UpdateDocumentVersion operation.

Class UpdateFolderRequest

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

Class UpdateFolderResponse

This is the response object from the UpdateFolder operation.

Class UpdateUserRequest

Container for the parameters to the UpdateUser operation. Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.

Class UpdateUserResponse

This is the response object from the UpdateUser operation.

Class UploadMetadata

Describes the upload.

Class User

Describes a user.

Class UserMetadata

Describes the metadata of the user.

Class UserStorageMetadata

Describes the storage for a user.