@aws-sdk/client-workdocs 3.209.0 → 3.210.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 (29) hide show
  1. package/README.md +26 -0
  2. package/dist-cjs/WorkDocs.js +30 -0
  3. package/dist-cjs/commands/DeleteDocumentVersionCommand.js +46 -0
  4. package/dist-cjs/commands/RestoreDocumentVersionsCommand.js +46 -0
  5. package/dist-cjs/commands/index.js +2 -0
  6. package/dist-cjs/models/models_0.js +75 -46
  7. package/dist-cjs/protocols/Aws_restJson1.js +187 -2
  8. package/dist-es/WorkDocs.js +30 -0
  9. package/dist-es/commands/DeleteDocumentVersionCommand.js +42 -0
  10. package/dist-es/commands/RestoreDocumentVersionsCommand.js +42 -0
  11. package/dist-es/commands/index.js +2 -0
  12. package/dist-es/models/models_0.js +65 -38
  13. package/dist-es/protocols/Aws_restJson1.js +181 -0
  14. package/dist-types/WorkDocs.d.ts +41 -2
  15. package/dist-types/WorkDocsClient.d.ts +30 -2
  16. package/dist-types/commands/CreateNotificationSubscriptionCommand.d.ts +1 -2
  17. package/dist-types/commands/DeleteDocumentVersionCommand.d.ts +37 -0
  18. package/dist-types/commands/RestoreDocumentVersionsCommand.d.ts +37 -0
  19. package/dist-types/commands/index.d.ts +2 -0
  20. package/dist-types/models/models_0.d.ts +108 -51
  21. package/dist-types/protocols/Aws_restJson1.d.ts +6 -0
  22. package/dist-types/ts3.4/WorkDocs.d.ts +34 -0
  23. package/dist-types/ts3.4/WorkDocsClient.d.ts +12 -0
  24. package/dist-types/ts3.4/commands/DeleteDocumentVersionCommand.d.ts +36 -0
  25. package/dist-types/ts3.4/commands/RestoreDocumentVersionsCommand.d.ts +37 -0
  26. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  27. package/dist-types/ts3.4/models/models_0.d.ts +52 -35
  28. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
  29. package/package.json +4 -4
@@ -20,6 +20,7 @@ import { DeactivateUserCommandInput, DeactivateUserCommandOutput } from "./comma
20
20
  import { DeleteCommentCommandInput, DeleteCommentCommandOutput } from "./commands/DeleteCommentCommand";
21
21
  import { DeleteCustomMetadataCommandInput, DeleteCustomMetadataCommandOutput } from "./commands/DeleteCustomMetadataCommand";
22
22
  import { DeleteDocumentCommandInput, DeleteDocumentCommandOutput } from "./commands/DeleteDocumentCommand";
23
+ import { DeleteDocumentVersionCommandInput, DeleteDocumentVersionCommandOutput } from "./commands/DeleteDocumentVersionCommand";
23
24
  import { DeleteFolderCommandInput, DeleteFolderCommandOutput } from "./commands/DeleteFolderCommand";
24
25
  import { DeleteFolderContentsCommandInput, DeleteFolderContentsCommandOutput } from "./commands/DeleteFolderContentsCommand";
25
26
  import { DeleteLabelsCommandInput, DeleteLabelsCommandOutput } from "./commands/DeleteLabelsCommand";
@@ -44,13 +45,14 @@ import { GetResourcesCommandInput, GetResourcesCommandOutput } from "./commands/
44
45
  import { InitiateDocumentVersionUploadCommandInput, InitiateDocumentVersionUploadCommandOutput } from "./commands/InitiateDocumentVersionUploadCommand";
45
46
  import { RemoveAllResourcePermissionsCommandInput, RemoveAllResourcePermissionsCommandOutput } from "./commands/RemoveAllResourcePermissionsCommand";
46
47
  import { RemoveResourcePermissionCommandInput, RemoveResourcePermissionCommandOutput } from "./commands/RemoveResourcePermissionCommand";
48
+ import { RestoreDocumentVersionsCommandInput, RestoreDocumentVersionsCommandOutput } from "./commands/RestoreDocumentVersionsCommand";
47
49
  import { UpdateDocumentCommandInput, UpdateDocumentCommandOutput } from "./commands/UpdateDocumentCommand";
48
50
  import { UpdateDocumentVersionCommandInput, UpdateDocumentVersionCommandOutput } from "./commands/UpdateDocumentVersionCommand";
49
51
  import { UpdateFolderCommandInput, UpdateFolderCommandOutput } from "./commands/UpdateFolderCommand";
