@aws-sdk/client-workdocs

Description

AWS SDK for JavaScript WorkDocs Client for Node.js, Browser and React Native.

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.

Installing

To install this package, simply type add or install @aws-sdk/client-workdocs
using your favorite package manager:
- npm install @aws-sdk/client-workdocs
- yarn add @aws-sdk/client-workdocs
- pnpm add @aws-sdk/client-workdocs

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the WorkDocsClient and
the commands you need, for example DescribeUsersCommand:

``js
// ES5 example
const { WorkDocsClient, DescribeUsersCommand } = require("@aws-sdk/client-workdocs");
`

`ts
// ES6+ example
import { WorkDocsClient, DescribeUsersCommand } from "@aws-sdk/client-workdocs";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new WorkDocsClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new DescribeUsersCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-workdocs";
const client = new AWS.WorkDocs({ region: "REGION" });

// async/await.
try {
const data = await client.describeUsers(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.describeUsers(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.describeUsers(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-workdocs` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

AbortDocumentVersionUpload

Command API Reference / Input / Output

ActivateUser

Command API Reference / Input / Output

AddResourcePermissions

Command API Reference / Input / Output

CreateComment

Command API Reference / Input / Output

CreateCustomMetadata

Command API Reference / Input / Output

CreateFolder

Command API Reference / Input / Output

CreateLabels

Command API Reference / Input / Output

CreateNotificationSubscription

Command API Reference / Input / Output

CreateUser

Command API Reference / Input / Output

DeactivateUser

Command API Reference / Input / Output

DeleteComment

Command API Reference / Input / Output

DeleteCustomMetadata

Command API Reference / Input / Output

DeleteDocument

Command API Reference / Input / Output

DeleteDocumentVersion

Command API Reference / Input / Output

DeleteFolder

Command API Reference / Input / Output

DeleteFolderContents

Command API Reference / Input / Output

DeleteLabels

Command API Reference / Input / Output

DeleteNotificationSubscription

Command API Reference / Input / Output

DeleteUser

Command API Reference / Input / Output

DescribeActivities

Command API Reference / Input / Output

DescribeComments

Command API Reference / Input / Output

DescribeDocumentVersions

Command API Reference / Input / Output

DescribeFolderContents

Command API Reference / Input / Output

DescribeGroups

Command API Reference / Input / Output

DescribeNotificationSubscriptions

Command API Reference / Input / Output

DescribeResourcePermissions

Command API Reference / Input / Output

DescribeRootFolders

Command API Reference / Input / Output

DescribeUsers

Command API Reference / Input / Output

GetCurrentUser

Command API Reference / Input / Output

GetDocument

Command API Reference / Input / Output

GetDocumentPath

Command API Reference / Input / Output

GetDocumentVersion

Command API Reference / Input / Output

GetFolder

Command API Reference / Input / Output

GetFolderPath

Command API Reference / Input / Output

GetResources

Command API Reference / Input / Output

InitiateDocumentVersionUpload

Command API Reference / Input / Output

RemoveAllResourcePermissions

Command API Reference / Input / Output

RemoveResourcePermission

Command API Reference / Input / Output

RestoreDocumentVersions

Command API Reference / Input / Output

SearchResources

Command API Reference / Input / Output

UpdateDocument

Command API Reference / Input / Output

UpdateDocumentVersion

Command API Reference / Input / Output

UpdateFolder

Command API Reference / Input / Output

UpdateUser

Command API Reference / Input / Output