@aws-sdk/client-workdocs 3.299.0 → 3.300.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/dist-types/commands/AbortDocumentVersionUploadCommand.d.ts +5 -0
  2. package/dist-types/commands/ActivateUserCommand.d.ts +4 -0
  3. package/dist-types/commands/AddResourcePermissionsCommand.d.ts +15 -0
  4. package/dist-types/commands/CreateCommentCommand.d.ts +10 -0
  5. package/dist-types/commands/CreateCustomMetadataCommand.d.ts +8 -0
  6. package/dist-types/commands/CreateFolderCommand.d.ts +5 -0
  7. package/dist-types/commands/CreateLabelsCommand.d.ts +7 -0
  8. package/dist-types/commands/CreateNotificationSubscriptionCommand.d.ts +6 -0
  9. package/dist-types/commands/CreateUserCommand.d.ts +14 -0
  10. package/dist-types/commands/DeactivateUserCommand.d.ts +4 -0
  11. package/dist-types/commands/DeleteCommentCommand.d.ts +6 -0
  12. package/dist-types/commands/DeleteCustomMetadataCommand.d.ts +9 -0
  13. package/dist-types/commands/DeleteDocumentCommand.d.ts +4 -0
  14. package/dist-types/commands/DeleteDocumentVersionCommand.d.ts +6 -0
  15. package/dist-types/commands/DeleteFolderCommand.d.ts +4 -0
  16. package/dist-types/commands/DeleteFolderContentsCommand.d.ts +4 -0
  17. package/dist-types/commands/DeleteLabelsCommand.d.ts +8 -0
  18. package/dist-types/commands/DeleteNotificationSubscriptionCommand.d.ts +4 -0
  19. package/dist-types/commands/DeleteUserCommand.d.ts +4 -0
  20. package/dist-types/commands/DescribeActivitiesCommand.d.ts +12 -0
  21. package/dist-types/commands/DescribeCommentsCommand.d.ts +7 -0
  22. package/dist-types/commands/DescribeDocumentVersionsCommand.d.ts +8 -0
  23. package/dist-types/commands/DescribeFolderContentsCommand.d.ts +10 -0
  24. package/dist-types/commands/DescribeGroupsCommand.d.ts +7 -0
  25. package/dist-types/commands/DescribeNotificationSubscriptionsCommand.d.ts +5 -0
  26. package/dist-types/commands/DescribeResourcePermissionsCommand.d.ts +7 -0
  27. package/dist-types/commands/DescribeRootFoldersCommand.d.ts +5 -0
  28. package/dist-types/commands/DescribeUsersCommand.d.ts +12 -0
  29. package/dist-types/commands/GetCurrentUserCommand.d.ts +3 -0
  30. package/dist-types/commands/GetDocumentCommand.d.ts +5 -0
  31. package/dist-types/commands/GetDocumentPathCommand.d.ts +7 -0
  32. package/dist-types/commands/GetDocumentVersionCommand.d.ts +7 -0
  33. package/dist-types/commands/GetFolderCommand.d.ts +5 -0
  34. package/dist-types/commands/GetFolderPathCommand.d.ts +7 -0
  35. package/dist-types/commands/GetResourcesCommand.d.ts +7 -0
  36. package/dist-types/commands/InitiateDocumentVersionUploadCommand.d.ts +10 -0
  37. package/dist-types/commands/RemoveAllResourcePermissionsCommand.d.ts +4 -0
  38. package/dist-types/commands/RemoveResourcePermissionCommand.d.ts +6 -0
  39. package/dist-types/commands/RestoreDocumentVersionsCommand.d.ts +4 -0
  40. package/dist-types/commands/SearchResourcesCommand.d.ts +59 -0
  41. package/dist-types/commands/UpdateDocumentCommand.d.ts +7 -0
  42. package/dist-types/commands/UpdateDocumentVersionCommand.d.ts +6 -0
  43. package/dist-types/commands/UpdateFolderCommand.d.ts +7 -0
  44. package/dist-types/commands/UpdateUserCommand.d.ts +14 -0
  45. package/package.json +8 -8
