WorkDocsClient

Suggest an Edit

The Amazon WorkDocs API is designed for the following use cases:

  • File Migration: File migration applications are supported for users who want to migrate their files from an on-premises or off-premises file system or service. Users can insert files into a user directory structure, as well as allow for basic metadata changes, such as modifications to the permissions of files.

  • Security: Support security applications are supported for users who have additional security needs, such as antivirus or data loss prevention. The API actions, along with CloudTrail, allow these applications to detect when changes occur in Amazon WorkDocs. Then, the application can take the necessary actions and replace the target file. If the target file violates the policy, the application can also choose to email the user.

  • eDiscovery/Analytics: General administrative applications are supported, such as eDiscovery and analytics. These applications can choose to mimic or record the actions in an Amazon WorkDocs site, along with CloudTrail, to replicate data for eDiscovery, backup, or analytical applications.

All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed. They not only require the use of the Amazon Web Services 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.

The pricing for Amazon WorkDocs APIs varies depending on the API call type for these actions:

  • READ (Get*)

  • WRITE (Activate*, Add*, Create*, Deactivate*, Initiate*, Update*)

  • LIST (Describe*)

  • DELETE*, CANCEL

For information about Amazon WorkDocs API pricing, see Amazon WorkDocs Pricing .

Installation

NPM
npm install @aws-sdk/client-workdocs
Yarn
yarn add @aws-sdk/client-workdocs
pnpm
pnpm add @aws-sdk/client-workdocs

WorkDocsClient Operations

Command
Summary
AbortDocumentVersionUploadCommand

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.

ActivateUserCommand

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

AddResourcePermissionsCommand

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

CreateCommentCommand

Adds a new comment to the specified document version.

CreateCustomMetadataCommand

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

CreateFolderCommand

Creates a folder with the specified name and parent folder.

CreateLabelsCommand

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

CreateNotificationSubscriptionCommand

Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription.

For more information, see Setting up notifications for an IAM user or role  in the Amazon WorkDocs Developer Guide.

CreateUserCommand

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.

DeactivateUserCommand

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

DeleteCommentCommand

Deletes the specified comment from the document version.

DeleteCustomMetadataCommand

Deletes custom metadata from the specified resource.

DeleteDocumentCommand

Permanently deletes the specified document and its associated metadata.

DeleteDocumentVersionCommand

Deletes a specific version of a document.

DeleteFolderCommand

Permanently deletes the specified folder and its contents.

DeleteFolderContentsCommand

Deletes the contents of the specified folder.

DeleteLabelsCommand

Deletes the specified list of labels from a resource.

DeleteNotificationSubscriptionCommand

Deletes the specified subscription from the specified organization.

DeleteUserCommand

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

Deleting a user immediately and permanently deletes all content in that user's folder structure. Site retention policies do NOT apply to this type of deletion.

DescribeActivitiesCommand

Describes the user activities in a specified time period.

DescribeCommentsCommand

List all the comments for the specified document version.

DescribeDocumentVersionsCommand

Retrieves the document versions for the specified document.

By default, only active versions are returned.

DescribeFolderContentsCommand

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.

DescribeGroupsCommand

Describes the groups specified by the query. Groups are defined by the underlying Active Directory.

DescribeNotificationSubscriptionsCommand

Lists the specified notification subscriptions.

DescribeResourcePermissionsCommand

Describes the permissions of a specified resource.

DescribeRootFoldersCommand

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.

This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications  in the Amazon WorkDocs Developer Guide.

DescribeUsersCommand

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.

GetCurrentUserCommand

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

This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications  in the Amazon WorkDocs Developer Guide.

GetDocumentCommand

Retrieves details of a document.

GetDocumentPathCommand

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.

GetDocumentVersionCommand

Retrieves version metadata for the specified document.

GetFolderCommand

Retrieves the metadata of the specified folder.

GetFolderPathCommand

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.

GetResourcesCommand

Retrieves a collection of resources, including folders and documents. The only CollectionType supported is SHARED_WITH_ME.

InitiateDocumentVersionUploadCommand

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.

RemoveAllResourcePermissionsCommand

Removes all the permissions from the specified resource.

RemoveResourcePermissionCommand

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

RestoreDocumentVersionsCommand

Recovers a deleted version of an Amazon WorkDocs document.

SearchResourcesCommand

Searches metadata and the content of folders, documents, document versions, and comments.

UpdateDocumentCommand

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

UpdateDocumentVersionCommand

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.

UpdateFolderCommand

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

UpdateUserCommand

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

WorkDocsClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: WorkDocsClientConfig