50
52
  import { UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand";
51
53
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
52
- export declare type ServiceInputTypes = AbortDocumentVersionUploadCommandInput | ActivateUserCommandInput | AddResourcePermissionsCommandInput | CreateCommentCommandInput | CreateCustomMetadataCommandInput | CreateFolderCommandInput | CreateLabelsCommandInput | CreateNotificationSubscriptionCommandInput | CreateUserCommandInput | DeactivateUserCommandInput | DeleteCommentCommandInput | DeleteCustomMetadataCommandInput | DeleteDocumentCommandInput | DeleteFolderCommandInput | DeleteFolderContentsCommandInput | DeleteLabelsCommandInput | DeleteNotificationSubscriptionCommandInput | DeleteUserCommandInput | DescribeActivitiesCommandInput | DescribeCommentsCommandInput | DescribeDocumentVersionsCommandInput | DescribeFolderContentsCommandInput | DescribeGroupsCommandInput | DescribeNotificationSubscriptionsCommandInput | DescribeResourcePermissionsCommandInput | DescribeRootFoldersCommandInput | DescribeUsersCommandInput | GetCurrentUserCommandInput | GetDocumentCommandInput | GetDocumentPathCommandInput | GetDocumentVersionCommandInput | GetFolderCommandInput | GetFolderPathCommandInput | GetResourcesCommandInput | InitiateDocumentVersionUploadCommandInput | RemoveAllResourcePermissionsCommandInput | RemoveResourcePermissionCommandInput | UpdateDocumentCommandInput | UpdateDocumentVersionCommandInput | UpdateFolderCommandInput | UpdateUserCommandInput;
53
- export declare type ServiceOutputTypes = AbortDocumentVersionUploadCommandOutput | ActivateUserCommandOutput | AddResourcePermissionsCommandOutput | CreateCommentCommandOutput | CreateCustomMetadataCommandOutput | CreateFolderCommandOutput | CreateLabelsCommandOutput | CreateNotificationSubscriptionCommandOutput | CreateUserCommandOutput | DeactivateUserCommandOutput | DeleteCommentCommandOutput | DeleteCustomMetadataCommandOutput | DeleteDocumentCommandOutput | DeleteFolderCommandOutput | DeleteFolderContentsCommandOutput | DeleteLabelsCommandOutput | DeleteNotificationSubscriptionCommandOutput | DeleteUserCommandOutput | DescribeActivitiesCommandOutput | DescribeCommentsCommandOutput | DescribeDocumentVersionsCommandOutput | DescribeFolderContentsCommandOutput | DescribeGroupsCommandOutput | DescribeNotificationSubscriptionsCommandOutput | DescribeResourcePermissionsCommandOutput | DescribeRootFoldersCommandOutput | DescribeUsersCommandOutput | GetCurrentUserCommandOutput | GetDocumentCommandOutput | GetDocumentPathCommandOutput | GetDocumentVersionCommandOutput | GetFolderCommandOutput | GetFolderPathCommandOutput | GetResourcesCommandOutput | InitiateDocumentVersionUploadCommandOutput | RemoveAllResourcePermissionsCommandOutput | RemoveResourcePermissionCommandOutput | UpdateDocumentCommandOutput | UpdateDocumentVersionCommandOutput | UpdateFolderCommandOutput | UpdateUserCommandOutput;
54
+ export declare type ServiceInputTypes = AbortDocumentVersionUploadCommandInput | ActivateUserCommandInput | AddResourcePermissionsCommandInput | CreateCommentCommandInput | CreateCustomMetadataCommandInput | CreateFolderCommandInput | CreateLabelsCommandInput | CreateNotificationSubscriptionCommandInput | CreateUserCommandInput | DeactivateUserCommandInput | DeleteCommentCommandInput | DeleteCustomMetadataCommandInput | DeleteDocumentCommandInput | DeleteDocumentVersionCommandInput | DeleteFolderCommandInput | DeleteFolderContentsCommandInput | DeleteLabelsCommandInput | DeleteNotificationSubscriptionCommandInput | DeleteUserCommandInput | DescribeActivitiesCommandInput | DescribeCommentsCommandInput | DescribeDocumentVersionsCommandInput | DescribeFolderContentsCommandInput | DescribeGroupsCommandInput | DescribeNotificationSubscriptionsCommandInput | DescribeResourcePermissionsCommandInput | DescribeRootFoldersCommandInput | DescribeUsersCommandInput | GetCurrentUserCommandInput | GetDocumentCommandInput | GetDocumentPathCommandInput | GetDocumentVersionCommandInput | GetFolderCommandInput | GetFolderPathCommandInput | GetResourcesCommandInput | InitiateDocumentVersionUploadCommandInput | RemoveAllResourcePermissionsCommandInput | RemoveResourcePermissionCommandInput | RestoreDocumentVersionsCommandInput | UpdateDocumentCommandInput | UpdateDocumentVersionCommandInput | UpdateFolderCommandInput | UpdateUserCommandInput;
55
+ export declare type ServiceOutputTypes = AbortDocumentVersionUploadCommandOutput | ActivateUserCommandOutput | AddResourcePermissionsCommandOutput | CreateCommentCommandOutput | CreateCustomMetadataCommandOutput | CreateFolderCommandOutput | CreateLabelsCommandOutput | CreateNotificationSubscriptionCommandOutput | CreateUserCommandOutput | DeactivateUserCommandOutput | DeleteCommentCommandOutput | DeleteCustomMetadataCommandOutput | DeleteDocumentCommandOutput | DeleteDocumentVersionCommandOutput | DeleteFolderCommandOutput | DeleteFolderContentsCommandOutput | DeleteLabelsCommandOutput | DeleteNotificationSubscriptionCommandOutput | DeleteUserCommandOutput | DescribeActivitiesCommandOutput | DescribeCommentsCommandOutput | DescribeDocumentVersionsCommandOutput | DescribeFolderContentsCommandOutput | DescribeGroupsCommandOutput | DescribeNotificationSubscriptionsCommandOutput | DescribeResourcePermissionsCommandOutput | DescribeRootFoldersCommandOutput | DescribeUsersCommandOutput | GetCurrentUserCommandOutput | GetDocumentCommandOutput | GetDocumentPathCommandOutput | GetDocumentVersionCommandOutput | GetFolderCommandOutput | GetFolderPathCommandOutput | GetResourcesCommandOutput | InitiateDocumentVersionUploadCommandOutput | RemoveAllResourcePermissionsCommandOutput | RemoveResourcePermissionCommandOutput | RestoreDocumentVersionsCommandOutput | UpdateDocumentCommandOutput | UpdateDocumentVersionCommandOutput | UpdateFolderCommandOutput | UpdateUserCommandOutput;
54
56
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
55
57
  /**
56
58
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
@@ -197,6 +199,32 @@ export interface WorkDocsClientResolvedConfig extends WorkDocsClientResolvedConf
197
199
  * permissions and upload any file to any user. This allows developers to perform the three
198
200
  * use cases above, as well as give users the ability to grant access on a selective basis
199
201
  * using the IAM model.</p>
202
+ * <note>
203
+ * <p>The pricing for Amazon WorkDocs APIs varies depending on the API call type for these actions:</p>
204
+ * <ul>
205
+ * <li>
206
+ * <p>
207
+ * <code>READ (Get*)</code>
208
+ * </p>
209
+ * </li>
210
+ * <li>
211
+ * <p>
212
+ * <code>WRITE (Activate*, Add*, Create*, Deactivate*, Initiate*, Update*)</code>
213
+ * </p>
214
+ * </li>
215
+ * <li>
216
+ * <p>
217
+ * <code>LIST (Describe*)</code>
218
+ * </p>
219
+ * </li>
220
+ * <li>
221
+ * <p>
222
+ * <code>DELETE*, CANCEL</code>
223
+ * </p>
224
+ * </li>
225
+ * </ul>
226
+ * <p>For information about Amazon WorkDocs API pricing, see <a href="https://aws.amazon.com/workdocs/pricing/">Amazon WorkDocs Pricing</a>.</p>
227
+ * </note>
200
228
  */
201
229
  export declare class WorkDocsClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig> {
202
230
  /**
@@ -10,8 +10,7 @@ export interface CreateNotificationSubscriptionCommandOutput extends CreateNotif
10
10
  /**
11
11
  * <p>Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a
12
12
  * confirmation message, and must confirm the subscription.</p>
13
- * <p>For more information, see <a href="https://docs.aws.amazon.com/workdocs/latest/developerguide/subscribe-notifications.html">Subscribe to
14
- * Notifications</a> in the <i>Amazon WorkDocs Developer
13
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/workdocs/latest/developerguide/manage-notifications.html">Setting up notifications for an IAM user or role</a> in the <i>Amazon WorkDocs Developer
15
14
  * Guide</i>.</p>
16
15
  * @example
17
16
  * Use a bare-bones client and the command you need to make an API call.
@@ -0,0 +1,37 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { DeleteDocumentVersionRequest } from "../models/models_0";
5
+ import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
+ export interface DeleteDocumentVersionCommandInput extends DeleteDocumentVersionRequest {
7
+ }
8
+ export interface DeleteDocumentVersionCommandOutput extends __MetadataBearer {
9
+ }
10
+ /**
11
+ * <p>Deletes a version of an Amazon WorkDocs document. Use the <code>DeletePriorVersions</code> parameter to delete prior versions.</p>
12
+ * @example
13
+ * Use a bare-bones client and the command you need to make an API call.
14
+ * ```javascript
15
+ * import { WorkDocsClient, DeleteDocumentVersionCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
16
+ * // const { WorkDocsClient, DeleteDocumentVersionCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
17
+ * const client = new WorkDocsClient(config);
18
+ * const command = new DeleteDocumentVersionCommand(input);
19
+ * const response = await client.send(command);
20
+ * ```
21
+ *
22
+ * @see {@link DeleteDocumentVersionCommandInput} for command's `input` shape.
23
+ * @see {@link DeleteDocumentVersionCommandOutput} for command's `response` shape.
24
+ * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
25
+ *
26
+ */
27
+ export declare class DeleteDocumentVersionCommand extends $Command<DeleteDocumentVersionCommandInput, DeleteDocumentVersionCommandOutput, WorkDocsClientResolvedConfig> {
28
+ readonly input: DeleteDocumentVersionCommandInput;
29
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
30
+ constructor(input: DeleteDocumentVersionCommandInput);
31
+ /**
32
+ * @internal
33
+ */
34
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDocumentVersionCommandInput, DeleteDocumentVersionCommandOutput>;
35
+ private serialize;
36
+ private deserialize;
37
+ }
@@ -0,0 +1,37 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { RestoreDocumentVersionsRequest } from "../models/models_0";
5
+ import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
+ export interface RestoreDocumentVersionsCommandInput extends RestoreDocumentVersionsRequest {
7
+ }
8
+ export interface RestoreDocumentVersionsCommandOutput extends __MetadataBearer {
9
+ }
10
+ /**
11
+ * <p>Recovers a deleted version of an Amazon WorkDocs document.</p>
12
+ * @example
13
+ * Use a bare-bones client and the command you need to make an API call.
14
+ * ```javascript
15
+ * import { WorkDocsClient, RestoreDocumentVersionsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
16
+ * // const { WorkDocsClient, RestoreDocumentVersionsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
17
+ * const client = new WorkDocsClient(config);
18
+ * const command = new RestoreDocumentVersionsCommand(input);
19
+ * const response = await client.send(command);
20
+ * ```
21
+ *
22
+ * @see {@link RestoreDocumentVersionsCommandInput} for command's `input` shape.
23
+ * @see {@link RestoreDocumentVersionsCommandOutput} for command's `response` shape.
24
+ * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
25
+ *
26
+ */
27
+ export declare class RestoreDocumentVersionsCommand extends $Command<RestoreDocumentVersionsCommandInput, RestoreDocumentVersionsCommandOutput, WorkDocsClientResolvedConfig> {
28
+ readonly input: RestoreDocumentVersionsCommandInput;
29
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
30
+ constructor(input: RestoreDocumentVersionsCommandInput);
31
+ /**
32
+ * @internal
33
+ */
34
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RestoreDocumentVersionsCommandInput, RestoreDocumentVersionsCommandOutput>;
35
+ private serialize;
36
+ private deserialize;
37
+ }
@@ -11,6 +11,7 @@ export * from "./DeactivateUserCommand";
11
11
  export * from "./DeleteCommentCommand";
12
12
  export * from "./DeleteCustomMetadataCommand";
13
13
  export * from "./DeleteDocumentCommand";
14
+ export * from "./DeleteDocumentVersionCommand";
14
15
  export * from "./DeleteFolderCommand";
15
16
  export * from "./DeleteFolderContentsCommand";
16
17
  export * from "./DeleteLabelsCommand";
@@ -35,6 +36,7 @@ export * from "./GetResourcesCommand";
35
36
  export * from "./InitiateDocumentVersionUploadCommand";
36
37
  export * from "./RemoveAllResourcePermissionsCommand";
37
38
  export * from "./RemoveResourcePermissionCommand";
39
+ export * from "./RestoreDocumentVersionsCommand";
38
40
  export * from "./UpdateDocumentCommand";
39
41
  export * from "./UpdateDocumentVersionCommand";
40
42
  export * from "./UpdateFolderCommand";
@@ -14,6 +14,18 @@ export interface AbortDocumentVersionUploadRequest {
14
14
  */
15
15
  VersionId: string | undefined;
16
16
  }
17
+ /**
18
+ * <p>The resource hierarchy is changing.</p>
19
+ */
20
+ export declare class ConcurrentModificationException extends __BaseException {
21
+ readonly name: "ConcurrentModificationException";
22
+ readonly $fault: "client";
23
+ Message?: string;
24
+ /**
25
+ * @internal
26
+ */
27
+ constructor(opts: __ExceptionOptionType<ConcurrentModificationException, __BaseException>);
28
+ }
17
29
  /**
18
30
  * <p>The resource does not exist.</p>
19
31
  */
@@ -21,6 +33,9 @@ export declare class EntityNotExistsException extends __BaseException {
21
33
  readonly name: "EntityNotExistsException";
22
34
  readonly $fault: "client";
23
35
  Message?: string;
36
+ /**
37
+ * <p>The IDs of the non-existent resources.</p>
38
+ */
24
39
  EntityIds?: string[];
25
40
  /**
26
41
  * @internal
@@ -780,7 +795,7 @@ export declare class EntityAlreadyExistsException extends __BaseException {
780
795
  constructor(opts: __ExceptionOptionType<EntityAlreadyExistsException, __BaseException>);
781
796
  }
782
797
  /**
783
- * <p>The maximum of 100,000 folders under the parent folder has been exceeded.</p>
798
+ * <p>The maximum of 100,000 files and folders under the parent folder has been exceeded.</p>
784
799
  */
785
800
  export declare class LimitExceededException extends __BaseException {
786
801
  readonly name: "LimitExceededException";
@@ -821,7 +836,8 @@ export declare class TooManyLabelsException extends __BaseException {
821
836
  constructor(opts: __ExceptionOptionType<TooManyLabelsException, __BaseException>);
822
837
  }
823
838
  export declare enum SubscriptionProtocolType {
824
- HTTPS = "HTTPS"
839
+ HTTPS = "HTTPS",
840
+ SQS = "SQS"
825
841
  }
826
842
  export declare enum SubscriptionType {
827
843
  ALL = "ALL"
@@ -869,6 +885,18 @@ export interface CreateNotificationSubscriptionResponse {
869
885
  */
870
886
  Subscription?: Subscription;
871
887
  }
888
+ /**
889
+ * <p>The pagination marker or limit fields are not valid.</p>
890
+ */
891
+ export declare class InvalidArgumentException extends __BaseException {
892
+ readonly name: "InvalidArgumentException";
893
+ readonly $fault: "client";
894
+ Message?: string;
895
+ /**
896
+ * @internal
897
+ */
898
+ constructor(opts: __ExceptionOptionType<InvalidArgumentException, __BaseException>);
899
+ }
872
900
  /**
873
901
  * <p>You've reached the limit on the number of subscriptions for the WorkDocs
874
902
  * instance.</p>
@@ -980,27 +1008,45 @@ export interface DeleteCustomMetadataRequest {
980
1008
  }
981
1009
  export interface DeleteCustomMetadataResponse {
982
1010
  }
983
- /**
984
- * <p>The resource hierarchy is changing.</p>
985
- */
986
- export declare class ConcurrentModificationException extends __BaseException {
987
- readonly name: "ConcurrentModificationException";
988
- readonly $fault: "client";
989
- Message?: string;
1011
+ export interface DeleteDocumentRequest {
990
1012
  /**
991
- * @internal
1013
+ * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
992
1014
  */
993
- constructor(opts: __ExceptionOptionType<ConcurrentModificationException, __BaseException>);
1015
+ AuthenticationToken?: string;
1016
+ /**
1017
+ * <p>The ID of the document.</p>
1018
+ */
1019
+ DocumentId: string | undefined;
994
1020
  }
995
- export interface DeleteDocumentRequest {
1021
+ export interface DeleteDocumentVersionRequest {
996
1022
  /**
997
1023
  * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
998
1024
  */
999
1025
  AuthenticationToken?: string;
1000
1026
  /**
1001
- * <p>The ID of the document.</p>
1027
+ * <p>The ID of a document.</p>
1002
1028
  */
1003
1029
  DocumentId: string | undefined;
1030
+ /**
1031
+ * <p>The version ID of a document.</p>
1032
+ */
1033
+ VersionId: string | undefined;
1034
+ /**
1035
+ * <p>When set to <code>TRUE</code>, deletes the specified version and <i>all prior versions</i> of a document.</p>
1036
+ */
1037
+ DeletePriorVersions: boolean | undefined;
1038
+ }
1039
+ /**
1040
+ * <p>The operation is invalid.</p>
1041
+ */
1042
+ export declare class InvalidOperationException extends __BaseException {
1043
+ readonly name: "InvalidOperationException";
1044
+ readonly $fault: "client";
1045
+ Message?: string;
1046
+ /**
1047
+ * @internal
1048
+ */
1049
+ constructor(opts: __ExceptionOptionType<InvalidOperationException, __BaseException>);
1004
1050
  }
1005
1051
  export interface DeleteFolderRequest {
1006
1052
  /**
@@ -1124,18 +1170,6 @@ export interface DescribeActivitiesResponse {
1124
1170
  */
1125
1171
  Marker?: string;
1126
1172
  }
1127
- /**
1128
- * <p>The pagination marker or limit fields are not valid.</p>
1129
- */
1130
- export declare class InvalidArgumentException extends __BaseException {
1131
- readonly name: "InvalidArgumentException";
1132
- readonly $fault: "client";
1133
- Message?: string;
1134
- /**
1135
- * @internal
1136
- */
1137
- constructor(opts: __ExceptionOptionType<InvalidArgumentException, __BaseException>);
1138
- }
1139
1173
  export interface DescribeCommentsRequest {
1140
1174
  /**
1141
1175
  * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
@@ -1280,6 +1314,18 @@ export interface DescribeDocumentVersionsResponse {
1280
1314
  */
1281
1315
  Marker?: string;
1282
1316
  }
1317
+ /**
1318
+ * <p>The password is invalid.</p>
1319
+ */
1320
+ export declare class InvalidPasswordException extends __BaseException {
1321
+ readonly name: "InvalidPasswordException";
1322
+ readonly $fault: "client";
1323
+ Message?: string;
1324
+ /**
1325
+ * @internal
1326
+ */
1327
+ constructor(opts: __ExceptionOptionType<InvalidPasswordException, __BaseException>);
1328
+ }
1283
1329
  export declare enum OrderType {
1284
1330
  ASCENDING = "ASCENDING",
1285
1331
  DESCENDING = "DESCENDING"
@@ -1559,7 +1605,24 @@ export interface DescribeUsersRequest {
1559
1605
  */
1560
1606
  UserIds?: string;
1561
1607
  /**
1562
- * <p>A query to filter users by user name.</p>
1608
+ * <p>A query to filter users by user name. Remember the following about the <code>Userids</code> and <code>Query</code> parameters:</p>
1609
+ * <ul>
1610
+ * <li>
1611
+ * <p>If you don't use either parameter, the API returns a paginated list of all users on the site.</p>
1612
+ * </li>
1613
+ * <li>
1614
+ * <p>If you use both parameters, the API ignores the <code>Query</code> parameter.</p>
1615
+ * </li>
1616
+ * <li>
1617
+ * <p>The <code>Userid</code> parameter only returns user names that match a corresponding user ID.</p>
1618
+ * </li>
1619
+ * <li>
1620
+ * <p>The <code>Query</code> parameter runs a "prefix" search for users by the <code>GivenName</code>, <code>SurName</code>, or <code>UserName</code> fields included in a
1621
+ * <a href="https://docs.aws.amazon.com/workdocs/latest/APIReference/API_CreateUser.html">CreateUser</a> API call. For example, querying on
1622
+ * <code>Ma</code> returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on <code>Ma J</code> only
1623
+ * returns Mateo Jackson.</p>
1624
+ * </li>
1625
+ * </ul>
1563
1626
  */
1564
1627
  Query?: string;
1565
1628
  /**
@@ -1654,18 +1717,6 @@ export interface GetDocumentResponse {
1654
1717
  */
1655
1718
  CustomMetadata?: Record<string, string>;
1656
1719
  }
1657
- /**
1658
- * <p>The password is invalid.</p>
1659
- */
1660
- export declare class InvalidPasswordException extends __BaseException {
1661
- readonly name: "InvalidPasswordException";
1662
- readonly $fault: "client";
1663
- Message?: string;
1664
- /**
1665
- * @internal
1666
- */
1667
- constructor(opts: __ExceptionOptionType<InvalidPasswordException, __BaseException>);
1668
- }
1669
1720
  export interface GetDocumentPathRequest {
1670
1721
  /**
1671
1722
  * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
@@ -1888,7 +1939,7 @@ export interface InitiateDocumentVersionUploadRequest {
1888
1939
  /**
1889
1940
  * <p>The ID of the parent folder.</p>
1890
1941
  */
1891
- ParentFolderId: string | undefined;
1942
+ ParentFolderId?: string;
1892
1943
  }
1893
1944
  /**
1894
1945
  * <p>Describes the upload.</p>
@@ -1977,6 +2028,16 @@ export interface RemoveResourcePermissionRequest {
1977
2028
  */
1978
2029
  PrincipalType?: PrincipalType | string;
1979
2030
  }
2031
+ export interface RestoreDocumentVersionsRequest {
2032
+ /**
2033
+ * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
2034
+ */
2035
+ AuthenticationToken?: string;
2036
+ /**
2037
+ * <p>The ID of the document.</p>
2038
+ */
2039
+ DocumentId: string | undefined;
2040
+ }
1980
2041
  export interface UpdateDocumentRequest {
1981
2042
  /**
1982
2043
  * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
@@ -2000,18 +2061,6 @@ export interface UpdateDocumentRequest {
2000
2061
  */
2001
2062
  ResourceState?: ResourceStateType | string;
2002
2063
  }
2003
- /**
2004
- * <p>The operation is invalid.</p>
2005
- */
2006
- export declare class InvalidOperationException extends __BaseException {
2007
- readonly name: "InvalidOperationException";
2008
- readonly $fault: "client";
2009
- Message?: string;
2010
- /**
2011
- * @internal
2012
- */
2013
- constructor(opts: __ExceptionOptionType<InvalidOperationException, __BaseException>);
2014
- }
2015
2064
  export declare enum DocumentVersionStatus {
2016
2065
  ACTIVE = "ACTIVE"
2017
2066
  }
@@ -2277,6 +2326,10 @@ export declare const DeleteCustomMetadataResponseFilterSensitiveLog: (obj: Delet
2277
2326
  * @internal
2278
2327
  */
2279
2328
  export declare const DeleteDocumentRequestFilterSensitiveLog: (obj: DeleteDocumentRequest) => any;
2329
+ /**
2330
+ * @internal
2331
+ */
2332
+ export declare const DeleteDocumentVersionRequestFilterSensitiveLog: (obj: DeleteDocumentVersionRequest) => any;
2280
2333
  /**
2281
2334
  * @internal
2282
2335
  */
@@ -2473,6 +2526,10 @@ export declare const RemoveAllResourcePermissionsRequestFilterSensitiveLog: (obj
2473
2526
  * @internal
2474
2527
  */
2475
2528
  export declare const RemoveResourcePermissionRequestFilterSensitiveLog: (obj: RemoveResourcePermissionRequest) => any;
2529
+ /**
2530
+ * @internal
2531
+ */
2532
+ export declare const RestoreDocumentVersionsRequestFilterSensitiveLog: (obj: RestoreDocumentVersionsRequest) => any;
2476
2533
  /**
2477
2534
  * @internal
2478
2535
  */
@@ -13,6 +13,7 @@ import { DeactivateUserCommandInput, DeactivateUserCommandOutput } from "../comm
13
13
  import { DeleteCommentCommandInput, DeleteCommentCommandOutput } from "../commands/DeleteCommentCommand";
14
14
  import { DeleteCustomMetadataCommandInput, DeleteCustomMetadataCommandOutput } from "../commands/DeleteCustomMetadataCommand";
15
15
  import { DeleteDocumentCommandInput, DeleteDocumentCommandOutput } from "../commands/DeleteDocumentCommand";
16
+ import { DeleteDocumentVersionCommandInput, DeleteDocumentVersionCommandOutput } from "../commands/DeleteDocumentVersionCommand";
16
17
  import { DeleteFolderCommandInput, DeleteFolderCommandOutput } from "../commands/DeleteFolderCommand";
17
18
  import { DeleteFolderContentsCommandInput, DeleteFolderContentsCommandOutput } from "../commands/DeleteFolderContentsCommand";
18
19
  import { DeleteLabelsCommandInput, DeleteLabelsCommandOutput } from "../commands/DeleteLabelsCommand";
@@ -37,6 +38,7 @@ import { GetResourcesCommandInput, GetResourcesCommandOutput } from "../commands
37
38
  import { InitiateDocumentVersionUploadCommandInput, InitiateDocumentVersionUploadCommandOutput } from "../commands/InitiateDocumentVersionUploadCommand";
38
39
  import { RemoveAllResourcePermissionsCommandInput, RemoveAllResourcePermissionsCommandOutput } from "../commands/RemoveAllResourcePermissionsCommand";
39
40
  import { RemoveResourcePermissionCommandInput, RemoveResourcePermissionCommandOutput } from "../commands/RemoveResourcePermissionCommand";
41
+ import { RestoreDocumentVersionsCommandInput, RestoreDocumentVersionsCommandOutput } from "../commands/RestoreDocumentVersionsCommand";
40
42
  import { UpdateDocumentCommandInput, UpdateDocumentCommandOutput } from "../commands/UpdateDocumentCommand";
41
43
  import { UpdateDocumentVersionCommandInput, UpdateDocumentVersionCommandOutput } from "../commands/UpdateDocumentVersionCommand";
42
44
  import { UpdateFolderCommandInput, UpdateFolderCommandOutput } from "../commands/UpdateFolderCommand";
@@ -54,6 +56,7 @@ export declare const serializeAws_restJson1DeactivateUserCommand: (input: Deacti
54
56
  export declare const serializeAws_restJson1DeleteCommentCommand: (input: DeleteCommentCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
55
57
  export declare const serializeAws_restJson1DeleteCustomMetadataCommand: (input: DeleteCustomMetadataCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
56
58
  export declare const serializeAws_restJson1DeleteDocumentCommand: (input: DeleteDocumentCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
59
+ export declare const serializeAws_restJson1DeleteDocumentVersionCommand: (input: DeleteDocumentVersionCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
57
60
  export declare const serializeAws_restJson1DeleteFolderCommand: (input: DeleteFolderCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
58
61
  export declare const serializeAws_restJson1DeleteFolderContentsCommand: (input: DeleteFolderContentsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
59
62
  export declare const serializeAws_restJson1DeleteLabelsCommand: (input: DeleteLabelsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
@@ -78,6 +81,7 @@ export declare const serializeAws_restJson1GetResourcesCommand: (input: GetResou
78
81
  export declare const serializeAws_restJson1InitiateDocumentVersionUploadCommand: (input: InitiateDocumentVersionUploadCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
79
82
  export declare const serializeAws_restJson1RemoveAllResourcePermissionsCommand: (input: RemoveAllResourcePermissionsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
80
83
  export declare const serializeAws_restJson1RemoveResourcePermissionCommand: (input: RemoveResourcePermissionCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
84
+ export declare const serializeAws_restJson1RestoreDocumentVersionsCommand: (input: RestoreDocumentVersionsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
81
85
  export declare const serializeAws_restJson1UpdateDocumentCommand: (input: UpdateDocumentCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
82
86
  export declare const serializeAws_restJson1UpdateDocumentVersionCommand: (input: UpdateDocumentVersionCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
83
87
  export declare const serializeAws_restJson1UpdateFolderCommand: (input: UpdateFolderCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
@@ -95,6 +99,7 @@ export declare const deserializeAws_restJson1DeactivateUserCommand: (output: __H
95
99
  export declare const deserializeAws_restJson1DeleteCommentCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteCommentCommandOutput>;
96
100
  export declare const deserializeAws_restJson1DeleteCustomMetadataCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteCustomMetadataCommandOutput>;
97
101
  export declare const deserializeAws_restJson1DeleteDocumentCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteDocumentCommandOutput>;
102
+ export declare const deserializeAws_restJson1DeleteDocumentVersionCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteDocumentVersionCommandOutput>;
98
103
  export declare const deserializeAws_restJson1DeleteFolderCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteFolderCommandOutput>;
99
104
  export declare const deserializeAws_restJson1DeleteFolderContentsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteFolderContentsCommandOutput>;
100
105
  export declare const deserializeAws_restJson1DeleteLabelsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteLabelsCommandOutput>;
@@ -119,6 +124,7 @@ export declare const deserializeAws_restJson1GetResourcesCommand: (output: __Htt
119
124
  export declare const deserializeAws_restJson1InitiateDocumentVersionUploadCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<InitiateDocumentVersionUploadCommandOutput>;
120
125
  export declare const deserializeAws_restJson1RemoveAllResourcePermissionsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<RemoveAllResourcePermissionsCommandOutput>;
121
126
  export declare const deserializeAws_restJson1RemoveResourcePermissionCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<RemoveResourcePermissionCommandOutput>;
127
+ export declare const deserializeAws_restJson1RestoreDocumentVersionsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<RestoreDocumentVersionsCommandOutput>;
122
128
  export declare const deserializeAws_restJson1UpdateDocumentCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateDocumentCommandOutput>;
123
129
  export declare const deserializeAws_restJson1UpdateDocumentVersionCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateDocumentVersionCommandOutput>;
124
130
  export declare const deserializeAws_restJson1UpdateFolderCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateFolderCommandOutput>;
@@ -51,6 +51,10 @@ import {
51
51
  DeleteDocumentCommandInput,
52
52
  DeleteDocumentCommandOutput,
53
53
  } from "./commands/DeleteDocumentCommand";
54
+ import {
55
+ DeleteDocumentVersionCommandInput,
56
+ DeleteDocumentVersionCommandOutput,
57
+ } from "./commands/DeleteDocumentVersionCommand";
54
58
  import {
55
59
  DeleteFolderCommandInput,
56
60
  DeleteFolderCommandOutput,
@@ -147,6 +151,10 @@ import {
147
151
  RemoveResourcePermissionCommandInput,
148
152
  RemoveResourcePermissionCommandOutput,
149
153
  } from "./commands/RemoveResourcePermissionCommand";
154
+ import {
155
+ RestoreDocumentVersionsCommandInput,
156
+ RestoreDocumentVersionsCommandOutput,
157
+ } from "./commands/RestoreDocumentVersionsCommand";
150
158
  import {
151
159
  UpdateDocumentCommandInput,
152
160
  UpdateDocumentCommandOutput,
@@ -334,6 +342,19 @@ export declare class WorkDocs extends WorkDocsClient {
334
342
  options: __HttpHandlerOptions,
335
343
  cb: (err: any, data?: DeleteDocumentCommandOutput) => void
336
344
  ): void;
345
+ deleteDocumentVersion(
346
+ args: DeleteDocumentVersionCommandInput,
347
+ options?: __HttpHandlerOptions
348
+ ): Promise<DeleteDocumentVersionCommandOutput>;
349
+ deleteDocumentVersion(
350
+ args: DeleteDocumentVersionCommandInput,
351
+ cb: (err: any, data?: DeleteDocumentVersionCommandOutput) => void
352
+ ): void;
353
+ deleteDocumentVersion(
354
+ args: DeleteDocumentVersionCommandInput,
355
+ options: __HttpHandlerOptions,
356
+ cb: (err: any, data?: DeleteDocumentVersionCommandOutput) => void
357
+ ): void;
337
358
  deleteFolder(
338
359
  args: DeleteFolderCommandInput,
339
360
  options?: __HttpHandlerOptions
@@ -652,6 +673,19 @@ export declare class WorkDocs extends WorkDocsClient {
652
673
  options: __HttpHandlerOptions,
653
674
  cb: (err: any, data?: RemoveResourcePermissionCommandOutput) => void
654
675
  ): void;
676
+ restoreDocumentVersions(
677
+ args: RestoreDocumentVersionsCommandInput,
678
+ options?: __HttpHandlerOptions
679
+ ): Promise<RestoreDocumentVersionsCommandOutput>;
680
+ restoreDocumentVersions(
681
+ args: RestoreDocumentVersionsCommandInput,
682
+ cb: (err: any, data?: RestoreDocumentVersionsCommandOutput) => void
683
+ ): void;
684
+ restoreDocumentVersions(
685
+ args: RestoreDocumentVersionsCommandInput,
686
+ options: __HttpHandlerOptions,
687
+ cb: (err: any, data?: RestoreDocumentVersionsCommandOutput) => void
688
+ ): void;
655
689
  updateDocument(
656
690
  args: UpdateDocumentCommandInput,
657
691
  options?: __HttpHandlerOptions
@@ -95,6 +95,10 @@ import {
95
95
  DeleteDocumentCommandInput,
96
96
  DeleteDocumentCommandOutput,
97
97
  } from "./commands/DeleteDocumentCommand";
98
+ import {
99
+ DeleteDocumentVersionCommandInput,
100
+ DeleteDocumentVersionCommandOutput,
101
+ } from "./commands/DeleteDocumentVersionCommand";
98
102
  import {
99
103
  DeleteFolderCommandInput,
100
104
  DeleteFolderCommandOutput,
@@ -191,6 +195,10 @@ import {
191
195
  RemoveResourcePermissionCommandInput,
192
196
  RemoveResourcePermissionCommandOutput,
193
197
  } from "./commands/RemoveResourcePermissionCommand";
198
+ import {
199
+ RestoreDocumentVersionsCommandInput,
200
+ RestoreDocumentVersionsCommandOutput,
201
+ } from "./commands/RestoreDocumentVersionsCommand";
194
202
  import {
195
203
  UpdateDocumentCommandInput,
196
204
  UpdateDocumentCommandOutput,
@@ -226,6 +234,7 @@ export declare type ServiceInputTypes =
226
234
  | DeleteCommentCommandInput
227
235
  | DeleteCustomMetadataCommandInput
228
236
  | DeleteDocumentCommandInput
237
+ | DeleteDocumentVersionCommandInput
229
238
  | DeleteFolderCommandInput
230
239
  | DeleteFolderContentsCommandInput
231
240
  | DeleteLabelsCommandInput
@@ -250,6 +259,7 @@ export declare type ServiceInputTypes =
250
259
  | InitiateDocumentVersionUploadCommandInput
251
260
  | RemoveAllResourcePermissionsCommandInput
252
261
  | RemoveResourcePermissionCommandInput
262
+ | RestoreDocumentVersionsCommandInput
253
263
  | UpdateDocumentCommandInput
254
264
  | UpdateDocumentVersionCommandInput
255
265
  | UpdateFolderCommandInput
@@ -268,6 +278,7 @@ export declare type ServiceOutputTypes =
268
278
  | DeleteCommentCommandOutput
269
279
  | DeleteCustomMetadataCommandOutput
270
280
  | DeleteDocumentCommandOutput
281
+ | DeleteDocumentVersionCommandOutput
271
282
  | DeleteFolderCommandOutput
272
283
  | DeleteFolderContentsCommandOutput
273
284
  | DeleteLabelsCommandOutput
@@ -292,6 +303,7 @@ export declare type ServiceOutputTypes =
292
303
  | InitiateDocumentVersionUploadCommandOutput
293
304
  | RemoveAllResourcePermissionsCommandOutput
294
305
  | RemoveResourcePermissionCommandOutput
306
+ | RestoreDocumentVersionsCommandOutput
295
307
  | UpdateDocumentCommandOutput
296
308
  | UpdateDocumentVersionCommandOutput
297
309
  | UpdateFolderCommandOutput
@@ -0,0 +1,36 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import {
4
+ Handler,
5
+ HttpHandlerOptions as __HttpHandlerOptions,
6
+ MetadataBearer as __MetadataBearer,
7
+ MiddlewareStack,
8
+ } from "@aws-sdk/types";
9
+ import { DeleteDocumentVersionRequest } from "../models/models_0";
10
+ import {
11
+ ServiceInputTypes,
12
+ ServiceOutputTypes,
13
+ WorkDocsClientResolvedConfig,
14
+ } from "../WorkDocsClient";
15
+ export interface DeleteDocumentVersionCommandInput
16
+ extends DeleteDocumentVersionRequest {}
17
+ export interface DeleteDocumentVersionCommandOutput extends __MetadataBearer {}
18
+ export declare class DeleteDocumentVersionCommand extends $Command<
19
+ DeleteDocumentVersionCommandInput,
20
+ DeleteDocumentVersionCommandOutput,
21
+ WorkDocsClientResolvedConfig
22
+ > {
23
+ readonly input: DeleteDocumentVersionCommandInput;
24
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
25
+ constructor(input: DeleteDocumentVersionCommandInput);
26
+ resolveMiddleware(
27
+ clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
28
+ configuration: WorkDocsClientResolvedConfig,
29
+ options?: __HttpHandlerOptions
30
+ ): Handler<
31
+ DeleteDocumentVersionCommandInput,
32
+ DeleteDocumentVersionCommandOutput
33
+ >;
34
+ private serialize;
35
+ private deserialize;
36
+ }