@@ -29,6 +29,11 @@ export interface AbortDocumentVersionUploadCommandOutput extends __MetadataBeare
29
29
  * import { WorkDocsClient, AbortDocumentVersionUploadCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
30
30
  * // const { WorkDocsClient, AbortDocumentVersionUploadCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
31
31
  * const client = new WorkDocsClient(config);
32
+ * const input = {
33
+ * AuthenticationToken: "STRING_VALUE",
34
+ * DocumentId: "STRING_VALUE", // required
35
+ * VersionId: "STRING_VALUE", // required
36
+ * };
32
37
  * const command = new AbortDocumentVersionUploadCommand(input);
33
38
  * const response = await client.send(command);
34
39
  * ```
@@ -27,6 +27,10 @@ export interface ActivateUserCommandOutput extends ActivateUserResponse, __Metad
27
27
  * import { WorkDocsClient, ActivateUserCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
28
28
  * // const { WorkDocsClient, ActivateUserCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
29
29
  * const client = new WorkDocsClient(config);
30
+ * const input = {
31
+ * UserId: "STRING_VALUE", // required
32
+ * AuthenticationToken: "STRING_VALUE",
33
+ * };
30
34
  * const command = new ActivateUserCommand(input);
31
35
  * const response = await client.send(command);
32
36
  * ```
@@ -28,6 +28,21 @@ export interface AddResourcePermissionsCommandOutput extends AddResourcePermissi
28
28
  * import { WorkDocsClient, AddResourcePermissionsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
29
29
  * // const { WorkDocsClient, AddResourcePermissionsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
30
30
  * const client = new WorkDocsClient(config);
31
+ * const input = {
32
+ * AuthenticationToken: "STRING_VALUE",
33
+ * ResourceId: "STRING_VALUE", // required
34
+ * Principals: [ // required
35
+ * {
36
+ * Id: "STRING_VALUE", // required
37
+ * Type: "USER" || "GROUP" || "INVITE" || "ANONYMOUS" || "ORGANIZATION", // required
38
+ * Role: "VIEWER" || "CONTRIBUTOR" || "OWNER" || "COOWNER", // required
39
+ * },
40
+ * ],
41
+ * NotificationOptions: {
42
+ * SendEmail: true || false,
43
+ * EmailMessage: "STRING_VALUE",
44
+ * },
45
+ * };
31
46
  * const command = new AddResourcePermissionsCommand(input);
32
47
  * const response = await client.send(command);
33
48
  * ```
@@ -26,6 +26,16 @@ export interface CreateCommentCommandOutput extends CreateCommentResponse, __Met
26
26
  * import { WorkDocsClient, CreateCommentCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
27
27
  * // const { WorkDocsClient, CreateCommentCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
28
28
  * const client = new WorkDocsClient(config);
29
+ * const input = {
30
+ * AuthenticationToken: "STRING_VALUE",
31
+ * DocumentId: "STRING_VALUE", // required
32
+ * VersionId: "STRING_VALUE", // required
33
+ * ParentId: "STRING_VALUE",
34
+ * ThreadId: "STRING_VALUE",
35
+ * Text: "STRING_VALUE", // required
36
+ * Visibility: "PUBLIC" || "PRIVATE",
37
+ * NotifyCollaborators: true || false,
38
+ * };
29
39
  * const command = new CreateCommentCommand(input);
30
40
  * const response = await client.send(command);
31
41
  * ```
@@ -27,6 +27,14 @@ export interface CreateCustomMetadataCommandOutput extends CreateCustomMetadataR
27
27
  * import { WorkDocsClient, CreateCustomMetadataCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
28
28
  * // const { WorkDocsClient, CreateCustomMetadataCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
29
29
  * const client = new WorkDocsClient(config);
30
+ * const input = {
31
+ * AuthenticationToken: "STRING_VALUE",
32
+ * ResourceId: "STRING_VALUE", // required
33
+ * VersionId: "STRING_VALUE",
34
+ * CustomMetadata: { // required
35
+ * "<keys>": "STRING_VALUE",
36
+ * },
37
+ * };
30
38
  * const command = new CreateCustomMetadataCommand(input);
31
39
  * const response = await client.send(command);
32
40
  * ```
@@ -26,6 +26,11 @@ export interface CreateFolderCommandOutput extends CreateFolderResponse, __Metad
26
26
  * import { WorkDocsClient, CreateFolderCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
27
27
  * // const { WorkDocsClient, CreateFolderCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
28
28
  * const client = new WorkDocsClient(config);
29
+ * const input = {
30
+ * AuthenticationToken: "STRING_VALUE",
31
+ * Name: "STRING_VALUE",
32
+ * ParentFolderId: "STRING_VALUE", // required
33
+ * };
29
34
  * const command = new CreateFolderCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -27,6 +27,13 @@ export interface CreateLabelsCommandOutput extends CreateLabelsResponse, __Metad
27
27
  * import { WorkDocsClient, CreateLabelsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
28
28
  * // const { WorkDocsClient, CreateLabelsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
29
29
  * const client = new WorkDocsClient(config);
30
+ * const input = {
31
+ * ResourceId: "STRING_VALUE", // required
32
+ * Labels: [ // required
33
+ * "STRING_VALUE",
34
+ * ],
35
+ * AuthenticationToken: "STRING_VALUE",
36
+ * };
30
37
  * const command = new CreateLabelsCommand(input);
31
38
  * const response = await client.send(command);
32
39
  * ```
@@ -29,6 +29,12 @@ export interface CreateNotificationSubscriptionCommandOutput extends CreateNotif
29
29
  * import { WorkDocsClient, CreateNotificationSubscriptionCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
30
30
  * // const { WorkDocsClient, CreateNotificationSubscriptionCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
31
31
  * const client = new WorkDocsClient(config);
32
+ * const input = {
33
+ * OrganizationId: "STRING_VALUE", // required
34
+ * Endpoint: "STRING_VALUE", // required
35
+ * Protocol: "HTTPS" || "SQS", // required
36
+ * SubscriptionType: "ALL", // required
37
+ * };
32
38
  * const command = new CreateNotificationSubscriptionCommand(input);
33
39
  * const response = await client.send(command);
34
40
  * ```
@@ -27,6 +27,20 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
27
27
  * import { WorkDocsClient, CreateUserCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
28
28
  * // const { WorkDocsClient, CreateUserCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
29
29
  * const client = new WorkDocsClient(config);
30
+ * const input = {
31
+ * OrganizationId: "STRING_VALUE",
32
+ * Username: "STRING_VALUE", // required
33
+ * EmailAddress: "STRING_VALUE",
34
+ * GivenName: "STRING_VALUE", // required
35
+ * Surname: "STRING_VALUE", // required
36
+ * Password: "STRING_VALUE", // required
37
+ * TimeZoneId: "STRING_VALUE",
38
+ * StorageRule: {
39
+ * StorageAllocatedInBytes: Number("long"),
40
+ * StorageType: "UNLIMITED" || "QUOTA",
41
+ * },
42
+ * AuthenticationToken: "STRING_VALUE",
43
+ * };
30
44
  * const command = new CreateUserCommand(input);
31
45
  * const response = await client.send(command);
32
46
  * ```
@@ -27,6 +27,10 @@ export interface DeactivateUserCommandOutput extends __MetadataBearer {
27
27
  * import { WorkDocsClient, DeactivateUserCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
28
28
  * // const { WorkDocsClient, DeactivateUserCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
29
29
  * const client = new WorkDocsClient(config);
30
+ * const input = {
31
+ * UserId: "STRING_VALUE", // required
32
+ * AuthenticationToken: "STRING_VALUE",
33
+ * };
30
34
  * const command = new DeactivateUserCommand(input);
31
35
  * const response = await client.send(command);
32
36
  * ```
@@ -26,6 +26,12 @@ export interface DeleteCommentCommandOutput extends __MetadataBearer {
26
26
  * import { WorkDocsClient, DeleteCommentCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
27
27
  * // const { WorkDocsClient, DeleteCommentCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
28
28
  * const client = new WorkDocsClient(config);
29
+ * const input = {
30
+ * AuthenticationToken: "STRING_VALUE",
31
+ * DocumentId: "STRING_VALUE", // required
32
+ * VersionId: "STRING_VALUE", // required
33
+ * CommentId: "STRING_VALUE", // required
34
+ * };
29
35
  * const command = new DeleteCommentCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,15 @@ export interface DeleteCustomMetadataCommandOutput extends DeleteCustomMetadataR
26
26
  * import { WorkDocsClient, DeleteCustomMetadataCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
27
27
  * // const { WorkDocsClient, DeleteCustomMetadataCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
28
28
  * const client = new WorkDocsClient(config);
29
+ * const input = {
30
+ * AuthenticationToken: "STRING_VALUE",
31
+ * ResourceId: "STRING_VALUE", // required
32
+ * VersionId: "STRING_VALUE",
33
+ * Keys: [
34
+ * "STRING_VALUE",
35
+ * ],
36
+ * DeleteAll: true || false,
37
+ * };
29
38
  * const command = new DeleteCustomMetadataCommand(input);
30
39
  * const response = await client.send(command);
31
40
  * ```
@@ -26,6 +26,10 @@ export interface DeleteDocumentCommandOutput extends __MetadataBearer {
26
26
  * import { WorkDocsClient, DeleteDocumentCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
27
27
  * // const { WorkDocsClient, DeleteDocumentCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
28
28
  * const client = new WorkDocsClient(config);
29
+ * const input = {
30
+ * AuthenticationToken: "STRING_VALUE",
31
+ * DocumentId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DeleteDocumentCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,12 @@ export interface DeleteDocumentVersionCommandOutput extends __MetadataBearer {
26
26
  * import { WorkDocsClient, DeleteDocumentVersionCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
27
27
  * // const { WorkDocsClient, DeleteDocumentVersionCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
28
28
  * const client = new WorkDocsClient(config);
29
+ * const input = {
30
+ * AuthenticationToken: "STRING_VALUE",
31
+ * DocumentId: "STRING_VALUE", // required
32
+ * VersionId: "STRING_VALUE", // required
33
+ * DeletePriorVersions: true || false, // required
34
+ * };
29
35
  * const command = new DeleteDocumentVersionCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,10 @@ export interface DeleteFolderCommandOutput extends __MetadataBearer {
26
26
  * import { WorkDocsClient, DeleteFolderCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
27
27
  * // const { WorkDocsClient, DeleteFolderCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
28
28
  * const client = new WorkDocsClient(config);
29
+ * const input = {
30
+ * AuthenticationToken: "STRING_VALUE",
31
+ * FolderId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DeleteFolderCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,10 @@ export interface DeleteFolderContentsCommandOutput extends __MetadataBearer {
26
26
  * import { WorkDocsClient, DeleteFolderContentsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
27
27
  * // const { WorkDocsClient, DeleteFolderContentsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
28
28
  * const client = new WorkDocsClient(config);
29
+ * const input = {
30
+ * AuthenticationToken: "STRING_VALUE",
31
+ * FolderId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DeleteFolderContentsCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,14 @@ export interface DeleteLabelsCommandOutput extends DeleteLabelsResponse, __Metad
26
26
  * import { WorkDocsClient, DeleteLabelsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
27
27
  * // const { WorkDocsClient, DeleteLabelsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
28
28
  * const client = new WorkDocsClient(config);
29
+ * const input = {
30
+ * ResourceId: "STRING_VALUE", // required
31
+ * AuthenticationToken: "STRING_VALUE",
32
+ * Labels: [
33
+ * "STRING_VALUE",
34
+ * ],
35
+ * DeleteAll: true || false,
36
+ * };
29
37
  * const command = new DeleteLabelsCommand(input);
30
38
  * const response = await client.send(command);
31
39
  * ```
@@ -26,6 +26,10 @@ export interface DeleteNotificationSubscriptionCommandOutput extends __MetadataB
26
26
  * import { WorkDocsClient, DeleteNotificationSubscriptionCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
27
27
  * // const { WorkDocsClient, DeleteNotificationSubscriptionCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
28
28
  * const client = new WorkDocsClient(config);
29
+ * const input = {
30
+ * SubscriptionId: "STRING_VALUE", // required
31
+ * OrganizationId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DeleteNotificationSubscriptionCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -29,6 +29,10 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {
29
29
  * import { WorkDocsClient, DeleteUserCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
30
30
  * // const { WorkDocsClient, DeleteUserCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
31
31
  * const client = new WorkDocsClient(config);
32
+ * const input = {
33
+ * AuthenticationToken: "STRING_VALUE",
34
+ * UserId: "STRING_VALUE", // required
35
+ * };
32
36
  * const command = new DeleteUserCommand(input);
33
37
  * const response = await client.send(command);
34
38
  * ```
@@ -26,6 +26,18 @@ export interface DescribeActivitiesCommandOutput extends DescribeActivitiesRespo
26
26
  * import { WorkDocsClient, DescribeActivitiesCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
27
27
  * // const { WorkDocsClient, DescribeActivitiesCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
28
28
  * const client = new WorkDocsClient(config);
29
+ * const input = {
30
+ * AuthenticationToken: "STRING_VALUE",
31
+ * StartTime: new Date("TIMESTAMP"),
32
+ * EndTime: new Date("TIMESTAMP"),
33
+ * OrganizationId: "STRING_VALUE",
34
+ * ActivityTypes: "STRING_VALUE",
35
+ * ResourceId: "STRING_VALUE",
36
+ * UserId: "STRING_VALUE",
37
+ * IncludeIndirectActivities: true || false,
38
+ * Limit: Number("int"),
39
+ * Marker: "STRING_VALUE",
40
+ * };
29
41
  * const command = new DescribeActivitiesCommand(input);
30
42
  * const response = await client.send(command);
31
43
  * ```
@@ -26,6 +26,13 @@ export interface DescribeCommentsCommandOutput extends DescribeCommentsResponse,
26
26
  * import { WorkDocsClient, DescribeCommentsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
27
27
  * // const { WorkDocsClient, DescribeCommentsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
28
28
  * const client = new WorkDocsClient(config);
29
+ * const input = {
30
+ * AuthenticationToken: "STRING_VALUE",
31
+ * DocumentId: "STRING_VALUE", // required
32
+ * VersionId: "STRING_VALUE", // required
33
+ * Limit: Number("int"),
34
+ * Marker: "STRING_VALUE",
35
+ * };
29
36
  * const command = new DescribeCommentsCommand(input);
30
37
  * const response = await client.send(command);
31
38
  * ```
@@ -27,6 +27,14 @@ export interface DescribeDocumentVersionsCommandOutput extends DescribeDocumentV
27
27
  * import { WorkDocsClient, DescribeDocumentVersionsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
28
28
  * // const { WorkDocsClient, DescribeDocumentVersionsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
29
29
  * const client = new WorkDocsClient(config);
30
+ * const input = {
31
+ * AuthenticationToken: "STRING_VALUE",
32
+ * DocumentId: "STRING_VALUE", // required
33
+ * Marker: "STRING_VALUE",
34
+ * Limit: Number("int"),
35
+ * Include: "STRING_VALUE",
36
+ * Fields: "STRING_VALUE",
37
+ * };
30
38
  * const command = new DescribeDocumentVersionsCommand(input);
31
39
  * const response = await client.send(command);
32
40
  * ```
@@ -31,6 +31,16 @@ export interface DescribeFolderContentsCommandOutput extends DescribeFolderConte
31
31
  * import { WorkDocsClient, DescribeFolderContentsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
32
32
  * // const { WorkDocsClient, DescribeFolderContentsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
33
33
  * const client = new WorkDocsClient(config);
34
+ * const input = {
35
+ * AuthenticationToken: "STRING_VALUE",
36
+ * FolderId: "STRING_VALUE", // required
37
+ * Sort: "DATE" || "NAME",
38
+ * Order: "ASCENDING" || "DESCENDING",
39
+ * Limit: Number("int"),
40
+ * Marker: "STRING_VALUE",
41
+ * Type: "ALL" || "DOCUMENT" || "FOLDER",
42
+ * Include: "STRING_VALUE",
43
+ * };
34
44
  * const command = new DescribeFolderContentsCommand(input);
35
45
  * const response = await client.send(command);
36
46
  * ```
@@ -27,6 +27,13 @@ export interface DescribeGroupsCommandOutput extends DescribeGroupsResponse, __M
27
27
  * import { WorkDocsClient, DescribeGroupsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
28
28
  * // const { WorkDocsClient, DescribeGroupsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
29
29
  * const client = new WorkDocsClient(config);
30
+ * const input = {
31
+ * AuthenticationToken: "STRING_VALUE",
32
+ * SearchQuery: "STRING_VALUE", // required
33
+ * OrganizationId: "STRING_VALUE",
34
+ * Marker: "STRING_VALUE",
35
+ * Limit: Number("int"),
36
+ * };
30
37
  * const command = new DescribeGroupsCommand(input);
31
38
  * const response = await client.send(command);
32
39
  * ```
@@ -26,6 +26,11 @@ export interface DescribeNotificationSubscriptionsCommandOutput extends Describe
26
26
  * import { WorkDocsClient, DescribeNotificationSubscriptionsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
27
27
  * // const { WorkDocsClient, DescribeNotificationSubscriptionsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
28
28
  * const client = new WorkDocsClient(config);
29
+ * const input = {
30
+ * OrganizationId: "STRING_VALUE", // required
31
+ * Marker: "STRING_VALUE",
32
+ * Limit: Number("int"),
33
+ * };
29
34
  * const command = new DescribeNotificationSubscriptionsCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,13 @@ export interface DescribeResourcePermissionsCommandOutput extends DescribeResour
26
26
  * import { WorkDocsClient, DescribeResourcePermissionsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
27
27
  * // const { WorkDocsClient, DescribeResourcePermissionsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
28
28
  * const client = new WorkDocsClient(config);
29
+ * const input = {
30
+ * AuthenticationToken: "STRING_VALUE",
31
+ * ResourceId: "STRING_VALUE", // required
32
+ * PrincipalId: "STRING_VALUE",
33
+ * Limit: Number("int"),
34
+ * Marker: "STRING_VALUE",
35
+ * };
29
36
  * const command = new DescribeResourcePermissionsCommand(input);
30
37
  * const response = await client.send(command);
31
38
  * ```
@@ -34,6 +34,11 @@ export interface DescribeRootFoldersCommandOutput extends DescribeRootFoldersRes
34
34
  * import { WorkDocsClient, DescribeRootFoldersCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
35
35
  * // const { WorkDocsClient, DescribeRootFoldersCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
36
36
  * const client = new WorkDocsClient(config);
37
+ * const input = {
38
+ * AuthenticationToken: "STRING_VALUE", // required
39
+ * Limit: Number("int"),
40
+ * Marker: "STRING_VALUE",
41
+ * };
37
42
  * const command = new DescribeRootFoldersCommand(input);
38
43
  * const response = await client.send(command);
39
44
  * ```
@@ -30,6 +30,18 @@ export interface DescribeUsersCommandOutput extends DescribeUsersResponse, __Met
30
30
  * import { WorkDocsClient, DescribeUsersCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
31
31
  * // const { WorkDocsClient, DescribeUsersCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
32
32
  * const client = new WorkDocsClient(config);
33
+ * const input = {
34
+ * AuthenticationToken: "STRING_VALUE",
35
+ * OrganizationId: "STRING_VALUE",
36
+ * UserIds: "STRING_VALUE",
37
+ * Query: "STRING_VALUE",
38
+ * Include: "ALL" || "ACTIVE_PENDING",
39
+ * Order: "ASCENDING" || "DESCENDING",
40
+ * Sort: "USER_NAME" || "FULL_NAME" || "STORAGE_LIMIT" || "USER_STATUS" || "STORAGE_USED",
41
+ * Marker: "STRING_VALUE",
42
+ * Limit: Number("int"),
43
+ * Fields: "STRING_VALUE",
44
+ * };
33
45
  * const command = new DescribeUsersCommand(input);
34
46
  * const response = await client.send(command);
35
47
  * ```
@@ -32,6 +32,9 @@ export interface GetCurrentUserCommandOutput extends GetCurrentUserResponse, __M
32
32
  * import { WorkDocsClient, GetCurrentUserCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
33
33
  * // const { WorkDocsClient, GetCurrentUserCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
34
34
  * const client = new WorkDocsClient(config);
35
+ * const input = {
36
+ * AuthenticationToken: "STRING_VALUE", // required
37
+ * };
35
38
  * const command = new GetCurrentUserCommand(input);
36
39
  * const response = await client.send(command);
37
40
  * ```
@@ -26,6 +26,11 @@ export interface GetDocumentCommandOutput extends GetDocumentResponse, __Metadat
26
26
  * import { WorkDocsClient, GetDocumentCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
27
27
  * // const { WorkDocsClient, GetDocumentCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
28
28
  * const client = new WorkDocsClient(config);
29
+ * const input = {
30
+ * AuthenticationToken: "STRING_VALUE",
31
+ * DocumentId: "STRING_VALUE", // required
32
+ * IncludeCustomMetadata: true || false,
33
+ * };
29
34
  * const command = new GetDocumentCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -31,6 +31,13 @@ export interface GetDocumentPathCommandOutput extends GetDocumentPathResponse, _
31
31
  * import { WorkDocsClient, GetDocumentPathCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
32
32
  * // const { WorkDocsClient, GetDocumentPathCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
33
33
  * const client = new WorkDocsClient(config);
34
+ * const input = {
35
+ * AuthenticationToken: "STRING_VALUE",
36
+ * DocumentId: "STRING_VALUE", // required
37
+ * Limit: Number("int"),
38
+ * Fields: "STRING_VALUE",
39
+ * Marker: "STRING_VALUE",
40
+ * };
34
41
  * const command = new GetDocumentPathCommand(input);
35
42
  * const response = await client.send(command);
36
43
  * ```
@@ -26,6 +26,13 @@ export interface GetDocumentVersionCommandOutput extends GetDocumentVersionRespo
26
26
  * import { WorkDocsClient, GetDocumentVersionCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
27
27
  * // const { WorkDocsClient, GetDocumentVersionCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
28
28
  * const client = new WorkDocsClient(config);
29
+ * const input = {
30
+ * AuthenticationToken: "STRING_VALUE",
31
+ * DocumentId: "STRING_VALUE", // required
32
+ * VersionId: "STRING_VALUE", // required
33
+ * Fields: "STRING_VALUE",
34
+ * IncludeCustomMetadata: true || false,
35
+ * };
29
36
  * const command = new GetDocumentVersionCommand(input);
30
37
  * const response = await client.send(command);
31
38
  * ```
@@ -26,6 +26,11 @@ export interface GetFolderCommandOutput extends GetFolderResponse, __MetadataBea
26
26
  * import { WorkDocsClient, GetFolderCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
27
27
  * // const { WorkDocsClient, GetFolderCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
28
28
  * const client = new WorkDocsClient(config);
29
+ * const input = {
30
+ * AuthenticationToken: "STRING_VALUE",
31
+ * FolderId: "STRING_VALUE", // required
32
+ * IncludeCustomMetadata: true || false,
33
+ * };
29
34
  * const command = new GetFolderCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -31,6 +31,13 @@ export interface GetFolderPathCommandOutput extends GetFolderPathResponse, __Met
31
31
  * import { WorkDocsClient, GetFolderPathCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
32
32
  * // const { WorkDocsClient, GetFolderPathCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
33
33
  * const client = new WorkDocsClient(config);
34
+ * const input = {
35
+ * AuthenticationToken: "STRING_VALUE",
36
+ * FolderId: "STRING_VALUE", // required
37
+ * Limit: Number("int"),
38
+ * Fields: "STRING_VALUE",
39
+ * Marker: "STRING_VALUE",
40
+ * };
34
41
  * const command = new GetFolderPathCommand(input);
35
42
  * const response = await client.send(command);
36
43
  * ```
@@ -27,6 +27,13 @@ export interface GetResourcesCommandOutput extends GetResourcesResponse, __Metad
27
27
  * import { WorkDocsClient, GetResourcesCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
28
28
  * // const { WorkDocsClient, GetResourcesCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
29
29
  * const client = new WorkDocsClient(config);
30
+ * const input = {
31
+ * AuthenticationToken: "STRING_VALUE",
32
+ * UserId: "STRING_VALUE",
33
+ * CollectionType: "SHARED_WITH_ME",
34
+ * Limit: Number("int"),
35
+ * Marker: "STRING_VALUE",
36
+ * };
30
37
  * const command = new GetResourcesCommand(input);
31
38
  * const response = await client.send(command);
32
39
  * ```
@@ -31,6 +31,16 @@ export interface InitiateDocumentVersionUploadCommandOutput extends InitiateDocu
31
31
  * import { WorkDocsClient, InitiateDocumentVersionUploadCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
32
32
  * // const { WorkDocsClient, InitiateDocumentVersionUploadCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
33
33
  * const client = new WorkDocsClient(config);
34
+ * const input = {
35
+ * AuthenticationToken: "STRING_VALUE",
36
+ * Id: "STRING_VALUE",
37
+ * Name: "STRING_VALUE",
38
+ * ContentCreatedTimestamp: new Date("TIMESTAMP"),
39
+ * ContentModifiedTimestamp: new Date("TIMESTAMP"),
40
+ * ContentType: "STRING_VALUE",
41
+ * DocumentSizeInBytes: Number("long"),
42
+ * ParentFolderId: "STRING_VALUE",
43
+ * };
34
44
  * const command = new InitiateDocumentVersionUploadCommand(input);
35
45
  * const response = await client.send(command);
36
46
  * ```
@@ -26,6 +26,10 @@ export interface RemoveAllResourcePermissionsCommandOutput extends __MetadataBea
26
26
  * import { WorkDocsClient, RemoveAllResourcePermissionsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
27
27
  * // const { WorkDocsClient, RemoveAllResourcePermissionsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
28
28
  * const client = new WorkDocsClient(config);
29
+ * const input = {
30
+ * AuthenticationToken: "STRING_VALUE",
31
+ * ResourceId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new RemoveAllResourcePermissionsCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -27,6 +27,12 @@ export interface RemoveResourcePermissionCommandOutput extends __MetadataBearer
27
27
  * import { WorkDocsClient, RemoveResourcePermissionCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
28
28
  * // const { WorkDocsClient, RemoveResourcePermissionCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
29
29
  * const client = new WorkDocsClient(config);
30
+ * const input = {
31
+ * AuthenticationToken: "STRING_VALUE",
32
+ * ResourceId: "STRING_VALUE", // required
33
+ * PrincipalId: "STRING_VALUE", // required
34
+ * PrincipalType: "USER" || "GROUP" || "INVITE" || "ANONYMOUS" || "ORGANIZATION",
35
+ * };
30
36
  * const command = new RemoveResourcePermissionCommand(input);
31
37
  * const response = await client.send(command);
32
38
  * ```
@@ -26,6 +26,10 @@ export interface RestoreDocumentVersionsCommandOutput extends __MetadataBearer {
26
26
  * import { WorkDocsClient, RestoreDocumentVersionsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
27
27
  * // const { WorkDocsClient, RestoreDocumentVersionsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
28
28
  * const client = new WorkDocsClient(config);
29
+ * const input = {
30
+ * AuthenticationToken: "STRING_VALUE",
31
+ * DocumentId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new RestoreDocumentVersionsCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,65 @@ export interface SearchResourcesCommandOutput extends SearchResourcesResponse, _
26
26
  * import { WorkDocsClient, SearchResourcesCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
27
27
  * // const { WorkDocsClient, SearchResourcesCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
28
28
  * const client = new WorkDocsClient(config);
29
+ * const input = {
30
+ * AuthenticationToken: "STRING_VALUE",
31
+ * QueryText: "STRING_VALUE",
32
+ * QueryScopes: [
33
+ * "NAME" || "CONTENT",
34
+ * ],
35
+ * OrganizationId: "STRING_VALUE",
36
+ * AdditionalResponseFields: [
37
+ * "WEBURL",
38
+ * ],
39
+ * Filters: {
40
+ * TextLocales: [
41
+ * "AR" || "BG" || "BN" || "DA" || "DE" || "CS" || "EL" || "EN" || "ES" || "FA" || "FI" || "FR" || "HI" || "HU" || "ID" || "IT" || "JA" || "KO" || "LT" || "LV" || "NL" || "NO" || "PT" || "RO" || "RU" || "SV" || "SW" || "TH" || "TR" || "ZH" || "DEFAULT",
42
+ * ],
43
+ * ContentCategories: [
44
+ * "IMAGE" || "DOCUMENT" || "PDF" || "SPREADSHEET" || "PRESENTATION" || "AUDIO" || "VIDEO" || "SOURCE_CODE" || "OTHER",
45
+ * ],
46
+ * ResourceTypes: [
47
+ * "FOLDER" || "DOCUMENT" || "COMMENT" || "DOCUMENT_VERSION",
48
+ * ],
49
+ * Labels: [
50
+ * "STRING_VALUE",
51
+ * ],
52
+ * Principals: [
53
+ * {
54
+ * Id: "STRING_VALUE", // required
55
+ * Roles: [
56
+ * "VIEWER" || "CONTRIBUTOR" || "OWNER" || "COOWNER",
57
+ * ],
58
+ * },
59
+ * ],
60
+ * AncestorIds: [
61
+ * "STRING_VALUE",
62
+ * ],
63
+ * SearchCollectionTypes: [
64
+ * "OWNED" || "SHARED_WITH_ME",
65
+ * ],
66
+ * SizeRange: {
67
+ * StartValue: Number("long"),
68
+ * EndValue: Number("long"),
69
+ * },
70
+ * CreatedRange: {
71
+ * StartValue: new Date("TIMESTAMP"),
72
+ * EndValue: new Date("TIMESTAMP"),
73
+ * },
74
+ * ModifiedRange: {
75
+ * StartValue: new Date("TIMESTAMP"),
76
+ * EndValue: new Date("TIMESTAMP"),
77
+ * },
78
+ * },
79
+ * OrderBy: [
80
+ * {
81
+ * Field: "RELEVANCE" || "NAME" || "SIZE" || "CREATED_TIMESTAMP" || "MODIFIED_TIMESTAMP",
82
+ * Order: "ASC" || "DESC",
83
+ * },
84
+ * ],
85
+ * Limit: Number("int"),
86
+ * Marker: "STRING_VALUE",
87
+ * };
29
88
  * const command = new SearchResourcesCommand(input);
30
89
  * const response = await client.send(command);
31
90
  * ```
@@ -27,6 +27,13 @@ export interface UpdateDocumentCommandOutput extends __MetadataBearer {
27
27
  * import { WorkDocsClient, UpdateDocumentCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
28
28
  * // const { WorkDocsClient, UpdateDocumentCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
29
29
  * const client = new WorkDocsClient(config);
30
+ * const input = {
31
+ * AuthenticationToken: "STRING_VALUE",
32
+ * DocumentId: "STRING_VALUE", // required
33
+ * Name: "STRING_VALUE",
34
+ * ParentFolderId: "STRING_VALUE",
35
+ * ResourceState: "ACTIVE" || "RESTORING" || "RECYCLING" || "RECYCLED",
36
+ * };
30
37
  * const command = new UpdateDocumentCommand(input);
31
38
  * const response = await client.send(command);
32
39
  * ```
@@ -29,6 +29,12 @@ export interface UpdateDocumentVersionCommandOutput extends __MetadataBearer {
29
29
  * import { WorkDocsClient, UpdateDocumentVersionCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
30
30
  * // const { WorkDocsClient, UpdateDocumentVersionCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
31
31
  * const client = new WorkDocsClient(config);
32
+ * const input = {
33
+ * AuthenticationToken: "STRING_VALUE",
34
+ * DocumentId: "STRING_VALUE", // required
35
+ * VersionId: "STRING_VALUE", // required
36
+ * VersionStatus: "ACTIVE",
37
+ * };
32
38
  * const command = new UpdateDocumentVersionCommand(input);
33
39
  * const response = await client.send(command);
34
40
  * ```
@@ -27,6 +27,13 @@ export interface UpdateFolderCommandOutput extends __MetadataBearer {
27
27
  * import { WorkDocsClient, UpdateFolderCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
28
28
  * // const { WorkDocsClient, UpdateFolderCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
29
29
  * const client = new WorkDocsClient(config);
30
+ * const input = {
31
+ * AuthenticationToken: "STRING_VALUE",
32
+ * FolderId: "STRING_VALUE", // required
33
+ * Name: "STRING_VALUE",
34
+ * ParentFolderId: "STRING_VALUE",
35
+ * ResourceState: "ACTIVE" || "RESTORING" || "RECYCLING" || "RECYCLED",
36
+ * };
30
37
  * const command = new UpdateFolderCommand(input);
31
38
  * const response = await client.send(command);
32
39
  * ```
@@ -27,6 +27,20 @@ export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataB
27
27
  * import { WorkDocsClient, UpdateUserCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
28
28
  * // const { WorkDocsClient, UpdateUserCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
29
29
  * const client = new WorkDocsClient(config);
30
+ * const input = {
31
+ * AuthenticationToken: "STRING_VALUE",
32
+ * UserId: "STRING_VALUE", // required
33
+ * GivenName: "STRING_VALUE",
34
+ * Surname: "STRING_VALUE",
35
+ * Type: "USER" || "ADMIN" || "POWERUSER" || "MINIMALUSER" || "WORKSPACESUSER",
36
+ * StorageRule: {
37
+ * StorageAllocatedInBytes: Number("long"),
38
+ * StorageType: "UNLIMITED" || "QUOTA",
39
+ * },
40
+ * TimeZoneId: "STRING_VALUE",
41
+ * Locale: "en" || "fr" || "ko" || "de" || "es" || "ja" || "ru" || "zh_CN" || "zh_TW" || "pt_BR" || "default",
42
+ * GrantPoweruserPrivileges: "TRUE" || "FALSE",
43
+ * };
30
44
  * const command = new UpdateUserCommand(input);
31
45
  * const response = await client.send(command);
32
46
  * ```
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-workdocs",
3
3
  "description": "AWS SDK for JavaScript Workdocs Client for Node.js, Browser and React Native",
4
- "version": "3.299.0",
4
+ "version": "3.300.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.299.0",
25
- "@aws-sdk/config-resolver": "3.299.0",
26
- "@aws-sdk/credential-provider-node": "3.299.0",
24
+ "@aws-sdk/client-sts": "3.300.0",
25
+ "@aws-sdk/config-resolver": "3.300.0",
26
+ "@aws-sdk/credential-provider-node": "3.300.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.296.0",
28
28
  "@aws-sdk/hash-node": "3.296.0",
29
29
  "@aws-sdk/invalid-dependency": "3.296.0",
@@ -32,12 +32,12 @@
32
32
  "@aws-sdk/middleware-host-header": "3.296.0",
33
33
  "@aws-sdk/middleware-logger": "3.296.0",
34
34
  "@aws-sdk/middleware-recursion-detection": "3.296.0",
35
- "@aws-sdk/middleware-retry": "3.296.0",
35
+ "@aws-sdk/middleware-retry": "3.300.0",
36
36
  "@aws-sdk/middleware-serde": "3.296.0",
37
37
  "@aws-sdk/middleware-signing": "3.299.0",
38
38
  "@aws-sdk/middleware-stack": "3.296.0",
39
39
  "@aws-sdk/middleware-user-agent": "3.299.0",
40
- "@aws-sdk/node-config-provider": "3.296.0",
40
+ "@aws-sdk/node-config-provider": "3.300.0",
41
41
  "@aws-sdk/node-http-handler": "3.296.0",
42
42
  "@aws-sdk/protocol-http": "3.296.0",
43
43
  "@aws-sdk/smithy-client": "3.296.0",
@@ -47,11 +47,11 @@
47
47
  "@aws-sdk/util-body-length-browser": "3.295.0",
48
48
  "@aws-sdk/util-body-length-node": "3.295.0",
49
49
  "@aws-sdk/util-defaults-mode-browser": "3.296.0",
50
- "@aws-sdk/util-defaults-mode-node": "3.299.0",
50
+ "@aws-sdk/util-defaults-mode-node": "3.300.0",
51
51
  "@aws-sdk/util-endpoints": "3.296.0",
52
52
  "@aws-sdk/util-retry": "3.296.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.299.0",
54
- "@aws-sdk/util-user-agent-node": "3.299.0",
54
+ "@aws-sdk/util-user-agent-node": "3.300.0",
55
55
  "@aws-sdk/util-utf8": "3.295.0",
56
56
  "tslib": "^2.5.0"
57
57
  },