@aws-sdk/client-workdocs 3.267.0 → 3.268.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.
package/README.md CHANGED
@@ -9,7 +9,7 @@
9
9
 
10
10
  AWS SDK for JavaScript WorkDocs Client for Node.js, Browser and React Native.
11
11
 
12
- <p>The WorkDocs API is designed for the following use cases:</p>
12
+ <p>The Amazon WorkDocs API is designed for the following use cases:</p>
13
13
  <ul>
14
14
  <li>
15
15
  <p>File Migration: File migration applications are supported for users who
@@ -21,7 +21,7 @@ files.</p>
21
21
  <li>
22
22
  <p>Security: Support security applications are supported for users who have
23
23
  additional security needs, such as antivirus or data loss prevention. The API
24
- actions, along with AWS CloudTrail, allow these applications to detect when
24
+ actions, along with CloudTrail, allow these applications to detect when
25
25
  changes occur in Amazon WorkDocs. Then, the application can take the necessary
26
26
  actions and replace the target file. If the target file violates the policy, the
27
27
  application can also choose to email the user.</p>
@@ -29,15 +29,15 @@ application can also choose to email the user.</p>
29
29
  <li>
30
30
  <p>eDiscovery/Analytics: General administrative applications are supported,
31
31
  such as eDiscovery and analytics. These applications can choose to mimic or
32
- record the actions in an Amazon WorkDocs site, along with AWS CloudTrail, to
32
+ record the actions in an Amazon WorkDocs site, along with CloudTrail, to
33
33
  replicate data for eDiscovery, backup, or analytical applications.</p>
34
34
  </li>
35
35
  </ul>
36
36
  <p>All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed.
37
- They not only require the use of the AWS SDK, but also allow for the exclusive use of
37
+ They not only require the use of the Amazon Web Services SDK, but also allow for the exclusive use of
38
38
  IAM users and roles to help facilitate access, trust, and permission policies. By
39
- creating a role and allowing an IAM user to access the Amazon WorkDocs site, the IAM
40
- user gains full administrative visibility into the entire Amazon WorkDocs site (or as
39
+ creating a role and allowing an IAM user to access the Amazon WorkDocs site, the
40
+ IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as
41
41
  set in the IAM policy). This includes, but is not limited to, the ability to modify file
42
42
  permissions and upload any file to any user. This allows developers to perform the three
43
43
  use cases above, as well as give users the ability to grant access on a selective basis
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.ruleSet = void 0;
4
- const p = "required", q = "fn", r = "argv", s = "ref";
5
- const a = "PartitionResult", b = "tree", c = "error", d = "endpoint", e = { [p]: false, "type": "String" }, f = { [p]: true, "default": false, "type": "Boolean" }, g = { [s]: "Endpoint" }, h = { [q]: "booleanEquals", [r]: [{ [s]: "UseFIPS" }, true] }, i = { [q]: "booleanEquals", [r]: [{ [s]: "UseDualStack" }, true] }, j = {}, k = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: a }, "supportsFIPS"] }] }, l = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: a }, "supportsDualStack"] }] }, m = [g], n = [h], o = [i];
6
- const _data = { version: "1.0", parameters: { Region: e, UseDualStack: f, UseFIPS: f, Endpoint: e }, rules: [{ conditions: [{ [q]: "aws.partition", [r]: [{ [s]: "Region" }], assign: a }], type: b, rules: [{ conditions: [{ [q]: "isSet", [r]: m }, { [q]: "parseURL", [r]: m, assign: "url" }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: g, properties: j, headers: j }, type: d }] }] }, { conditions: [h, i], type: b, rules: [{ conditions: [k, l], type: b, rules: [{ endpoint: { url: "https://workdocs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: j, headers: j }, type: d }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [k], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://workdocs-fips.{Region}.{PartitionResult#dnsSuffix}", properties: j, headers: j }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [l], type: b, rules: [{ endpoint: { url: "https://workdocs.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: j, headers: j }, type: d }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { endpoint: { url: "https://workdocs.{Region}.{PartitionResult#dnsSuffix}", properties: j, headers: j }, type: d }] }] };
4
+ const q = "fn", r = "argv", s = "ref";
5
+ const a = true, b = false, c = "String", d = "PartitionResult", e = "tree", f = "error", g = "endpoint", h = { "required": true, "default": false, "type": "Boolean" }, i = { [s]: "Endpoint" }, j = { [q]: "booleanEquals", [r]: [{ [s]: "UseFIPS" }, true] }, k = { [q]: "booleanEquals", [r]: [{ [s]: "UseDualStack" }, true] }, l = {}, m = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: d }, "supportsFIPS"] }] }, n = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: d }, "supportsDualStack"] }] }, o = [j], p = [k];
6
+ const _data = { version: "1.0", parameters: { Region: { required: a, type: c }, UseDualStack: h, UseFIPS: h, Endpoint: { required: b, type: c } }, rules: [{ conditions: [{ [q]: "aws.partition", [r]: [{ [s]: "Region" }], assign: d }], type: e, rules: [{ conditions: [{ [q]: "isSet", [r]: [i] }], type: e, rules: [{ conditions: o, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: f }, { type: e, rules: [{ conditions: p, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: f }, { endpoint: { url: i, properties: l, headers: l }, type: g }] }] }, { conditions: [j, k], type: e, rules: [{ conditions: [m, n], type: e, rules: [{ type: e, rules: [{ endpoint: { url: "https://workdocs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: g }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: f }] }, { conditions: o, type: e, rules: [{ conditions: [m], type: e, rules: [{ type: e, rules: [{ endpoint: { url: "https://workdocs-fips.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: g }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: f }] }, { conditions: p, type: e, rules: [{ conditions: [n], type: e, rules: [{ type: e, rules: [{ endpoint: { url: "https://workdocs.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: g }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: f }] }, { type: e, rules: [{ endpoint: { url: "https://workdocs.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: g }] }] }] };
7
7
  exports.ruleSet = _data;
@@ -1,4 +1,4 @@
1
- const p = "required", q = "fn", r = "argv", s = "ref";
2
- const a = "PartitionResult", b = "tree", c = "error", d = "endpoint", e = { [p]: false, "type": "String" }, f = { [p]: true, "default": false, "type": "Boolean" }, g = { [s]: "Endpoint" }, h = { [q]: "booleanEquals", [r]: [{ [s]: "UseFIPS" }, true] }, i = { [q]: "booleanEquals", [r]: [{ [s]: "UseDualStack" }, true] }, j = {}, k = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: a }, "supportsFIPS"] }] }, l = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: a }, "supportsDualStack"] }] }, m = [g], n = [h], o = [i];
3
- const _data = { version: "1.0", parameters: { Region: e, UseDualStack: f, UseFIPS: f, Endpoint: e }, rules: [{ conditions: [{ [q]: "aws.partition", [r]: [{ [s]: "Region" }], assign: a }], type: b, rules: [{ conditions: [{ [q]: "isSet", [r]: m }, { [q]: "parseURL", [r]: m, assign: "url" }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: g, properties: j, headers: j }, type: d }] }] }, { conditions: [h, i], type: b, rules: [{ conditions: [k, l], type: b, rules: [{ endpoint: { url: "https://workdocs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: j, headers: j }, type: d }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [k], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://workdocs-fips.{Region}.{PartitionResult#dnsSuffix}", properties: j, headers: j }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [l], type: b, rules: [{ endpoint: { url: "https://workdocs.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: j, headers: j }, type: d }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { endpoint: { url: "https://workdocs.{Region}.{PartitionResult#dnsSuffix}", properties: j, headers: j }, type: d }] }] };
1
+ const q = "fn", r = "argv", s = "ref";
2
+ const a = true, b = false, c = "String", d = "PartitionResult", e = "tree", f = "error", g = "endpoint", h = { "required": true, "default": false, "type": "Boolean" }, i = { [s]: "Endpoint" }, j = { [q]: "booleanEquals", [r]: [{ [s]: "UseFIPS" }, true] }, k = { [q]: "booleanEquals", [r]: [{ [s]: "UseDualStack" }, true] }, l = {}, m = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: d }, "supportsFIPS"] }] }, n = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: d }, "supportsDualStack"] }] }, o = [j], p = [k];
3
+ const _data = { version: "1.0", parameters: { Region: { required: a, type: c }, UseDualStack: h, UseFIPS: h, Endpoint: { required: b, type: c } }, rules: [{ conditions: [{ [q]: "aws.partition", [r]: [{ [s]: "Region" }], assign: d }], type: e, rules: [{ conditions: [{ [q]: "isSet", [r]: [i] }], type: e, rules: [{ conditions: o, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: f }, { type: e, rules: [{ conditions: p, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: f }, { endpoint: { url: i, properties: l, headers: l }, type: g }] }] }, { conditions: [j, k], type: e, rules: [{ conditions: [m, n], type: e, rules: [{ type: e, rules: [{ endpoint: { url: "https://workdocs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: g }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: f }] }, { conditions: o, type: e, rules: [{ conditions: [m], type: e, rules: [{ type: e, rules: [{ endpoint: { url: "https://workdocs-fips.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: g }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: f }] }, { conditions: p, type: e, rules: [{ conditions: [n], type: e, rules: [{ type: e, rules: [{ endpoint: { url: "https://workdocs.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: g }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: f }] }, { type: e, rules: [{ endpoint: { url: "https://workdocs.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: g }] }] }] };
4
4
  export const ruleSet = _data;
@@ -44,40 +44,40 @@ import { UpdateFolderCommandInput, UpdateFolderCommandOutput } from "./commands/
44
44
  import { UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand";
45
45
  import { WorkDocsClient } from "./WorkDocsClient";
46
46
  /**
47
- * <p>The WorkDocs API is designed for the following use cases:</p>
48
- * <ul>
47
+ * <p>The Amazon WorkDocs API is designed for the following use cases:</p>
48
+ * <ul>
49
49
  * <li>
50
- * <p>File Migration: File migration applications are supported for users who
50
+ * <p>File Migration: File migration applications are supported for users who
51
51
  * want to migrate their files from an on-premises or off-premises file system or
52
52
  * service. Users can insert files into a user directory structure, as well as
53
53
  * allow for basic metadata changes, such as modifications to the permissions of
54
54
  * files.</p>
55
55
  * </li>
56
56
  * <li>
57
- * <p>Security: Support security applications are supported for users who have
57
+ * <p>Security: Support security applications are supported for users who have
58
58
  * additional security needs, such as antivirus or data loss prevention. The API
59
- * actions, along with AWS CloudTrail, allow these applications to detect when
59
+ * actions, along with CloudTrail, allow these applications to detect when
60
60
  * changes occur in Amazon WorkDocs. Then, the application can take the necessary
61
61
  * actions and replace the target file. If the target file violates the policy, the
62
62
  * application can also choose to email the user.</p>
63
63
  * </li>
64
64
  * <li>
65
- * <p>eDiscovery/Analytics: General administrative applications are supported,
65
+ * <p>eDiscovery/Analytics: General administrative applications are supported,
66
66
  * such as eDiscovery and analytics. These applications can choose to mimic or
67
- * record the actions in an Amazon WorkDocs site, along with AWS CloudTrail, to
67
+ * record the actions in an Amazon WorkDocs site, along with CloudTrail, to
68
68
  * replicate data for eDiscovery, backup, or analytical applications.</p>
69
69
  * </li>
70
70
  * </ul>
71
- * <p>All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed.
72
- * They not only require the use of the AWS SDK, but also allow for the exclusive use of
71
+ * <p>All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed.
72
+ * They not only require the use of the Amazon Web Services SDK, but also allow for the exclusive use of
73
73
  * IAM users and roles to help facilitate access, trust, and permission policies. By
74
- * creating a role and allowing an IAM user to access the Amazon WorkDocs site, the IAM
75
- * user gains full administrative visibility into the entire Amazon WorkDocs site (or as
74
+ * creating a role and allowing an IAM user to access the Amazon WorkDocs site, the
75
+ * IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as
76
76
  * set in the IAM policy). This includes, but is not limited to, the ability to modify file
77
77
  * permissions and upload any file to any user. This allows developers to perform the three
78
78
  * use cases above, as well as give users the ability to grant access on a selective basis
79
79
  * using the IAM model.</p>
80
- * <note>
80
+ * <note>
81
81
  * <p>The pricing for Amazon WorkDocs APIs varies depending on the API call type for these actions:</p>
82
82
  * <ul>
83
83
  * <li>
@@ -102,7 +102,7 @@ import { WorkDocsClient } from "./WorkDocsClient";
102
102
  * </li>
103
103
  * </ul>
104
104
  * <p>For information about Amazon WorkDocs API pricing, see <a href="https://aws.amazon.com/workdocs/pricing/">Amazon WorkDocs Pricing</a>.</p>
105
- * </note>
105
+ * </note>
106
106
  */
107
107
  export declare class WorkDocs extends WorkDocsClient {
108
108
  /**
@@ -158,7 +158,7 @@ export declare class WorkDocs extends WorkDocsClient {
158
158
  /**
159
159
  * <p>Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a
160
160
  * confirmation message, and must confirm the subscription.</p>
161
- * <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
161
+ * <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
162
162
  * Guide</i>.</p>
163
163
  */
164
164
  createNotificationSubscription(args: CreateNotificationSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<CreateNotificationSubscriptionCommandOutput>;
@@ -197,7 +197,7 @@ export declare class WorkDocs extends WorkDocsClient {
197
197
  deleteDocument(args: DeleteDocumentCommandInput, cb: (err: any, data?: DeleteDocumentCommandOutput) => void): void;
198
198
  deleteDocument(args: DeleteDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDocumentCommandOutput) => void): void;
199
199
  /**
200
- * <p>Deletes a version of an Amazon WorkDocs document. Use the <code>DeletePriorVersions</code> parameter to delete prior versions.</p>
200
+ * <p>Deletes a specific version of a document.</p>
201
201
  */
202
202
  deleteDocumentVersion(args: DeleteDocumentVersionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDocumentVersionCommandOutput>;
203
203
  deleteDocumentVersion(args: DeleteDocumentVersionCommandInput, cb: (err: any, data?: DeleteDocumentVersionCommandOutput) => void): void;
@@ -228,6 +228,9 @@ export declare class WorkDocs extends WorkDocsClient {
228
228
  deleteNotificationSubscription(args: DeleteNotificationSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNotificationSubscriptionCommandOutput) => void): void;
229
229
  /**
230
230
  * <p>Deletes the specified user from a Simple AD or Microsoft AD directory.</p>
231
+ * <important>
232
+ * <p>Deleting a user immediately and permanently deletes all content in that user's folder structure. Site retention policies do NOT apply to this type of deletion.</p>
233
+ * </important>
231
234
  */
232
235
  deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise<DeleteUserCommandOutput>;
233
236
  deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void;
@@ -246,7 +249,7 @@ export declare class WorkDocs extends WorkDocsClient {
246
249
  describeComments(args: DescribeCommentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCommentsCommandOutput) => void): void;
247
250
  /**
248
251
  * <p>Retrieves the document versions for the specified document.</p>
249
- * <p>By default, only active versions are returned.</p>
252
+ * <p>By default, only active versions are returned.</p>
250
253
  */
251
254
  describeDocumentVersions(args: DescribeDocumentVersionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDocumentVersionsCommandOutput>;
252
255
  describeDocumentVersions(args: DescribeDocumentVersionsCommandInput, cb: (err: any, data?: DescribeDocumentVersionsCommandOutput) => void): void;
@@ -254,7 +257,7 @@ export declare class WorkDocs extends WorkDocsClient {
254
257
  /**
255
258
  * <p>Describes the contents of the specified folder, including its documents and
256
259
  * subfolders.</p>
257
- * <p>By default, Amazon WorkDocs returns the first 100 active document and folder
260
+ * <p>By default, Amazon WorkDocs returns the first 100 active document and folder
258
261
  * metadata items. If there are more results, the response includes a marker that you can
259
262
  * use to request the next set of results. You can also request initialized
260
263
  * documents.</p>
@@ -286,7 +289,7 @@ export declare class WorkDocs extends WorkDocsClient {
286
289
  * <code>RecycleBin</code>. <code>RootFolder</code> is the root of user's files and
287
290
  * folders and <code>RecycleBin</code> is the root of recycled items. This is not a valid
288
291
  * action for SigV4 (administrative API) clients.</p>
289
- * <p>This action requires an authentication token. To get an authentication token,
292
+ * <p>This action requires an authentication token. To get an authentication token,
290
293
  * register an application with Amazon WorkDocs. For more information, see <a href="https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html">Authentication and Access
291
294
  * Control for User Applications</a> in the
292
295
  * <i>Amazon
@@ -298,7 +301,7 @@ export declare class WorkDocs extends WorkDocsClient {
298
301
  /**
299
302
  * <p>Describes the specified users. You can describe all users or filter the results
300
303
  * (for example, by status or organization).</p>
301
- * <p>By default, Amazon WorkDocs returns the first 24 active or pending users. If there
304
+ * <p>By default, Amazon WorkDocs returns the first 24 active or pending users. If there
302
305
  * are more results, the response includes a marker that you can use to request the next
303
306
  * set of results.</p>
304
307
  */
@@ -308,7 +311,7 @@ export declare class WorkDocs extends WorkDocsClient {
308
311
  /**
309
312
  * <p>Retrieves details of the current user for whom the authentication token was
310
313
  * generated. This is not a valid action for SigV4 (administrative API) clients.</p>
311
- * <p>This action requires an authentication token. To get an authentication token,
314
+ * <p>This action requires an authentication token. To get an authentication token,
312
315
  * register an application with Amazon WorkDocs. For more information, see <a href="https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html">Authentication and Access
313
316
  * Control for User Applications</a> in the
314
317
  * <i>Amazon
@@ -326,7 +329,7 @@ export declare class WorkDocs extends WorkDocsClient {
326
329
  /**
327
330
  * <p>Retrieves the path information (the hierarchy from the root folder) for the
328
331
  * requested document.</p>
329
- * <p>By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the
332
+ * <p>By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the
330
333
  * requested document and only includes the IDs of the parent folders in the path. You can
331
334
  * limit the maximum number of levels. You can also request the names of the parent
332
335
  * folders.</p>
@@ -349,7 +352,7 @@ export declare class WorkDocs extends WorkDocsClient {
349
352
  /**
350
353
  * <p>Retrieves the path information (the hierarchy from the root folder) for the
351
354
  * specified folder.</p>
352
- * <p>By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the
355
+ * <p>By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the
353
356
  * requested folder and only includes the IDs of the parent folders in the path. You can
354
357
  * limit the maximum number of levels. You can also request the parent folder
355
358
  * names.</p>
@@ -366,11 +369,11 @@ export declare class WorkDocs extends WorkDocsClient {
366
369
  getResources(args: GetResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcesCommandOutput) => void): void;
367
370
  /**
368
371
  * <p>Creates a new document object and version object.</p>
369
- * <p>The client specifies the parent folder ID and name of the document to upload. The
372
+ * <p>The client specifies the parent folder ID and name of the document to upload. The
370
373
  * ID is optionally specified when creating a new version of an existing document. This is
371
374
  * the first step to upload a document. Next, upload the document to the URL returned from
372
375
  * the call, and then call <a>UpdateDocumentVersion</a>.</p>
373
- * <p>To cancel the document upload, call <a>AbortDocumentVersionUpload</a>.</p>
376
+ * <p>To cancel the document upload, call <a>AbortDocumentVersionUpload</a>.</p>
374
377
  */
375
378
  initiateDocumentVersionUpload(args: InitiateDocumentVersionUploadCommandInput, options?: __HttpHandlerOptions): Promise<InitiateDocumentVersionUploadCommandOutput>;
376
379
  initiateDocumentVersionUpload(args: InitiateDocumentVersionUploadCommandInput, cb: (err: any, data?: InitiateDocumentVersionUploadCommandOutput) => void): void;
@@ -403,7 +406,7 @@ export declare class WorkDocs extends WorkDocsClient {
403
406
  updateDocument(args: UpdateDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDocumentCommandOutput) => void): void;
404
407
  /**
405
408
  * <p>Changes the status of the document version to ACTIVE. </p>
406
- * <p>Amazon WorkDocs also sets its document container to ACTIVE. This is the last step
409
+ * <p>Amazon WorkDocs also sets its document container to ACTIVE. This is the last step
407
410
  * in a document upload, after the client uploads the document to an S3-presigned URL
408
411
  * returned by <a>InitiateDocumentVersionUpload</a>. </p>
409
412
  */
@@ -166,40 +166,40 @@ declare type WorkDocsClientResolvedConfigType = __SmithyResolvedConfiguration<__
166
166
  export interface WorkDocsClientResolvedConfig extends WorkDocsClientResolvedConfigType {
167
167
  }
168
168
  /**
169
- * <p>The WorkDocs API is designed for the following use cases:</p>
170
- * <ul>
169
+ * <p>The Amazon WorkDocs API is designed for the following use cases:</p>
170
+ * <ul>
171
171
  * <li>
172
- * <p>File Migration: File migration applications are supported for users who
172
+ * <p>File Migration: File migration applications are supported for users who
173
173
  * want to migrate their files from an on-premises or off-premises file system or
174
174
  * service. Users can insert files into a user directory structure, as well as
175
175
  * allow for basic metadata changes, such as modifications to the permissions of
176
176
  * files.</p>
177
177
  * </li>
178
178
  * <li>
179
- * <p>Security: Support security applications are supported for users who have
179
+ * <p>Security: Support security applications are supported for users who have
180
180
  * additional security needs, such as antivirus or data loss prevention. The API
181
- * actions, along with AWS CloudTrail, allow these applications to detect when
181
+ * actions, along with CloudTrail, allow these applications to detect when
182
182
  * changes occur in Amazon WorkDocs. Then, the application can take the necessary
183
183
  * actions and replace the target file. If the target file violates the policy, the
184
184
  * application can also choose to email the user.</p>
185
185
  * </li>
186
186
  * <li>
187
- * <p>eDiscovery/Analytics: General administrative applications are supported,
187
+ * <p>eDiscovery/Analytics: General administrative applications are supported,
188
188
  * such as eDiscovery and analytics. These applications can choose to mimic or
189
- * record the actions in an Amazon WorkDocs site, along with AWS CloudTrail, to
189
+ * record the actions in an Amazon WorkDocs site, along with CloudTrail, to
190
190
  * replicate data for eDiscovery, backup, or analytical applications.</p>
191
191
  * </li>
192
192
  * </ul>
193
- * <p>All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed.
194
- * They not only require the use of the AWS SDK, but also allow for the exclusive use of
193
+ * <p>All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed.
194
+ * They not only require the use of the Amazon Web Services SDK, but also allow for the exclusive use of
195
195
  * IAM users and roles to help facilitate access, trust, and permission policies. By
196
- * creating a role and allowing an IAM user to access the Amazon WorkDocs site, the IAM
197
- * user gains full administrative visibility into the entire Amazon WorkDocs site (or as
196
+ * creating a role and allowing an IAM user to access the Amazon WorkDocs site, the
197
+ * IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as
198
198
  * set in the IAM policy). This includes, but is not limited to, the ability to modify file
199
199
  * permissions and upload any file to any user. This allows developers to perform the three
200
200
  * use cases above, as well as give users the ability to grant access on a selective basis
201
201
  * using the IAM model.</p>
202
- * <note>
202
+ * <note>
203
203
  * <p>The pricing for Amazon WorkDocs APIs varies depending on the API call type for these actions:</p>
204
204
  * <ul>
205
205
  * <li>
@@ -224,7 +224,7 @@ export interface WorkDocsClientResolvedConfig extends WorkDocsClientResolvedConf
224
224
  * </li>
225
225
  * </ul>
226
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>
227
+ * </note>
228
228
  */
229
229
  export declare class WorkDocsClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig> {
230
230
  /**
@@ -10,7 +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/manage-notifications.html">Setting up notifications for an IAM user or role</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
14
14
  * Guide</i>.</p>
15
15
  * @example
16
16
  * Use a bare-bones client and the command you need to make an API call.
@@ -8,7 +8,7 @@ export interface DeleteDocumentVersionCommandInput extends DeleteDocumentVersion
8
8
  export interface DeleteDocumentVersionCommandOutput extends __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Deletes a version of an Amazon WorkDocs document. Use the <code>DeletePriorVersions</code> parameter to delete prior versions.</p>
11
+ * <p>Deletes a specific version of a document.</p>
12
12
  * @example
13
13
  * Use a bare-bones client and the command you need to make an API call.
14
14
  * ```javascript
@@ -9,6 +9,9 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {
9
9
  }
10
10
  /**
11
11
  * <p>Deletes the specified user from a Simple AD or Microsoft AD directory.</p>
12
+ * <important>
13
+ * <p>Deleting a user immediately and permanently deletes all content in that user's folder structure. Site retention policies do NOT apply to this type of deletion.</p>
14
+ * </important>
12
15
  * @example
13
16
  * Use a bare-bones client and the command you need to make an API call.
14
17
  * ```javascript
@@ -9,7 +9,7 @@ export interface DescribeDocumentVersionsCommandOutput extends DescribeDocumentV
9
9
  }
10
10
  /**
11
11
  * <p>Retrieves the document versions for the specified document.</p>
12
- * <p>By default, only active versions are returned.</p>
12
+ * <p>By default, only active versions are returned.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -10,7 +10,7 @@ export interface DescribeFolderContentsCommandOutput extends DescribeFolderConte
10
10
  /**
11
11
  * <p>Describes the contents of the specified folder, including its documents and
12
12
  * subfolders.</p>
13
- * <p>By default, Amazon WorkDocs returns the first 100 active document and folder
13
+ * <p>By default, Amazon WorkDocs returns the first 100 active document and folder
14
14
  * metadata items. If there are more results, the response includes a marker that you can
15
15
  * use to request the next set of results. You can also request initialized
16
16
  * documents.</p>
@@ -12,7 +12,7 @@ export interface DescribeRootFoldersCommandOutput extends DescribeRootFoldersRes
12
12
  * <code>RecycleBin</code>. <code>RootFolder</code> is the root of user's files and
13
13
  * folders and <code>RecycleBin</code> is the root of recycled items. This is not a valid
14
14
  * action for SigV4 (administrative API) clients.</p>
15
- * <p>This action requires an authentication token. To get an authentication token,
15
+ * <p>This action requires an authentication token. To get an authentication token,
16
16
  * register an application with Amazon WorkDocs. For more information, see <a href="https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html">Authentication and Access
17
17
  * Control for User Applications</a> in the
18
18
  * <i>Amazon
@@ -10,7 +10,7 @@ export interface DescribeUsersCommandOutput extends DescribeUsersResponse, __Met
10
10
  /**
11
11
  * <p>Describes the specified users. You can describe all users or filter the results
12
12
  * (for example, by status or organization).</p>
13
- * <p>By default, Amazon WorkDocs returns the first 24 active or pending users. If there
13
+ * <p>By default, Amazon WorkDocs returns the first 24 active or pending users. If there
14
14
  * are more results, the response includes a marker that you can use to request the next
15
15
  * set of results.</p>
16
16
  * @example
@@ -10,7 +10,7 @@ export interface GetCurrentUserCommandOutput extends GetCurrentUserResponse, __M
10
10
  /**
11
11
  * <p>Retrieves details of the current user for whom the authentication token was
12
12
  * generated. This is not a valid action for SigV4 (administrative API) clients.</p>
13
- * <p>This action requires an authentication token. To get an authentication token,
13
+ * <p>This action requires an authentication token. To get an authentication token,
14
14
  * register an application with Amazon WorkDocs. For more information, see <a href="https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html">Authentication and Access
15
15
  * Control for User Applications</a> in the
16
16
  * <i>Amazon
@@ -10,7 +10,7 @@ export interface GetDocumentPathCommandOutput extends GetDocumentPathResponse, _
10
10
  /**
11
11
  * <p>Retrieves the path information (the hierarchy from the root folder) for the
12
12
  * requested document.</p>
13
- * <p>By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the
13
+ * <p>By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the
14
14
  * requested document and only includes the IDs of the parent folders in the path. You can
15
15
  * limit the maximum number of levels. You can also request the names of the parent
16
16
  * folders.</p>
@@ -10,7 +10,7 @@ export interface GetFolderPathCommandOutput extends GetFolderPathResponse, __Met
10
10
  /**
11
11
  * <p>Retrieves the path information (the hierarchy from the root folder) for the
12
12
  * specified folder.</p>
13
- * <p>By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the
13
+ * <p>By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the
14
14
  * requested folder and only includes the IDs of the parent folders in the path. You can
15
15
  * limit the maximum number of levels. You can also request the parent folder
16
16
  * names.</p>
@@ -9,11 +9,11 @@ export interface InitiateDocumentVersionUploadCommandOutput extends InitiateDocu
9
9
  }
10
10
  /**
11
11
  * <p>Creates a new document object and version object.</p>
12
- * <p>The client specifies the parent folder ID and name of the document to upload. The
12
+ * <p>The client specifies the parent folder ID and name of the document to upload. The
13
13
  * ID is optionally specified when creating a new version of an existing document. This is
14
14
  * the first step to upload a document. Next, upload the document to the URL returned from
15
15
  * the call, and then call <a>UpdateDocumentVersion</a>.</p>
16
- * <p>To cancel the document upload, call <a>AbortDocumentVersionUpload</a>.</p>
16
+ * <p>To cancel the document upload, call <a>AbortDocumentVersionUpload</a>.</p>
17
17
  * @example
18
18
  * Use a bare-bones client and the command you need to make an API call.
19
19
  * ```javascript
@@ -9,7 +9,7 @@ export interface UpdateDocumentVersionCommandOutput extends __MetadataBearer {
9
9
  }
10
10
  /**
11
11
  * <p>Changes the status of the document version to ACTIVE. </p>
12
- * <p>Amazon WorkDocs also sets its document container to ACTIVE. This is the last step
12
+ * <p>Amazon WorkDocs also sets its document container to ACTIVE. This is the last step
13
13
  * in a document upload, after the client uploads the document to an S3-presigned URL
14
14
  * returned by <a>InitiateDocumentVersionUpload</a>. </p>
15
15
  * @example
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
12
12
  defaultSigningName: string;
13
13
  };
14
14
  export interface EndpointParameters extends __EndpointParameters {
15
- Region?: string;
15
+ Region: string;
16
16
  UseDualStack?: boolean;
17
17
  UseFIPS?: boolean;
18
18
  Endpoint?: string;
@@ -2,7 +2,7 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-cl
2
2
  import { WorkDocsServiceException as __BaseException } from "./WorkDocsServiceException";
3
3
  export interface AbortDocumentVersionUploadRequest {
4
4
  /**
5
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
5
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
6
6
  */
7
7
  AuthenticationToken?: string;
8
8
  /**
@@ -43,7 +43,7 @@ export declare class EntityNotExistsException extends __BaseException {
43
43
  constructor(opts: __ExceptionOptionType<EntityNotExistsException, __BaseException>);
44
44
  }
45
45
  /**
46
- * <p>The AWS Directory Service cannot reach an on-premises instance. Or a dependency
46
+ * <p>The Directory Service cannot reach an on-premises instance. Or a dependency
47
47
  * under the control of the organization is failing, such as a connected Active
48
48
  * Directory.</p>
49
49
  */
@@ -111,7 +111,7 @@ export interface ActivateUserRequest {
111
111
  */
112
112
  UserId: string | undefined;
113
113
  /**
114
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
114
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
115
115
  */
116
116
  AuthenticationToken?: string;
117
117
  }
@@ -449,7 +449,7 @@ export interface Activity {
449
449
  export interface NotificationOptions {
450
450
  /**
451
451
  * <p>Boolean value to indicate an email notification should be sent to the
452
- * receipients.</p>
452
+ * recipients.</p>
453
453
  */
454
454
  SendEmail?: boolean;
455
455
  /**
@@ -489,7 +489,7 @@ export interface SharePrincipal {
489
489
  }
490
490
  export interface AddResourcePermissionsRequest {
491
491
  /**
492
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
492
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
493
493
  */
494
494
  AuthenticationToken?: string;
495
495
  /**
@@ -550,7 +550,7 @@ export declare enum CommentVisibilityType {
550
550
  }
551
551
  export interface CreateCommentRequest {
552
552
  /**
553
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
553
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
554
554
  */
555
555
  AuthenticationToken?: string;
556
556
  /**
@@ -662,7 +662,7 @@ export declare class InvalidCommentOperationException extends __BaseException {
662
662
  }
663
663
  export interface CreateCustomMetadataRequest {
664
664
  /**
665
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
665
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
666
666
  */
667
667
  AuthenticationToken?: string;
668
668
  /**
@@ -708,7 +708,7 @@ export declare class ConflictingOperationException extends __BaseException {
708
708
  }
709
709
  export interface CreateFolderRequest {
710
710
  /**
711
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
711
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
712
712
  */
713
713
  AuthenticationToken?: string;
714
714
  /**
@@ -816,7 +816,7 @@ export interface CreateLabelsRequest {
816
816
  */
817
817
  Labels: string[] | undefined;
818
818
  /**
819
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
819
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
820
820
  */
821
821
  AuthenticationToken?: string;
822
822
  }
@@ -944,7 +944,7 @@ export interface CreateUserRequest {
944
944
  */
945
945
  StorageRule?: StorageRuleType;
946
946
  /**
947
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
947
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
948
948
  */
949
949
  AuthenticationToken?: string;
950
950
  }
@@ -960,13 +960,13 @@ export interface DeactivateUserRequest {
960
960
  */
961
961
  UserId: string | undefined;
962
962
  /**
963
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
963
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
964
964
  */
965
965
  AuthenticationToken?: string;
966
966
  }
967
967
  export interface DeleteCommentRequest {
968
968
  /**
969
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
969
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
970
970
  */
971
971
  AuthenticationToken?: string;
972
972
  /**
@@ -984,7 +984,7 @@ export interface DeleteCommentRequest {
984
984
  }
985
985
  export interface DeleteCustomMetadataRequest {
986
986
  /**
987
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
987
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
988
988
  */
989
989
  AuthenticationToken?: string;
990
990
  /**
@@ -1010,7 +1010,7 @@ export interface DeleteCustomMetadataResponse {
1010
1010
  }
1011
1011
  export interface DeleteDocumentRequest {
1012
1012
  /**
1013
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1013
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1014
1014
  */
1015
1015
  AuthenticationToken?: string;
1016
1016
  /**
@@ -1020,19 +1020,19 @@ export interface DeleteDocumentRequest {
1020
1020
  }
1021
1021
  export interface DeleteDocumentVersionRequest {
1022
1022
  /**
1023
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1023
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1024
1024
  */
1025
1025
  AuthenticationToken?: string;
1026
1026
  /**
1027
- * <p>The ID of a document.</p>
1027
+ * <p>The ID of the document associated with the version being deleted.</p>
1028
1028
  */
1029
1029
  DocumentId: string | undefined;
1030
1030
  /**
1031
- * <p>The version ID of a document.</p>
1031
+ * <p>The ID of the version being deleted.</p>
1032
1032
  */
1033
1033
  VersionId: string | undefined;
1034
1034
  /**
1035
- * <p>When set to <code>TRUE</code>, deletes the specified version and <i>all prior versions</i> of a document.</p>
1035
+ * <p>Deletes all versions of a document prior to the current version.</p>
1036
1036
  */
1037
1037
  DeletePriorVersions: boolean | undefined;
1038
1038
  }
@@ -1050,7 +1050,7 @@ export declare class InvalidOperationException extends __BaseException {
1050
1050
  }
1051
1051
  export interface DeleteFolderRequest {
1052
1052
  /**
1053
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1053
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1054
1054
  */
1055
1055
  AuthenticationToken?: string;
1056
1056
  /**
@@ -1060,7 +1060,7 @@ export interface DeleteFolderRequest {
1060
1060
  }
1061
1061
  export interface DeleteFolderContentsRequest {
1062
1062
  /**
1063
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1063
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1064
1064
  */
1065
1065
  AuthenticationToken?: string;
1066
1066
  /**
@@ -1074,7 +1074,7 @@ export interface DeleteLabelsRequest {
1074
1074
  */
1075
1075
  ResourceId: string | undefined;
1076
1076
  /**
1077
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1077
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1078
1078
  */
1079
1079
  AuthenticationToken?: string;
1080
1080
  /**
@@ -1101,7 +1101,7 @@ export interface DeleteNotificationSubscriptionRequest {
1101
1101
  export interface DeleteUserRequest {
1102
1102
  /**
1103
1103
  * <p>Amazon WorkDocs authentication token. Do not set this field when using
1104
- * administrative API actions, as in accessing the API using AWS credentials.</p>
1104
+ * administrative API actions, as in accessing the API using Amazon Web Services credentials.</p>
1105
1105
  */
1106
1106
  AuthenticationToken?: string;
1107
1107
  /**
@@ -1111,7 +1111,7 @@ export interface DeleteUserRequest {
1111
1111
  }
1112
1112
  export interface DescribeActivitiesRequest {
1113
1113
  /**
1114
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1114
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1115
1115
  */
1116
1116
  AuthenticationToken?: string;
1117
1117
  /**
@@ -1172,7 +1172,7 @@ export interface DescribeActivitiesResponse {
1172
1172
  }
1173
1173
  export interface DescribeCommentsRequest {
1174
1174
  /**
1175
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1175
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1176
1176
  */
1177
1177
  AuthenticationToken?: string;
1178
1178
  /**
@@ -1206,7 +1206,7 @@ export interface DescribeCommentsResponse {
1206
1206
  }
1207
1207
  export interface DescribeDocumentVersionsRequest {
1208
1208
  /**
1209
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1209
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1210
1210
  */
1211
1211
  AuthenticationToken?: string;
1212
1212
  /**
@@ -1341,7 +1341,7 @@ export declare enum FolderContentType {
1341
1341
  }
1342
1342
  export interface DescribeFolderContentsRequest {
1343
1343
  /**
1344
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1344
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1345
1345
  */
1346
1346
  AuthenticationToken?: string;
1347
1347
  /**
@@ -1429,7 +1429,7 @@ export interface DescribeFolderContentsResponse {
1429
1429
  }
1430
1430
  export interface DescribeGroupsRequest {
1431
1431
  /**
1432
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1432
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1433
1433
  */
1434
1434
  AuthenticationToken?: string;
1435
1435
  /**
@@ -1489,7 +1489,7 @@ export interface DescribeNotificationSubscriptionsResponse {
1489
1489
  }
1490
1490
  export interface DescribeResourcePermissionsRequest {
1491
1491
  /**
1492
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1492
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1493
1493
  */
1494
1494
  AuthenticationToken?: string;
1495
1495
  /**
@@ -1593,7 +1593,7 @@ export declare enum UserSortType {
1593
1593
  }
1594
1594
  export interface DescribeUsersRequest {
1595
1595
  /**
1596
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1596
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1597
1597
  */
1598
1598
  AuthenticationToken?: string;
1599
1599
  /**
@@ -1606,7 +1606,7 @@ export interface DescribeUsersRequest {
1606
1606
  UserIds?: string;
1607
1607
  /**
1608
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>
1609
+ * <ul>
1610
1610
  * <li>
1611
1611
  * <p>If you don't use either parameter, the API returns a paginated list of all users on the site.</p>
1612
1612
  * </li>
@@ -1695,7 +1695,7 @@ export interface GetCurrentUserResponse {
1695
1695
  }
1696
1696
  export interface GetDocumentRequest {
1697
1697
  /**
1698
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1698
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1699
1699
  */
1700
1700
  AuthenticationToken?: string;
1701
1701
  /**
@@ -1719,7 +1719,7 @@ export interface GetDocumentResponse {
1719
1719
  }
1720
1720
  export interface GetDocumentPathRequest {
1721
1721
  /**
1722
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1722
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1723
1723
  */
1724
1724
  AuthenticationToken?: string;
1725
1725
  /**
@@ -1770,7 +1770,7 @@ export interface GetDocumentPathResponse {
1770
1770
  }
1771
1771
  export interface GetDocumentVersionRequest {
1772
1772
  /**
1773
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1773
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1774
1774
  */
1775
1775
  AuthenticationToken?: string;
1776
1776
  /**
@@ -1803,7 +1803,7 @@ export interface GetDocumentVersionResponse {
1803
1803
  }
1804
1804
  export interface GetFolderRequest {
1805
1805
  /**
1806
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1806
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1807
1807
  */
1808
1808
  AuthenticationToken?: string;
1809
1809
  /**
@@ -1827,7 +1827,7 @@ export interface GetFolderResponse {
1827
1827
  }
1828
1828
  export interface GetFolderPathRequest {
1829
1829
  /**
1830
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1830
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1831
1831
  */
1832
1832
  AuthenticationToken?: string;
1833
1833
  /**
@@ -1859,7 +1859,7 @@ export declare enum ResourceCollectionType {
1859
1859
  }
1860
1860
  export interface GetResourcesRequest {
1861
1861
  /**
1862
- * <p>The Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1862
+ * <p>The Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1863
1863
  */
1864
1864
  AuthenticationToken?: string;
1865
1865
  /**
@@ -1909,7 +1909,7 @@ export declare class DraftUploadOutOfSyncException extends __BaseException {
1909
1909
  }
1910
1910
  export interface InitiateDocumentVersionUploadRequest {
1911
1911
  /**
1912
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1912
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1913
1913
  */
1914
1914
  AuthenticationToken?: string;
1915
1915
  /**
@@ -2002,7 +2002,7 @@ export declare class StorageLimitWillExceedException extends __BaseException {
2002
2002
  }
2003
2003
  export interface RemoveAllResourcePermissionsRequest {
2004
2004
  /**
2005
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
2005
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
2006
2006
  */
2007
2007
  AuthenticationToken?: string;
2008
2008
  /**
@@ -2012,7 +2012,7 @@ export interface RemoveAllResourcePermissionsRequest {
2012
2012
  }
2013
2013
  export interface RemoveResourcePermissionRequest {
2014
2014
  /**
2015
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
2015
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
2016
2016
  */
2017
2017
  AuthenticationToken?: string;
2018
2018
  /**
@@ -2030,7 +2030,7 @@ export interface RemoveResourcePermissionRequest {
2030
2030
  }
2031
2031
  export interface RestoreDocumentVersionsRequest {
2032
2032
  /**
2033
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
2033
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
2034
2034
  */
2035
2035
  AuthenticationToken?: string;
2036
2036
  /**
@@ -2040,7 +2040,7 @@ export interface RestoreDocumentVersionsRequest {
2040
2040
  }
2041
2041
  export interface UpdateDocumentRequest {
2042
2042
  /**
2043
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
2043
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
2044
2044
  */
2045
2045
  AuthenticationToken?: string;
2046
2046
  /**
@@ -2066,7 +2066,7 @@ export declare enum DocumentVersionStatus {
2066
2066
  }
2067
2067
  export interface UpdateDocumentVersionRequest {
2068
2068
  /**
2069
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
2069
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
2070
2070
  */
2071
2071
  AuthenticationToken?: string;
2072
2072
  /**
@@ -2084,7 +2084,7 @@ export interface UpdateDocumentVersionRequest {
2084
2084
  }
2085
2085
  export interface UpdateFolderRequest {
2086
2086
  /**
2087
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
2087
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
2088
2088
  */
2089
2089
  AuthenticationToken?: string;
2090
2090
  /**
@@ -2136,7 +2136,7 @@ export declare enum BooleanEnumType {
2136
2136
  }
2137
2137
  export interface UpdateUserRequest {
2138
2138
  /**
2139
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
2139
+ * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
2140
2140
  */
2141
2141
  AuthenticationToken?: string;
2142
2142
  /**
@@ -2168,7 +2168,7 @@ export interface UpdateUserRequest {
2168
2168
  */
2169
2169
  Locale?: LocaleType | string;
2170
2170
  /**
2171
- * <p>Boolean value to determine whether the user is granted Poweruser privileges.</p>
2171
+ * <p>Boolean value to determine whether the user is granted Power user privileges.</p>
2172
2172
  */
2173
2173
  GrantPoweruserPrivileges?: BooleanEnumType | string;
2174
2174
  }
@@ -27,7 +27,7 @@ export declare const resolveClientEndpointParameters: <T>(
27
27
  defaultSigningName: string;
28
28
  };
29
29
  export interface EndpointParameters extends __EndpointParameters {
30
- Region?: string;
30
+ Region: string;
31
31
  UseDualStack?: boolean;
32
32
  UseFIPS?: boolean;
33
33
  Endpoint?: string;
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.267.0",
4
+ "version": "3.268.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",