@aws-sdk/client-workdocs 3.687.0 → 3.691.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/dist-types/models/models_0.d.ts +344 -344
- package/dist-types/ts3.4/models/models_0.d.ts +344 -344
- package/package.json +7 -7
|
@@ -8,7 +8,7 @@ export interface AbortDocumentVersionUploadRequest {
|
|
|
8
8
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
9
9
|
* @public
|
|
10
10
|
*/
|
|
11
|
-
AuthenticationToken?: string;
|
|
11
|
+
AuthenticationToken?: string | undefined;
|
|
12
12
|
/**
|
|
13
13
|
* <p>The ID of the document.</p>
|
|
14
14
|
* @public
|
|
@@ -27,7 +27,7 @@ export interface AbortDocumentVersionUploadRequest {
|
|
|
27
27
|
export declare class ConcurrentModificationException extends __BaseException {
|
|
28
28
|
readonly name: "ConcurrentModificationException";
|
|
29
29
|
readonly $fault: "client";
|
|
30
|
-
Message?: string;
|
|
30
|
+
Message?: string | undefined;
|
|
31
31
|
/**
|
|
32
32
|
* @internal
|
|
33
33
|
*/
|
|
@@ -40,12 +40,12 @@ export declare class ConcurrentModificationException extends __BaseException {
|
|
|
40
40
|
export declare class EntityNotExistsException extends __BaseException {
|
|
41
41
|
readonly name: "EntityNotExistsException";
|
|
42
42
|
readonly $fault: "client";
|
|
43
|
-
Message?: string;
|
|
43
|
+
Message?: string | undefined;
|
|
44
44
|
/**
|
|
45
45
|
* <p>The IDs of the non-existent resources.</p>
|
|
46
46
|
* @public
|
|
47
47
|
*/
|
|
48
|
-
EntityIds?: string[];
|
|
48
|
+
EntityIds?: string[] | undefined;
|
|
49
49
|
/**
|
|
50
50
|
* @internal
|
|
51
51
|
*/
|
|
@@ -60,7 +60,7 @@ export declare class EntityNotExistsException extends __BaseException {
|
|
|
60
60
|
export declare class FailedDependencyException extends __BaseException {
|
|
61
61
|
readonly name: "FailedDependencyException";
|
|
62
62
|
readonly $fault: "client";
|
|
63
|
-
Message?: string;
|
|
63
|
+
Message?: string | undefined;
|
|
64
64
|
/**
|
|
65
65
|
* @internal
|
|
66
66
|
*/
|
|
@@ -73,7 +73,7 @@ export declare class FailedDependencyException extends __BaseException {
|
|
|
73
73
|
export declare class ProhibitedStateException extends __BaseException {
|
|
74
74
|
readonly name: "ProhibitedStateException";
|
|
75
75
|
readonly $fault: "client";
|
|
76
|
-
Message?: string;
|
|
76
|
+
Message?: string | undefined;
|
|
77
77
|
/**
|
|
78
78
|
* @internal
|
|
79
79
|
*/
|
|
@@ -86,7 +86,7 @@ export declare class ProhibitedStateException extends __BaseException {
|
|
|
86
86
|
export declare class ServiceUnavailableException extends __BaseException {
|
|
87
87
|
readonly name: "ServiceUnavailableException";
|
|
88
88
|
readonly $fault: "server";
|
|
89
|
-
Message?: string;
|
|
89
|
+
Message?: string | undefined;
|
|
90
90
|
/**
|
|
91
91
|
* @internal
|
|
92
92
|
*/
|
|
@@ -99,8 +99,8 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
99
99
|
export declare class UnauthorizedOperationException extends __BaseException {
|
|
100
100
|
readonly name: "UnauthorizedOperationException";
|
|
101
101
|
readonly $fault: "client";
|
|
102
|
-
Message?: string;
|
|
103
|
-
Code?: string;
|
|
102
|
+
Message?: string | undefined;
|
|
103
|
+
Code?: string | undefined;
|
|
104
104
|
/**
|
|
105
105
|
* @internal
|
|
106
106
|
*/
|
|
@@ -113,7 +113,7 @@ export declare class UnauthorizedOperationException extends __BaseException {
|
|
|
113
113
|
export declare class UnauthorizedResourceAccessException extends __BaseException {
|
|
114
114
|
readonly name: "UnauthorizedResourceAccessException";
|
|
115
115
|
readonly $fault: "client";
|
|
116
|
-
Message?: string;
|
|
116
|
+
Message?: string | undefined;
|
|
117
117
|
/**
|
|
118
118
|
* @internal
|
|
119
119
|
*/
|
|
@@ -132,7 +132,7 @@ export interface ActivateUserRequest {
|
|
|
132
132
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
133
133
|
* @public
|
|
134
134
|
*/
|
|
135
|
-
AuthenticationToken?: string;
|
|
135
|
+
AuthenticationToken?: string | undefined;
|
|
136
136
|
}
|
|
137
137
|
/**
|
|
138
138
|
* @public
|
|
@@ -189,12 +189,12 @@ export interface StorageRuleType {
|
|
|
189
189
|
* <p>The amount of storage allocated, in bytes.</p>
|
|
190
190
|
* @public
|
|
191
191
|
*/
|
|
192
|
-
StorageAllocatedInBytes?: number;
|
|
192
|
+
StorageAllocatedInBytes?: number | undefined;
|
|
193
193
|
/**
|
|
194
194
|
* <p>The type of storage.</p>
|
|
195
195
|
* @public
|
|
196
196
|
*/
|
|
197
|
-
StorageType?: StorageType;
|
|
197
|
+
StorageType?: StorageType | undefined;
|
|
198
198
|
}
|
|
199
199
|
/**
|
|
200
200
|
* <p>Describes the storage for a user.</p>
|
|
@@ -205,12 +205,12 @@ export interface UserStorageMetadata {
|
|
|
205
205
|
* <p>The amount of storage used, in bytes.</p>
|
|
206
206
|
* @public
|
|
207
207
|
*/
|
|
208
|
-
StorageUtilizedInBytes?: number;
|
|
208
|
+
StorageUtilizedInBytes?: number | undefined;
|
|
209
209
|
/**
|
|
210
210
|
* <p>The storage for a user.</p>
|
|
211
211
|
* @public
|
|
212
212
|
*/
|
|
213
|
-
StorageRule?: StorageRuleType;
|
|
213
|
+
StorageRule?: StorageRuleType | undefined;
|
|
214
214
|
}
|
|
215
215
|
/**
|
|
216
216
|
* @public
|
|
@@ -236,77 +236,77 @@ export interface User {
|
|
|
236
236
|
* <p>The ID of the user.</p>
|
|
237
237
|
* @public
|
|
238
238
|
*/
|
|
239
|
-
Id?: string;
|
|
239
|
+
Id?: string | undefined;
|
|
240
240
|
/**
|
|
241
241
|
* <p>The login name of the user.</p>
|
|
242
242
|
* @public
|
|
243
243
|
*/
|
|
244
|
-
Username?: string;
|
|
244
|
+
Username?: string | undefined;
|
|
245
245
|
/**
|
|
246
246
|
* <p>The email address of the user.</p>
|
|
247
247
|
* @public
|
|
248
248
|
*/
|
|
249
|
-
EmailAddress?: string;
|
|
249
|
+
EmailAddress?: string | undefined;
|
|
250
250
|
/**
|
|
251
251
|
* <p>The given name of the user.</p>
|
|
252
252
|
* @public
|
|
253
253
|
*/
|
|
254
|
-
GivenName?: string;
|
|
254
|
+
GivenName?: string | undefined;
|
|
255
255
|
/**
|
|
256
256
|
* <p>The surname of the user.</p>
|
|
257
257
|
* @public
|
|
258
258
|
*/
|
|
259
|
-
Surname?: string;
|
|
259
|
+
Surname?: string | undefined;
|
|
260
260
|
/**
|
|
261
261
|
* <p>The ID of the organization.</p>
|
|
262
262
|
* @public
|
|
263
263
|
*/
|
|
264
|
-
OrganizationId?: string;
|
|
264
|
+
OrganizationId?: string | undefined;
|
|
265
265
|
/**
|
|
266
266
|
* <p>The ID of the root folder.</p>
|
|
267
267
|
* @public
|
|
268
268
|
*/
|
|
269
|
-
RootFolderId?: string;
|
|
269
|
+
RootFolderId?: string | undefined;
|
|
270
270
|
/**
|
|
271
271
|
* <p>The ID of the recycle bin folder.</p>
|
|
272
272
|
* @public
|
|
273
273
|
*/
|
|
274
|
-
RecycleBinFolderId?: string;
|
|
274
|
+
RecycleBinFolderId?: string | undefined;
|
|
275
275
|
/**
|
|
276
276
|
* <p>The status of the user.</p>
|
|
277
277
|
* @public
|
|
278
278
|
*/
|
|
279
|
-
Status?: UserStatusType;
|
|
279
|
+
Status?: UserStatusType | undefined;
|
|
280
280
|
/**
|
|
281
281
|
* <p>The type of user.</p>
|
|
282
282
|
* @public
|
|
283
283
|
*/
|
|
284
|
-
Type?: UserType;
|
|
284
|
+
Type?: UserType | undefined;
|
|
285
285
|
/**
|
|
286
286
|
* <p>The time when the user was created.</p>
|
|
287
287
|
* @public
|
|
288
288
|
*/
|
|
289
|
-
CreatedTimestamp?: Date;
|
|
289
|
+
CreatedTimestamp?: Date | undefined;
|
|
290
290
|
/**
|
|
291
291
|
* <p>The time when the user was modified.</p>
|
|
292
292
|
* @public
|
|
293
293
|
*/
|
|
294
|
-
ModifiedTimestamp?: Date;
|
|
294
|
+
ModifiedTimestamp?: Date | undefined;
|
|
295
295
|
/**
|
|
296
296
|
* <p>The time zone ID of the user.</p>
|
|
297
297
|
* @public
|
|
298
298
|
*/
|
|
299
|
-
TimeZoneId?: string;
|
|
299
|
+
TimeZoneId?: string | undefined;
|
|
300
300
|
/**
|
|
301
301
|
* <p>The locale of the user.</p>
|
|
302
302
|
* @public
|
|
303
303
|
*/
|
|
304
|
-
Locale?: LocaleType;
|
|
304
|
+
Locale?: LocaleType | undefined;
|
|
305
305
|
/**
|
|
306
306
|
* <p>The storage for the user.</p>
|
|
307
307
|
* @public
|
|
308
308
|
*/
|
|
309
|
-
Storage?: UserStorageMetadata;
|
|
309
|
+
Storage?: UserStorageMetadata | undefined;
|
|
310
310
|
}
|
|
311
311
|
/**
|
|
312
312
|
* @public
|
|
@@ -316,7 +316,7 @@ export interface ActivateUserResponse {
|
|
|
316
316
|
* <p>The user information.</p>
|
|
317
317
|
* @public
|
|
318
318
|
*/
|
|
319
|
-
User?: User;
|
|
319
|
+
User?: User | undefined;
|
|
320
320
|
}
|
|
321
321
|
/**
|
|
322
322
|
* @public
|
|
@@ -340,32 +340,32 @@ export interface CommentMetadata {
|
|
|
340
340
|
* <p>The ID of the comment.</p>
|
|
341
341
|
* @public
|
|
342
342
|
*/
|
|
343
|
-
CommentId?: string;
|
|
343
|
+
CommentId?: string | undefined;
|
|
344
344
|
/**
|
|
345
345
|
* <p>The user who made the comment.</p>
|
|
346
346
|
* @public
|
|
347
347
|
*/
|
|
348
|
-
Contributor?: User;
|
|
348
|
+
Contributor?: User | undefined;
|
|
349
349
|
/**
|
|
350
350
|
* <p>The timestamp that the comment was created.</p>
|
|
351
351
|
* @public
|
|
352
352
|
*/
|
|
353
|
-
CreatedTimestamp?: Date;
|
|
353
|
+
CreatedTimestamp?: Date | undefined;
|
|
354
354
|
/**
|
|
355
355
|
* <p>The status of the comment.</p>
|
|
356
356
|
* @public
|
|
357
357
|
*/
|
|
358
|
-
CommentStatus?: CommentStatusType;
|
|
358
|
+
CommentStatus?: CommentStatusType | undefined;
|
|
359
359
|
/**
|
|
360
360
|
* <p>The ID of the user being replied to.</p>
|
|
361
361
|
* @public
|
|
362
362
|
*/
|
|
363
|
-
RecipientId?: string;
|
|
363
|
+
RecipientId?: string | undefined;
|
|
364
364
|
/**
|
|
365
365
|
* <p>The ID of the user who made the comment.</p>
|
|
366
366
|
* @public
|
|
367
367
|
*/
|
|
368
|
-
ContributorId?: string;
|
|
368
|
+
ContributorId?: string | undefined;
|
|
369
369
|
}
|
|
370
370
|
/**
|
|
371
371
|
* <p>Describes the metadata of the user.</p>
|
|
@@ -376,27 +376,27 @@ export interface UserMetadata {
|
|
|
376
376
|
* <p>The ID of the user.</p>
|
|
377
377
|
* @public
|
|
378
378
|
*/
|
|
379
|
-
Id?: string;
|
|
379
|
+
Id?: string | undefined;
|
|
380
380
|
/**
|
|
381
381
|
* <p>The name of the user.</p>
|
|
382
382
|
* @public
|
|
383
383
|
*/
|
|
384
|
-
Username?: string;
|
|
384
|
+
Username?: string | undefined;
|
|
385
385
|
/**
|
|
386
386
|
* <p>The given name of the user before a rename operation.</p>
|
|
387
387
|
* @public
|
|
388
388
|
*/
|
|
389
|
-
GivenName?: string;
|
|
389
|
+
GivenName?: string | undefined;
|
|
390
390
|
/**
|
|
391
391
|
* <p>The surname of the user.</p>
|
|
392
392
|
* @public
|
|
393
393
|
*/
|
|
394
|
-
Surname?: string;
|
|
394
|
+
Surname?: string | undefined;
|
|
395
395
|
/**
|
|
396
396
|
* <p>The email address of the user.</p>
|
|
397
397
|
* @public
|
|
398
398
|
*/
|
|
399
|
-
EmailAddress?: string;
|
|
399
|
+
EmailAddress?: string | undefined;
|
|
400
400
|
}
|
|
401
401
|
/**
|
|
402
402
|
* @public
|
|
@@ -419,38 +419,38 @@ export interface ResourceMetadata {
|
|
|
419
419
|
* <p>The type of resource.</p>
|
|
420
420
|
* @public
|
|
421
421
|
*/
|
|
422
|
-
Type?: ResourceType;
|
|
422
|
+
Type?: ResourceType | undefined;
|
|
423
423
|
/**
|
|
424
424
|
* <p>The name of the resource.</p>
|
|
425
425
|
* @public
|
|
426
426
|
*/
|
|
427
|
-
Name?: string;
|
|
427
|
+
Name?: string | undefined;
|
|
428
428
|
/**
|
|
429
429
|
* <p>The original name of the resource before a rename operation.</p>
|
|
430
430
|
* @public
|
|
431
431
|
*/
|
|
432
|
-
OriginalName?: string;
|
|
432
|
+
OriginalName?: string | undefined;
|
|
433
433
|
/**
|
|
434
434
|
* <p>The ID of the resource.</p>
|
|
435
435
|
* @public
|
|
436
436
|
*/
|
|
437
|
-
Id?: string;
|
|
437
|
+
Id?: string | undefined;
|
|
438
438
|
/**
|
|
439
439
|
* <p>The version ID of the resource. This is an optional field and is filled for action
|
|
440
440
|
* on document version.</p>
|
|
441
441
|
* @public
|
|
442
442
|
*/
|
|
443
|
-
VersionId?: string;
|
|
443
|
+
VersionId?: string | undefined;
|
|
444
444
|
/**
|
|
445
445
|
* <p>The owner of the resource.</p>
|
|
446
446
|
* @public
|
|
447
447
|
*/
|
|
448
|
-
Owner?: UserMetadata;
|
|
448
|
+
Owner?: UserMetadata | undefined;
|
|
449
449
|
/**
|
|
450
450
|
* <p>The parent ID of the resource before a rename operation.</p>
|
|
451
451
|
* @public
|
|
452
452
|
*/
|
|
453
|
-
ParentId?: string;
|
|
453
|
+
ParentId?: string | undefined;
|
|
454
454
|
}
|
|
455
455
|
/**
|
|
456
456
|
* <p>Describes the metadata of a user group.</p>
|
|
@@ -461,12 +461,12 @@ export interface GroupMetadata {
|
|
|
461
461
|
* <p>The ID of the user group.</p>
|
|
462
462
|
* @public
|
|
463
463
|
*/
|
|
464
|
-
Id?: string;
|
|
464
|
+
Id?: string | undefined;
|
|
465
465
|
/**
|
|
466
466
|
* <p>The name of the group.</p>
|
|
467
467
|
* @public
|
|
468
468
|
*/
|
|
469
|
-
Name?: string;
|
|
469
|
+
Name?: string | undefined;
|
|
470
470
|
}
|
|
471
471
|
/**
|
|
472
472
|
* <p>Describes the users or user groups.</p>
|
|
@@ -477,12 +477,12 @@ export interface Participants {
|
|
|
477
477
|
* <p>The list of users.</p>
|
|
478
478
|
* @public
|
|
479
479
|
*/
|
|
480
|
-
Users?: UserMetadata[];
|
|
480
|
+
Users?: UserMetadata[] | undefined;
|
|
481
481
|
/**
|
|
482
482
|
* <p>The list of user groups.</p>
|
|
483
483
|
* @public
|
|
484
484
|
*/
|
|
485
|
-
Groups?: GroupMetadata[];
|
|
485
|
+
Groups?: GroupMetadata[] | undefined;
|
|
486
486
|
}
|
|
487
487
|
/**
|
|
488
488
|
* @public
|
|
@@ -536,12 +536,12 @@ export interface Activity {
|
|
|
536
536
|
* <p>The activity type.</p>
|
|
537
537
|
* @public
|
|
538
538
|
*/
|
|
539
|
-
Type?: ActivityType;
|
|
539
|
+
Type?: ActivityType | undefined;
|
|
540
540
|
/**
|
|
541
541
|
* <p>The timestamp when the action was performed.</p>
|
|
542
542
|
* @public
|
|
543
543
|
*/
|
|
544
|
-
TimeStamp?: Date;
|
|
544
|
+
TimeStamp?: Date | undefined;
|
|
545
545
|
/**
|
|
546
546
|
* <p>Indicates whether an activity is indirect or direct. An indirect activity results
|
|
547
547
|
* from a direct activity performed on a parent resource. For example, sharing a parent
|
|
@@ -549,41 +549,41 @@ export interface Activity {
|
|
|
549
549
|
* parent folder (the indirect activity).</p>
|
|
550
550
|
* @public
|
|
551
551
|
*/
|
|
552
|
-
IsIndirectActivity?: boolean;
|
|
552
|
+
IsIndirectActivity?: boolean | undefined;
|
|
553
553
|
/**
|
|
554
554
|
* <p>The ID of the organization.</p>
|
|
555
555
|
* @public
|
|
556
556
|
*/
|
|
557
|
-
OrganizationId?: string;
|
|
557
|
+
OrganizationId?: string | undefined;
|
|
558
558
|
/**
|
|
559
559
|
* <p>The user who performed the action.</p>
|
|
560
560
|
* @public
|
|
561
561
|
*/
|
|
562
|
-
Initiator?: UserMetadata;
|
|
562
|
+
Initiator?: UserMetadata | undefined;
|
|
563
563
|
/**
|
|
564
564
|
* <p>The list of users or groups impacted by this action. This is an optional field and
|
|
565
565
|
* is filled for the following sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED,
|
|
566
566
|
* DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED.</p>
|
|
567
567
|
* @public
|
|
568
568
|
*/
|
|
569
|
-
Participants?: Participants;
|
|
569
|
+
Participants?: Participants | undefined;
|
|
570
570
|
/**
|
|
571
571
|
* <p>The metadata of the resource involved in the user action.</p>
|
|
572
572
|
* @public
|
|
573
573
|
*/
|
|
574
|
-
ResourceMetadata?: ResourceMetadata;
|
|
574
|
+
ResourceMetadata?: ResourceMetadata | undefined;
|
|
575
575
|
/**
|
|
576
576
|
* <p>The original parent of the resource. This is an optional field and is filled for
|
|
577
577
|
* move activities.</p>
|
|
578
578
|
* @public
|
|
579
579
|
*/
|
|
580
|
-
OriginalParent?: ResourceMetadata;
|
|
580
|
+
OriginalParent?: ResourceMetadata | undefined;
|
|
581
581
|
/**
|
|
582
582
|
* <p>Metadata of the commenting activity. This is an optional field and is filled for
|
|
583
583
|
* commenting activities.</p>
|
|
584
584
|
* @public
|
|
585
585
|
*/
|
|
586
|
-
CommentMetadata?: CommentMetadata;
|
|
586
|
+
CommentMetadata?: CommentMetadata | undefined;
|
|
587
587
|
}
|
|
588
588
|
/**
|
|
589
589
|
* @public
|
|
@@ -606,12 +606,12 @@ export interface NotificationOptions {
|
|
|
606
606
|
* recipients.</p>
|
|
607
607
|
* @public
|
|
608
608
|
*/
|
|
609
|
-
SendEmail?: boolean;
|
|
609
|
+
SendEmail?: boolean | undefined;
|
|
610
610
|
/**
|
|
611
611
|
* <p>Text value to be included in the email body.</p>
|
|
612
612
|
* @public
|
|
613
613
|
*/
|
|
614
|
-
EmailMessage?: string;
|
|
614
|
+
EmailMessage?: string | undefined;
|
|
615
615
|
}
|
|
616
616
|
/**
|
|
617
617
|
* @public
|
|
@@ -671,7 +671,7 @@ export interface AddResourcePermissionsRequest {
|
|
|
671
671
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
672
672
|
* @public
|
|
673
673
|
*/
|
|
674
|
-
AuthenticationToken?: string;
|
|
674
|
+
AuthenticationToken?: string | undefined;
|
|
675
675
|
/**
|
|
676
676
|
* <p>The ID of the resource.</p>
|
|
677
677
|
* @public
|
|
@@ -686,7 +686,7 @@ export interface AddResourcePermissionsRequest {
|
|
|
686
686
|
* <p>The notification options.</p>
|
|
687
687
|
* @public
|
|
688
688
|
*/
|
|
689
|
-
NotificationOptions?: NotificationOptions;
|
|
689
|
+
NotificationOptions?: NotificationOptions | undefined;
|
|
690
690
|
}
|
|
691
691
|
/**
|
|
692
692
|
* @public
|
|
@@ -709,32 +709,32 @@ export interface ShareResult {
|
|
|
709
709
|
* <p>The ID of the principal.</p>
|
|
710
710
|
* @public
|
|
711
711
|
*/
|
|
712
|
-
PrincipalId?: string;
|
|
712
|
+
PrincipalId?: string | undefined;
|
|
713
713
|
/**
|
|
714
714
|
* <p>The ID of the invited user.</p>
|
|
715
715
|
* @public
|
|
716
716
|
*/
|
|
717
|
-
InviteePrincipalId?: string;
|
|
717
|
+
InviteePrincipalId?: string | undefined;
|
|
718
718
|
/**
|
|
719
719
|
* <p>The role.</p>
|
|
720
720
|
* @public
|
|
721
721
|
*/
|
|
722
|
-
Role?: RoleType;
|
|
722
|
+
Role?: RoleType | undefined;
|
|
723
723
|
/**
|
|
724
724
|
* <p>The status.</p>
|
|
725
725
|
* @public
|
|
726
726
|
*/
|
|
727
|
-
Status?: ShareStatusType;
|
|
727
|
+
Status?: ShareStatusType | undefined;
|
|
728
728
|
/**
|
|
729
729
|
* <p>The ID of the resource that was shared.</p>
|
|
730
730
|
* @public
|
|
731
731
|
*/
|
|
732
|
-
ShareId?: string;
|
|
732
|
+
ShareId?: string | undefined;
|
|
733
733
|
/**
|
|
734
734
|
* <p>The status message.</p>
|
|
735
735
|
* @public
|
|
736
736
|
*/
|
|
737
|
-
StatusMessage?: string;
|
|
737
|
+
StatusMessage?: string | undefined;
|
|
738
738
|
}
|
|
739
739
|
/**
|
|
740
740
|
* @public
|
|
@@ -744,7 +744,7 @@ export interface AddResourcePermissionsResponse {
|
|
|
744
744
|
* <p>The share results.</p>
|
|
745
745
|
* @public
|
|
746
746
|
*/
|
|
747
|
-
ShareResults?: ShareResult[];
|
|
747
|
+
ShareResults?: ShareResult[] | undefined;
|
|
748
748
|
}
|
|
749
749
|
/**
|
|
750
750
|
* @public
|
|
@@ -766,7 +766,7 @@ export interface CreateCommentRequest {
|
|
|
766
766
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
767
767
|
* @public
|
|
768
768
|
*/
|
|
769
|
-
AuthenticationToken?: string;
|
|
769
|
+
AuthenticationToken?: string | undefined;
|
|
770
770
|
/**
|
|
771
771
|
* <p>The ID of the document.</p>
|
|
772
772
|
* @public
|
|
@@ -781,12 +781,12 @@ export interface CreateCommentRequest {
|
|
|
781
781
|
* <p>The ID of the parent comment.</p>
|
|
782
782
|
* @public
|
|
783
783
|
*/
|
|
784
|
-
ParentId?: string;
|
|
784
|
+
ParentId?: string | undefined;
|
|
785
785
|
/**
|
|
786
786
|
* <p>The ID of the root comment in the thread.</p>
|
|
787
787
|
* @public
|
|
788
788
|
*/
|
|
789
|
-
ThreadId?: string;
|
|
789
|
+
ThreadId?: string | undefined;
|
|
790
790
|
/**
|
|
791
791
|
* <p>The text of the comment.</p>
|
|
792
792
|
* @public
|
|
@@ -798,13 +798,13 @@ export interface CreateCommentRequest {
|
|
|
798
798
|
* the comment is visible to document owners, co-owners, and contributors.</p>
|
|
799
799
|
* @public
|
|
800
800
|
*/
|
|
801
|
-
Visibility?: CommentVisibilityType;
|
|
801
|
+
Visibility?: CommentVisibilityType | undefined;
|
|
802
802
|
/**
|
|
803
803
|
* <p>Set this parameter to TRUE to send an email out to the document collaborators after
|
|
804
804
|
* the comment is created.</p>
|
|
805
805
|
* @public
|
|
806
806
|
*/
|
|
807
|
-
NotifyCollaborators?: boolean;
|
|
807
|
+
NotifyCollaborators?: boolean | undefined;
|
|
808
808
|
}
|
|
809
809
|
/**
|
|
810
810
|
* <p>Describes a comment.</p>
|
|
@@ -820,45 +820,45 @@ export interface Comment {
|
|
|
820
820
|
* <p>The ID of the parent comment.</p>
|
|
821
821
|
* @public
|
|
822
822
|
*/
|
|
823
|
-
ParentId?: string;
|
|
823
|
+
ParentId?: string | undefined;
|
|
824
824
|
/**
|
|
825
825
|
* <p>The ID of the root comment in the thread.</p>
|
|
826
826
|
* @public
|
|
827
827
|
*/
|
|
828
|
-
ThreadId?: string;
|
|
828
|
+
ThreadId?: string | undefined;
|
|
829
829
|
/**
|
|
830
830
|
* <p>The text of the comment.</p>
|
|
831
831
|
* @public
|
|
832
832
|
*/
|
|
833
|
-
Text?: string;
|
|
833
|
+
Text?: string | undefined;
|
|
834
834
|
/**
|
|
835
835
|
* <p>The details of the user who made the comment.</p>
|
|
836
836
|
* @public
|
|
837
837
|
*/
|
|
838
|
-
Contributor?: User;
|
|
838
|
+
Contributor?: User | undefined;
|
|
839
839
|
/**
|
|
840
840
|
* <p>The time that the comment was created.</p>
|
|
841
841
|
* @public
|
|
842
842
|
*/
|
|
843
|
-
CreatedTimestamp?: Date;
|
|
843
|
+
CreatedTimestamp?: Date | undefined;
|
|
844
844
|
/**
|
|
845
845
|
* <p>The status of the comment.</p>
|
|
846
846
|
* @public
|
|
847
847
|
*/
|
|
848
|
-
Status?: CommentStatusType;
|
|
848
|
+
Status?: CommentStatusType | undefined;
|
|
849
849
|
/**
|
|
850
850
|
* <p>The visibility of the comment. Options are either PRIVATE, where the comment is
|
|
851
851
|
* visible only to the comment author and document owner and co-owners, or PUBLIC, where
|
|
852
852
|
* the comment is visible to document owners, co-owners, and contributors.</p>
|
|
853
853
|
* @public
|
|
854
854
|
*/
|
|
855
|
-
Visibility?: CommentVisibilityType;
|
|
855
|
+
Visibility?: CommentVisibilityType | undefined;
|
|
856
856
|
/**
|
|
857
857
|
* <p>If the comment is a reply to another user's comment, this field contains the user
|
|
858
858
|
* ID of the user being replied to.</p>
|
|
859
859
|
* @public
|
|
860
860
|
*/
|
|
861
|
-
RecipientId?: string;
|
|
861
|
+
RecipientId?: string | undefined;
|
|
862
862
|
}
|
|
863
863
|
/**
|
|
864
864
|
* @public
|
|
@@ -868,7 +868,7 @@ export interface CreateCommentResponse {
|
|
|
868
868
|
* <p>The comment that has been created.</p>
|
|
869
869
|
* @public
|
|
870
870
|
*/
|
|
871
|
-
Comment?: Comment;
|
|
871
|
+
Comment?: Comment | undefined;
|
|
872
872
|
}
|
|
873
873
|
/**
|
|
874
874
|
* <p>This exception is thrown when the document is locked for comments and user tries to
|
|
@@ -878,7 +878,7 @@ export interface CreateCommentResponse {
|
|
|
878
878
|
export declare class DocumentLockedForCommentsException extends __BaseException {
|
|
879
879
|
readonly name: "DocumentLockedForCommentsException";
|
|
880
880
|
readonly $fault: "client";
|
|
881
|
-
Message?: string;
|
|
881
|
+
Message?: string | undefined;
|
|
882
882
|
/**
|
|
883
883
|
* @internal
|
|
884
884
|
*/
|
|
@@ -891,7 +891,7 @@ export declare class DocumentLockedForCommentsException extends __BaseException
|
|
|
891
891
|
export declare class InvalidCommentOperationException extends __BaseException {
|
|
892
892
|
readonly name: "InvalidCommentOperationException";
|
|
893
893
|
readonly $fault: "client";
|
|
894
|
-
Message?: string;
|
|
894
|
+
Message?: string | undefined;
|
|
895
895
|
/**
|
|
896
896
|
* @internal
|
|
897
897
|
*/
|
|
@@ -905,7 +905,7 @@ export interface CreateCustomMetadataRequest {
|
|
|
905
905
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
906
906
|
* @public
|
|
907
907
|
*/
|
|
908
|
-
AuthenticationToken?: string;
|
|
908
|
+
AuthenticationToken?: string | undefined;
|
|
909
909
|
/**
|
|
910
910
|
* <p>The ID of the resource.</p>
|
|
911
911
|
* @public
|
|
@@ -916,7 +916,7 @@ export interface CreateCustomMetadataRequest {
|
|
|
916
916
|
* version.</p>
|
|
917
917
|
* @public
|
|
918
918
|
*/
|
|
919
|
-
VersionId?: string;
|
|
919
|
+
VersionId?: string | undefined;
|
|
920
920
|
/**
|
|
921
921
|
* <p>Custom metadata in the form of name-value pairs.</p>
|
|
922
922
|
* @public
|
|
@@ -936,7 +936,7 @@ export interface CreateCustomMetadataResponse {
|
|
|
936
936
|
export declare class CustomMetadataLimitExceededException extends __BaseException {
|
|
937
937
|
readonly name: "CustomMetadataLimitExceededException";
|
|
938
938
|
readonly $fault: "client";
|
|
939
|
-
Message?: string;
|
|
939
|
+
Message?: string | undefined;
|
|
940
940
|
/**
|
|
941
941
|
* @internal
|
|
942
942
|
*/
|
|
@@ -949,7 +949,7 @@ export declare class CustomMetadataLimitExceededException extends __BaseExceptio
|
|
|
949
949
|
export declare class ConflictingOperationException extends __BaseException {
|
|
950
950
|
readonly name: "ConflictingOperationException";
|
|
951
951
|
readonly $fault: "client";
|
|
952
|
-
Message?: string;
|
|
952
|
+
Message?: string | undefined;
|
|
953
953
|
/**
|
|
954
954
|
* @internal
|
|
955
955
|
*/
|
|
@@ -963,12 +963,12 @@ export interface CreateFolderRequest {
|
|
|
963
963
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
964
964
|
* @public
|
|
965
965
|
*/
|
|
966
|
-
AuthenticationToken?: string;
|
|
966
|
+
AuthenticationToken?: string | undefined;
|
|
967
967
|
/**
|
|
968
968
|
* <p>The name of the new folder.</p>
|
|
969
969
|
* @public
|
|
970
970
|
*/
|
|
971
|
-
Name?: string;
|
|
971
|
+
Name?: string | undefined;
|
|
972
972
|
/**
|
|
973
973
|
* <p>The ID of the parent folder.</p>
|
|
974
974
|
* @public
|
|
@@ -998,58 +998,58 @@ export interface FolderMetadata {
|
|
|
998
998
|
* <p>The ID of the folder.</p>
|
|
999
999
|
* @public
|
|
1000
1000
|
*/
|
|
1001
|
-
Id?: string;
|
|
1001
|
+
Id?: string | undefined;
|
|
1002
1002
|
/**
|
|
1003
1003
|
* <p>The name of the folder.</p>
|
|
1004
1004
|
* @public
|
|
1005
1005
|
*/
|
|
1006
|
-
Name?: string;
|
|
1006
|
+
Name?: string | undefined;
|
|
1007
1007
|
/**
|
|
1008
1008
|
* <p>The ID of the creator.</p>
|
|
1009
1009
|
* @public
|
|
1010
1010
|
*/
|
|
1011
|
-
CreatorId?: string;
|
|
1011
|
+
CreatorId?: string | undefined;
|
|
1012
1012
|
/**
|
|
1013
1013
|
* <p>The ID of the parent folder.</p>
|
|
1014
1014
|
* @public
|
|
1015
1015
|
*/
|
|
1016
|
-
ParentFolderId?: string;
|
|
1016
|
+
ParentFolderId?: string | undefined;
|
|
1017
1017
|
/**
|
|
1018
1018
|
* <p>The time when the folder was created.</p>
|
|
1019
1019
|
* @public
|
|
1020
1020
|
*/
|
|
1021
|
-
CreatedTimestamp?: Date;
|
|
1021
|
+
CreatedTimestamp?: Date | undefined;
|
|
1022
1022
|
/**
|
|
1023
1023
|
* <p>The time when the folder was updated.</p>
|
|
1024
1024
|
* @public
|
|
1025
1025
|
*/
|
|
1026
|
-
ModifiedTimestamp?: Date;
|
|
1026
|
+
ModifiedTimestamp?: Date | undefined;
|
|
1027
1027
|
/**
|
|
1028
1028
|
* <p>The resource state of the folder.</p>
|
|
1029
1029
|
* @public
|
|
1030
1030
|
*/
|
|
1031
|
-
ResourceState?: ResourceStateType;
|
|
1031
|
+
ResourceState?: ResourceStateType | undefined;
|
|
1032
1032
|
/**
|
|
1033
1033
|
* <p>The unique identifier created from the subfolders and documents of the
|
|
1034
1034
|
* folder.</p>
|
|
1035
1035
|
* @public
|
|
1036
1036
|
*/
|
|
1037
|
-
Signature?: string;
|
|
1037
|
+
Signature?: string | undefined;
|
|
1038
1038
|
/**
|
|
1039
1039
|
* <p>List of labels on the folder.</p>
|
|
1040
1040
|
* @public
|
|
1041
1041
|
*/
|
|
1042
|
-
Labels?: string[];
|
|
1042
|
+
Labels?: string[] | undefined;
|
|
1043
1043
|
/**
|
|
1044
1044
|
* <p>The size of the folder metadata.</p>
|
|
1045
1045
|
* @public
|
|
1046
1046
|
*/
|
|
1047
|
-
Size?: number;
|
|
1047
|
+
Size?: number | undefined;
|
|
1048
1048
|
/**
|
|
1049
1049
|
* <p>The size of the latest version of the folder metadata.</p>
|
|
1050
1050
|
* @public
|
|
1051
1051
|
*/
|
|
1052
|
-
LatestVersionSize?: number;
|
|
1052
|
+
LatestVersionSize?: number | undefined;
|
|
1053
1053
|
}
|
|
1054
1054
|
/**
|
|
1055
1055
|
* @public
|
|
@@ -1059,7 +1059,7 @@ export interface CreateFolderResponse {
|
|
|
1059
1059
|
* <p>The metadata of the folder.</p>
|
|
1060
1060
|
* @public
|
|
1061
1061
|
*/
|
|
1062
|
-
Metadata?: FolderMetadata;
|
|
1062
|
+
Metadata?: FolderMetadata | undefined;
|
|
1063
1063
|
}
|
|
1064
1064
|
/**
|
|
1065
1065
|
* <p>The resource already exists.</p>
|
|
@@ -1068,7 +1068,7 @@ export interface CreateFolderResponse {
|
|
|
1068
1068
|
export declare class EntityAlreadyExistsException extends __BaseException {
|
|
1069
1069
|
readonly name: "EntityAlreadyExistsException";
|
|
1070
1070
|
readonly $fault: "client";
|
|
1071
|
-
Message?: string;
|
|
1071
|
+
Message?: string | undefined;
|
|
1072
1072
|
/**
|
|
1073
1073
|
* @internal
|
|
1074
1074
|
*/
|
|
@@ -1081,7 +1081,7 @@ export declare class EntityAlreadyExistsException extends __BaseException {
|
|
|
1081
1081
|
export declare class LimitExceededException extends __BaseException {
|
|
1082
1082
|
readonly name: "LimitExceededException";
|
|
1083
1083
|
readonly $fault: "client";
|
|
1084
|
-
Message?: string;
|
|
1084
|
+
Message?: string | undefined;
|
|
1085
1085
|
/**
|
|
1086
1086
|
* @internal
|
|
1087
1087
|
*/
|
|
@@ -1105,7 +1105,7 @@ export interface CreateLabelsRequest {
|
|
|
1105
1105
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1106
1106
|
* @public
|
|
1107
1107
|
*/
|
|
1108
|
-
AuthenticationToken?: string;
|
|
1108
|
+
AuthenticationToken?: string | undefined;
|
|
1109
1109
|
}
|
|
1110
1110
|
/**
|
|
1111
1111
|
* @public
|
|
@@ -1120,7 +1120,7 @@ export interface CreateLabelsResponse {
|
|
|
1120
1120
|
export declare class TooManyLabelsException extends __BaseException {
|
|
1121
1121
|
readonly name: "TooManyLabelsException";
|
|
1122
1122
|
readonly $fault: "client";
|
|
1123
|
-
Message?: string;
|
|
1123
|
+
Message?: string | undefined;
|
|
1124
1124
|
/**
|
|
1125
1125
|
* @internal
|
|
1126
1126
|
*/
|
|
@@ -1185,17 +1185,17 @@ export interface Subscription {
|
|
|
1185
1185
|
* <p>The ID of the subscription.</p>
|
|
1186
1186
|
* @public
|
|
1187
1187
|
*/
|
|
1188
|
-
SubscriptionId?: string;
|
|
1188
|
+
SubscriptionId?: string | undefined;
|
|
1189
1189
|
/**
|
|
1190
1190
|
* <p>The endpoint of the subscription.</p>
|
|
1191
1191
|
* @public
|
|
1192
1192
|
*/
|
|
1193
|
-
EndPoint?: string;
|
|
1193
|
+
EndPoint?: string | undefined;
|
|
1194
1194
|
/**
|
|
1195
1195
|
* <p>The protocol of the subscription.</p>
|
|
1196
1196
|
* @public
|
|
1197
1197
|
*/
|
|
1198
|
-
Protocol?: SubscriptionProtocolType;
|
|
1198
|
+
Protocol?: SubscriptionProtocolType | undefined;
|
|
1199
1199
|
}
|
|
1200
1200
|
/**
|
|
1201
1201
|
* @public
|
|
@@ -1205,7 +1205,7 @@ export interface CreateNotificationSubscriptionResponse {
|
|
|
1205
1205
|
* <p>The subscription.</p>
|
|
1206
1206
|
* @public
|
|
1207
1207
|
*/
|
|
1208
|
-
Subscription?: Subscription;
|
|
1208
|
+
Subscription?: Subscription | undefined;
|
|
1209
1209
|
}
|
|
1210
1210
|
/**
|
|
1211
1211
|
* <p>The pagination marker or limit fields are not valid.</p>
|
|
@@ -1214,7 +1214,7 @@ export interface CreateNotificationSubscriptionResponse {
|
|
|
1214
1214
|
export declare class InvalidArgumentException extends __BaseException {
|
|
1215
1215
|
readonly name: "InvalidArgumentException";
|
|
1216
1216
|
readonly $fault: "client";
|
|
1217
|
-
Message?: string;
|
|
1217
|
+
Message?: string | undefined;
|
|
1218
1218
|
/**
|
|
1219
1219
|
* @internal
|
|
1220
1220
|
*/
|
|
@@ -1228,7 +1228,7 @@ export declare class InvalidArgumentException extends __BaseException {
|
|
|
1228
1228
|
export declare class TooManySubscriptionsException extends __BaseException {
|
|
1229
1229
|
readonly name: "TooManySubscriptionsException";
|
|
1230
1230
|
readonly $fault: "client";
|
|
1231
|
-
Message?: string;
|
|
1231
|
+
Message?: string | undefined;
|
|
1232
1232
|
/**
|
|
1233
1233
|
* @internal
|
|
1234
1234
|
*/
|
|
@@ -1242,7 +1242,7 @@ export interface CreateUserRequest {
|
|
|
1242
1242
|
* <p>The ID of the organization.</p>
|
|
1243
1243
|
* @public
|
|
1244
1244
|
*/
|
|
1245
|
-
OrganizationId?: string;
|
|
1245
|
+
OrganizationId?: string | undefined;
|
|
1246
1246
|
/**
|
|
1247
1247
|
* <p>The login name of the user.</p>
|
|
1248
1248
|
* @public
|
|
@@ -1252,7 +1252,7 @@ export interface CreateUserRequest {
|
|
|
1252
1252
|
* <p>The email address of the user.</p>
|
|
1253
1253
|
* @public
|
|
1254
1254
|
*/
|
|
1255
|
-
EmailAddress?: string;
|
|
1255
|
+
EmailAddress?: string | undefined;
|
|
1256
1256
|
/**
|
|
1257
1257
|
* <p>The given name of the user.</p>
|
|
1258
1258
|
* @public
|
|
@@ -1272,17 +1272,17 @@ export interface CreateUserRequest {
|
|
|
1272
1272
|
* <p>The time zone ID of the user.</p>
|
|
1273
1273
|
* @public
|
|
1274
1274
|
*/
|
|
1275
|
-
TimeZoneId?: string;
|
|
1275
|
+
TimeZoneId?: string | undefined;
|
|
1276
1276
|
/**
|
|
1277
1277
|
* <p>The amount of storage for the user.</p>
|
|
1278
1278
|
* @public
|
|
1279
1279
|
*/
|
|
1280
|
-
StorageRule?: StorageRuleType;
|
|
1280
|
+
StorageRule?: StorageRuleType | undefined;
|
|
1281
1281
|
/**
|
|
1282
1282
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1283
1283
|
* @public
|
|
1284
1284
|
*/
|
|
1285
|
-
AuthenticationToken?: string;
|
|
1285
|
+
AuthenticationToken?: string | undefined;
|
|
1286
1286
|
}
|
|
1287
1287
|
/**
|
|
1288
1288
|
* @public
|
|
@@ -1292,7 +1292,7 @@ export interface CreateUserResponse {
|
|
|
1292
1292
|
* <p>The user information.</p>
|
|
1293
1293
|
* @public
|
|
1294
1294
|
*/
|
|
1295
|
-
User?: User;
|
|
1295
|
+
User?: User | undefined;
|
|
1296
1296
|
}
|
|
1297
1297
|
/**
|
|
1298
1298
|
* @public
|
|
@@ -1307,7 +1307,7 @@ export interface DeactivateUserRequest {
|
|
|
1307
1307
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1308
1308
|
* @public
|
|
1309
1309
|
*/
|
|
1310
|
-
AuthenticationToken?: string;
|
|
1310
|
+
AuthenticationToken?: string | undefined;
|
|
1311
1311
|
}
|
|
1312
1312
|
/**
|
|
1313
1313
|
* @public
|
|
@@ -1317,7 +1317,7 @@ export interface DeleteCommentRequest {
|
|
|
1317
1317
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1318
1318
|
* @public
|
|
1319
1319
|
*/
|
|
1320
|
-
AuthenticationToken?: string;
|
|
1320
|
+
AuthenticationToken?: string | undefined;
|
|
1321
1321
|
/**
|
|
1322
1322
|
* <p>The ID of the document.</p>
|
|
1323
1323
|
* @public
|
|
@@ -1342,7 +1342,7 @@ export interface DeleteCustomMetadataRequest {
|
|
|
1342
1342
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1343
1343
|
* @public
|
|
1344
1344
|
*/
|
|
1345
|
-
AuthenticationToken?: string;
|
|
1345
|
+
AuthenticationToken?: string | undefined;
|
|
1346
1346
|
/**
|
|
1347
1347
|
* <p>The ID of the resource, either a document or folder.</p>
|
|
1348
1348
|
* @public
|
|
@@ -1353,18 +1353,18 @@ export interface DeleteCustomMetadataRequest {
|
|
|
1353
1353
|
* version.</p>
|
|
1354
1354
|
* @public
|
|
1355
1355
|
*/
|
|
1356
|
-
VersionId?: string;
|
|
1356
|
+
VersionId?: string | undefined;
|
|
1357
1357
|
/**
|
|
1358
1358
|
* <p>List of properties to remove.</p>
|
|
1359
1359
|
* @public
|
|
1360
1360
|
*/
|
|
1361
|
-
Keys?: string[];
|
|
1361
|
+
Keys?: string[] | undefined;
|
|
1362
1362
|
/**
|
|
1363
1363
|
* <p>Flag to indicate removal of all custom metadata properties from the specified
|
|
1364
1364
|
* resource.</p>
|
|
1365
1365
|
* @public
|
|
1366
1366
|
*/
|
|
1367
|
-
DeleteAll?: boolean;
|
|
1367
|
+
DeleteAll?: boolean | undefined;
|
|
1368
1368
|
}
|
|
1369
1369
|
/**
|
|
1370
1370
|
* @public
|
|
@@ -1379,7 +1379,7 @@ export interface DeleteDocumentRequest {
|
|
|
1379
1379
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1380
1380
|
* @public
|
|
1381
1381
|
*/
|
|
1382
|
-
AuthenticationToken?: string;
|
|
1382
|
+
AuthenticationToken?: string | undefined;
|
|
1383
1383
|
/**
|
|
1384
1384
|
* <p>The ID of the document.</p>
|
|
1385
1385
|
* @public
|
|
@@ -1394,7 +1394,7 @@ export interface DeleteDocumentVersionRequest {
|
|
|
1394
1394
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1395
1395
|
* @public
|
|
1396
1396
|
*/
|
|
1397
|
-
AuthenticationToken?: string;
|
|
1397
|
+
AuthenticationToken?: string | undefined;
|
|
1398
1398
|
/**
|
|
1399
1399
|
* <p>The ID of the document associated with the version being deleted.</p>
|
|
1400
1400
|
* @public
|
|
@@ -1418,7 +1418,7 @@ export interface DeleteDocumentVersionRequest {
|
|
|
1418
1418
|
export declare class InvalidOperationException extends __BaseException {
|
|
1419
1419
|
readonly name: "InvalidOperationException";
|
|
1420
1420
|
readonly $fault: "client";
|
|
1421
|
-
Message?: string;
|
|
1421
|
+
Message?: string | undefined;
|
|
1422
1422
|
/**
|
|
1423
1423
|
* @internal
|
|
1424
1424
|
*/
|
|
@@ -1432,7 +1432,7 @@ export interface DeleteFolderRequest {
|
|
|
1432
1432
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1433
1433
|
* @public
|
|
1434
1434
|
*/
|
|
1435
|
-
AuthenticationToken?: string;
|
|
1435
|
+
AuthenticationToken?: string | undefined;
|
|
1436
1436
|
/**
|
|
1437
1437
|
* <p>The ID of the folder.</p>
|
|
1438
1438
|
* @public
|
|
@@ -1447,7 +1447,7 @@ export interface DeleteFolderContentsRequest {
|
|
|
1447
1447
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1448
1448
|
* @public
|
|
1449
1449
|
*/
|
|
1450
|
-
AuthenticationToken?: string;
|
|
1450
|
+
AuthenticationToken?: string | undefined;
|
|
1451
1451
|
/**
|
|
1452
1452
|
* <p>The ID of the folder.</p>
|
|
1453
1453
|
* @public
|
|
@@ -1467,17 +1467,17 @@ export interface DeleteLabelsRequest {
|
|
|
1467
1467
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1468
1468
|
* @public
|
|
1469
1469
|
*/
|
|
1470
|
-
AuthenticationToken?: string;
|
|
1470
|
+
AuthenticationToken?: string | undefined;
|
|
1471
1471
|
/**
|
|
1472
1472
|
* <p>List of labels to delete from the resource.</p>
|
|
1473
1473
|
* @public
|
|
1474
1474
|
*/
|
|
1475
|
-
Labels?: string[];
|
|
1475
|
+
Labels?: string[] | undefined;
|
|
1476
1476
|
/**
|
|
1477
1477
|
* <p>Flag to request removal of all labels from the specified resource.</p>
|
|
1478
1478
|
* @public
|
|
1479
1479
|
*/
|
|
1480
|
-
DeleteAll?: boolean;
|
|
1480
|
+
DeleteAll?: boolean | undefined;
|
|
1481
1481
|
}
|
|
1482
1482
|
/**
|
|
1483
1483
|
* @public
|
|
@@ -1508,7 +1508,7 @@ export interface DeleteUserRequest {
|
|
|
1508
1508
|
* administrative API actions, as in accessing the API using Amazon Web Services credentials.</p>
|
|
1509
1509
|
* @public
|
|
1510
1510
|
*/
|
|
1511
|
-
AuthenticationToken?: string;
|
|
1511
|
+
AuthenticationToken?: string | undefined;
|
|
1512
1512
|
/**
|
|
1513
1513
|
* <p>The ID of the user.</p>
|
|
1514
1514
|
* @public
|
|
@@ -1523,43 +1523,43 @@ export interface DescribeActivitiesRequest {
|
|
|
1523
1523
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1524
1524
|
* @public
|
|
1525
1525
|
*/
|
|
1526
|
-
AuthenticationToken?: string;
|
|
1526
|
+
AuthenticationToken?: string | undefined;
|
|
1527
1527
|
/**
|
|
1528
1528
|
* <p>The timestamp that determines the starting time of the activities. The response
|
|
1529
1529
|
* includes the activities performed after the specified timestamp.</p>
|
|
1530
1530
|
* @public
|
|
1531
1531
|
*/
|
|
1532
|
-
StartTime?: Date;
|
|
1532
|
+
StartTime?: Date | undefined;
|
|
1533
1533
|
/**
|
|
1534
1534
|
* <p>The timestamp that determines the end time of the activities. The response includes
|
|
1535
1535
|
* the activities performed before the specified timestamp.</p>
|
|
1536
1536
|
* @public
|
|
1537
1537
|
*/
|
|
1538
|
-
EndTime?: Date;
|
|
1538
|
+
EndTime?: Date | undefined;
|
|
1539
1539
|
/**
|
|
1540
1540
|
* <p>The ID of the organization. This is a mandatory parameter when using administrative
|
|
1541
1541
|
* API (SigV4) requests.</p>
|
|
1542
1542
|
* @public
|
|
1543
1543
|
*/
|
|
1544
|
-
OrganizationId?: string;
|
|
1544
|
+
OrganizationId?: string | undefined;
|
|
1545
1545
|
/**
|
|
1546
1546
|
* <p>Specifies which activity types to include in the response. If this field is left
|
|
1547
1547
|
* empty, all activity types are returned.</p>
|
|
1548
1548
|
* @public
|
|
1549
1549
|
*/
|
|
1550
|
-
ActivityTypes?: string;
|
|
1550
|
+
ActivityTypes?: string | undefined;
|
|
1551
1551
|
/**
|
|
1552
1552
|
* <p>The document or folder ID for which to describe activity types.</p>
|
|
1553
1553
|
* @public
|
|
1554
1554
|
*/
|
|
1555
|
-
ResourceId?: string;
|
|
1555
|
+
ResourceId?: string | undefined;
|
|
1556
1556
|
/**
|
|
1557
1557
|
* <p>The ID of the user who performed the action. The response includes activities
|
|
1558
1558
|
* pertaining to this user. This is an optional parameter and is only applicable for
|
|
1559
1559
|
* administrative API (SigV4) requests.</p>
|
|
1560
1560
|
* @public
|
|
1561
1561
|
*/
|
|
1562
|
-
UserId?: string;
|
|
1562
|
+
UserId?: string | undefined;
|
|
1563
1563
|
/**
|
|
1564
1564
|
* <p>Includes indirect activities. An indirect activity results from a direct activity
|
|
1565
1565
|
* performed on a parent resource. For example, sharing a parent folder (the direct
|
|
@@ -1567,17 +1567,17 @@ export interface DescribeActivitiesRequest {
|
|
|
1567
1567
|
* indirect activity).</p>
|
|
1568
1568
|
* @public
|
|
1569
1569
|
*/
|
|
1570
|
-
IncludeIndirectActivities?: boolean;
|
|
1570
|
+
IncludeIndirectActivities?: boolean | undefined;
|
|
1571
1571
|
/**
|
|
1572
1572
|
* <p>The maximum number of items to return.</p>
|
|
1573
1573
|
* @public
|
|
1574
1574
|
*/
|
|
1575
|
-
Limit?: number;
|
|
1575
|
+
Limit?: number | undefined;
|
|
1576
1576
|
/**
|
|
1577
1577
|
* <p>The marker for the next set of results.</p>
|
|
1578
1578
|
* @public
|
|
1579
1579
|
*/
|
|
1580
|
-
Marker?: string;
|
|
1580
|
+
Marker?: string | undefined;
|
|
1581
1581
|
}
|
|
1582
1582
|
/**
|
|
1583
1583
|
* @public
|
|
@@ -1587,12 +1587,12 @@ export interface DescribeActivitiesResponse {
|
|
|
1587
1587
|
* <p>The list of activities for the specified user and time period.</p>
|
|
1588
1588
|
* @public
|
|
1589
1589
|
*/
|
|
1590
|
-
UserActivities?: Activity[];
|
|
1590
|
+
UserActivities?: Activity[] | undefined;
|
|
1591
1591
|
/**
|
|
1592
1592
|
* <p>The marker for the next set of results.</p>
|
|
1593
1593
|
* @public
|
|
1594
1594
|
*/
|
|
1595
|
-
Marker?: string;
|
|
1595
|
+
Marker?: string | undefined;
|
|
1596
1596
|
}
|
|
1597
1597
|
/**
|
|
1598
1598
|
* @public
|
|
@@ -1602,7 +1602,7 @@ export interface DescribeCommentsRequest {
|
|
|
1602
1602
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1603
1603
|
* @public
|
|
1604
1604
|
*/
|
|
1605
|
-
AuthenticationToken?: string;
|
|
1605
|
+
AuthenticationToken?: string | undefined;
|
|
1606
1606
|
/**
|
|
1607
1607
|
* <p>The ID of the document.</p>
|
|
1608
1608
|
* @public
|
|
@@ -1617,13 +1617,13 @@ export interface DescribeCommentsRequest {
|
|
|
1617
1617
|
* <p>The maximum number of items to return.</p>
|
|
1618
1618
|
* @public
|
|
1619
1619
|
*/
|
|
1620
|
-
Limit?: number;
|
|
1620
|
+
Limit?: number | undefined;
|
|
1621
1621
|
/**
|
|
1622
1622
|
* <p>The marker for the next set of results. This marker was received from a previous
|
|
1623
1623
|
* call.</p>
|
|
1624
1624
|
* @public
|
|
1625
1625
|
*/
|
|
1626
|
-
Marker?: string;
|
|
1626
|
+
Marker?: string | undefined;
|
|
1627
1627
|
}
|
|
1628
1628
|
/**
|
|
1629
1629
|
* @public
|
|
@@ -1633,13 +1633,13 @@ export interface DescribeCommentsResponse {
|
|
|
1633
1633
|
* <p>The list of comments for the specified document version.</p>
|
|
1634
1634
|
* @public
|
|
1635
1635
|
*/
|
|
1636
|
-
Comments?: Comment[];
|
|
1636
|
+
Comments?: Comment[] | undefined;
|
|
1637
1637
|
/**
|
|
1638
1638
|
* <p>The marker for the next set of results. This marker was received from a previous
|
|
1639
1639
|
* call.</p>
|
|
1640
1640
|
* @public
|
|
1641
1641
|
*/
|
|
1642
|
-
Marker?: string;
|
|
1642
|
+
Marker?: string | undefined;
|
|
1643
1643
|
}
|
|
1644
1644
|
/**
|
|
1645
1645
|
* @public
|
|
@@ -1649,7 +1649,7 @@ export interface DescribeDocumentVersionsRequest {
|
|
|
1649
1649
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1650
1650
|
* @public
|
|
1651
1651
|
*/
|
|
1652
|
-
AuthenticationToken?: string;
|
|
1652
|
+
AuthenticationToken?: string | undefined;
|
|
1653
1653
|
/**
|
|
1654
1654
|
* <p>The ID of the document.</p>
|
|
1655
1655
|
* @public
|
|
@@ -1660,24 +1660,24 @@ export interface DescribeDocumentVersionsRequest {
|
|
|
1660
1660
|
* call.)</p>
|
|
1661
1661
|
* @public
|
|
1662
1662
|
*/
|
|
1663
|
-
Marker?: string;
|
|
1663
|
+
Marker?: string | undefined;
|
|
1664
1664
|
/**
|
|
1665
1665
|
* <p>The maximum number of versions to return with this call.</p>
|
|
1666
1666
|
* @public
|
|
1667
1667
|
*/
|
|
1668
|
-
Limit?: number;
|
|
1668
|
+
Limit?: number | undefined;
|
|
1669
1669
|
/**
|
|
1670
1670
|
* <p>A comma-separated list of values. Specify "INITIALIZED" to include incomplete
|
|
1671
1671
|
* versions.</p>
|
|
1672
1672
|
* @public
|
|
1673
1673
|
*/
|
|
1674
|
-
Include?: string;
|
|
1674
|
+
Include?: string | undefined;
|
|
1675
1675
|
/**
|
|
1676
1676
|
* <p>Specify "SOURCE" to include initialized versions and a URL for the source
|
|
1677
1677
|
* document.</p>
|
|
1678
1678
|
* @public
|
|
1679
1679
|
*/
|
|
1680
|
-
Fields?: string;
|
|
1680
|
+
Fields?: string | undefined;
|
|
1681
1681
|
}
|
|
1682
1682
|
/**
|
|
1683
1683
|
* @public
|
|
@@ -1725,67 +1725,67 @@ export interface DocumentVersionMetadata {
|
|
|
1725
1725
|
* <p>The ID of the version.</p>
|
|
1726
1726
|
* @public
|
|
1727
1727
|
*/
|
|
1728
|
-
Id?: string;
|
|
1728
|
+
Id?: string | undefined;
|
|
1729
1729
|
/**
|
|
1730
1730
|
* <p>The name of the version.</p>
|
|
1731
1731
|
* @public
|
|
1732
1732
|
*/
|
|
1733
|
-
Name?: string;
|
|
1733
|
+
Name?: string | undefined;
|
|
1734
1734
|
/**
|
|
1735
1735
|
* <p>The content type of the document.</p>
|
|
1736
1736
|
* @public
|
|
1737
1737
|
*/
|
|
1738
|
-
ContentType?: string;
|
|
1738
|
+
ContentType?: string | undefined;
|
|
1739
1739
|
/**
|
|
1740
1740
|
* <p>The size of the document, in bytes.</p>
|
|
1741
1741
|
* @public
|
|
1742
1742
|
*/
|
|
1743
|
-
Size?: number;
|
|
1743
|
+
Size?: number | undefined;
|
|
1744
1744
|
/**
|
|
1745
1745
|
* <p>The signature of the document.</p>
|
|
1746
1746
|
* @public
|
|
1747
1747
|
*/
|
|
1748
|
-
Signature?: string;
|
|
1748
|
+
Signature?: string | undefined;
|
|
1749
1749
|
/**
|
|
1750
1750
|
* <p>The status of the document.</p>
|
|
1751
1751
|
* @public
|
|
1752
1752
|
*/
|
|
1753
|
-
Status?: DocumentStatusType;
|
|
1753
|
+
Status?: DocumentStatusType | undefined;
|
|
1754
1754
|
/**
|
|
1755
1755
|
* <p>The timestamp when the document was first uploaded.</p>
|
|
1756
1756
|
* @public
|
|
1757
1757
|
*/
|
|
1758
|
-
CreatedTimestamp?: Date;
|
|
1758
|
+
CreatedTimestamp?: Date | undefined;
|
|
1759
1759
|
/**
|
|
1760
1760
|
* <p>The timestamp when the document was last uploaded.</p>
|
|
1761
1761
|
* @public
|
|
1762
1762
|
*/
|
|
1763
|
-
ModifiedTimestamp?: Date;
|
|
1763
|
+
ModifiedTimestamp?: Date | undefined;
|
|
1764
1764
|
/**
|
|
1765
1765
|
* <p>The timestamp when the content of the document was originally created.</p>
|
|
1766
1766
|
* @public
|
|
1767
1767
|
*/
|
|
1768
|
-
ContentCreatedTimestamp?: Date;
|
|
1768
|
+
ContentCreatedTimestamp?: Date | undefined;
|
|
1769
1769
|
/**
|
|
1770
1770
|
* <p>The timestamp when the content of the document was modified.</p>
|
|
1771
1771
|
* @public
|
|
1772
1772
|
*/
|
|
1773
|
-
ContentModifiedTimestamp?: Date;
|
|
1773
|
+
ContentModifiedTimestamp?: Date | undefined;
|
|
1774
1774
|
/**
|
|
1775
1775
|
* <p>The ID of the creator.</p>
|
|
1776
1776
|
* @public
|
|
1777
1777
|
*/
|
|
1778
|
-
CreatorId?: string;
|
|
1778
|
+
CreatorId?: string | undefined;
|
|
1779
1779
|
/**
|
|
1780
1780
|
* <p>The thumbnail of the document.</p>
|
|
1781
1781
|
* @public
|
|
1782
1782
|
*/
|
|
1783
|
-
Thumbnail?: Partial<Record<DocumentThumbnailType, string
|
|
1783
|
+
Thumbnail?: Partial<Record<DocumentThumbnailType, string>> | undefined;
|
|
1784
1784
|
/**
|
|
1785
1785
|
* <p>The source of the document.</p>
|
|
1786
1786
|
* @public
|
|
1787
1787
|
*/
|
|
1788
|
-
Source?: Partial<Record<DocumentSourceType, string
|
|
1788
|
+
Source?: Partial<Record<DocumentSourceType, string>> | undefined;
|
|
1789
1789
|
}
|
|
1790
1790
|
/**
|
|
1791
1791
|
* @public
|
|
@@ -1795,13 +1795,13 @@ export interface DescribeDocumentVersionsResponse {
|
|
|
1795
1795
|
* <p>The document versions.</p>
|
|
1796
1796
|
* @public
|
|
1797
1797
|
*/
|
|
1798
|
-
DocumentVersions?: DocumentVersionMetadata[];
|
|
1798
|
+
DocumentVersions?: DocumentVersionMetadata[] | undefined;
|
|
1799
1799
|
/**
|
|
1800
1800
|
* <p>The marker to use when requesting the next set of results. If there are no
|
|
1801
1801
|
* additional results, the string is empty.</p>
|
|
1802
1802
|
* @public
|
|
1803
1803
|
*/
|
|
1804
|
-
Marker?: string;
|
|
1804
|
+
Marker?: string | undefined;
|
|
1805
1805
|
}
|
|
1806
1806
|
/**
|
|
1807
1807
|
* <p>The password is invalid.</p>
|
|
@@ -1810,7 +1810,7 @@ export interface DescribeDocumentVersionsResponse {
|
|
|
1810
1810
|
export declare class InvalidPasswordException extends __BaseException {
|
|
1811
1811
|
readonly name: "InvalidPasswordException";
|
|
1812
1812
|
readonly $fault: "client";
|
|
1813
|
-
Message?: string;
|
|
1813
|
+
Message?: string | undefined;
|
|
1814
1814
|
/**
|
|
1815
1815
|
* @internal
|
|
1816
1816
|
*/
|
|
@@ -1861,7 +1861,7 @@ export interface DescribeFolderContentsRequest {
|
|
|
1861
1861
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1862
1862
|
* @public
|
|
1863
1863
|
*/
|
|
1864
|
-
AuthenticationToken?: string;
|
|
1864
|
+
AuthenticationToken?: string | undefined;
|
|
1865
1865
|
/**
|
|
1866
1866
|
* <p>The ID of the folder.</p>
|
|
1867
1867
|
* @public
|
|
@@ -1871,34 +1871,34 @@ export interface DescribeFolderContentsRequest {
|
|
|
1871
1871
|
* <p>The sorting criteria.</p>
|
|
1872
1872
|
* @public
|
|
1873
1873
|
*/
|
|
1874
|
-
Sort?: ResourceSortType;
|
|
1874
|
+
Sort?: ResourceSortType | undefined;
|
|
1875
1875
|
/**
|
|
1876
1876
|
* <p>The order for the contents of the folder.</p>
|
|
1877
1877
|
* @public
|
|
1878
1878
|
*/
|
|
1879
|
-
Order?: OrderType;
|
|
1879
|
+
Order?: OrderType | undefined;
|
|
1880
1880
|
/**
|
|
1881
1881
|
* <p>The maximum number of items to return with this call.</p>
|
|
1882
1882
|
* @public
|
|
1883
1883
|
*/
|
|
1884
|
-
Limit?: number;
|
|
1884
|
+
Limit?: number | undefined;
|
|
1885
1885
|
/**
|
|
1886
1886
|
* <p>The marker for the next set of results. This marker was received from a previous
|
|
1887
1887
|
* call.</p>
|
|
1888
1888
|
* @public
|
|
1889
1889
|
*/
|
|
1890
|
-
Marker?: string;
|
|
1890
|
+
Marker?: string | undefined;
|
|
1891
1891
|
/**
|
|
1892
1892
|
* <p>The type of items.</p>
|
|
1893
1893
|
* @public
|
|
1894
1894
|
*/
|
|
1895
|
-
Type?: FolderContentType;
|
|
1895
|
+
Type?: FolderContentType | undefined;
|
|
1896
1896
|
/**
|
|
1897
1897
|
* <p>The contents to include. Specify "INITIALIZED" to include initialized
|
|
1898
1898
|
* documents.</p>
|
|
1899
1899
|
* @public
|
|
1900
1900
|
*/
|
|
1901
|
-
Include?: string;
|
|
1901
|
+
Include?: string | undefined;
|
|
1902
1902
|
}
|
|
1903
1903
|
/**
|
|
1904
1904
|
* <p>Describes the document.</p>
|
|
@@ -1909,42 +1909,42 @@ export interface DocumentMetadata {
|
|
|
1909
1909
|
* <p>The ID of the document.</p>
|
|
1910
1910
|
* @public
|
|
1911
1911
|
*/
|
|
1912
|
-
Id?: string;
|
|
1912
|
+
Id?: string | undefined;
|
|
1913
1913
|
/**
|
|
1914
1914
|
* <p>The ID of the creator.</p>
|
|
1915
1915
|
* @public
|
|
1916
1916
|
*/
|
|
1917
|
-
CreatorId?: string;
|
|
1917
|
+
CreatorId?: string | undefined;
|
|
1918
1918
|
/**
|
|
1919
1919
|
* <p>The ID of the parent folder.</p>
|
|
1920
1920
|
* @public
|
|
1921
1921
|
*/
|
|
1922
|
-
ParentFolderId?: string;
|
|
1922
|
+
ParentFolderId?: string | undefined;
|
|
1923
1923
|
/**
|
|
1924
1924
|
* <p>The time when the document was created.</p>
|
|
1925
1925
|
* @public
|
|
1926
1926
|
*/
|
|
1927
|
-
CreatedTimestamp?: Date;
|
|
1927
|
+
CreatedTimestamp?: Date | undefined;
|
|
1928
1928
|
/**
|
|
1929
1929
|
* <p>The time when the document was updated.</p>
|
|
1930
1930
|
* @public
|
|
1931
1931
|
*/
|
|
1932
|
-
ModifiedTimestamp?: Date;
|
|
1932
|
+
ModifiedTimestamp?: Date | undefined;
|
|
1933
1933
|
/**
|
|
1934
1934
|
* <p>The latest version of the document.</p>
|
|
1935
1935
|
* @public
|
|
1936
1936
|
*/
|
|
1937
|
-
LatestVersionMetadata?: DocumentVersionMetadata;
|
|
1937
|
+
LatestVersionMetadata?: DocumentVersionMetadata | undefined;
|
|
1938
1938
|
/**
|
|
1939
1939
|
* <p>The resource state.</p>
|
|
1940
1940
|
* @public
|
|
1941
1941
|
*/
|
|
1942
|
-
ResourceState?: ResourceStateType;
|
|
1942
|
+
ResourceState?: ResourceStateType | undefined;
|
|
1943
1943
|
/**
|
|
1944
1944
|
* <p>List of labels on the document.</p>
|
|
1945
1945
|
* @public
|
|
1946
1946
|
*/
|
|
1947
|
-
Labels?: string[];
|
|
1947
|
+
Labels?: string[] | undefined;
|
|
1948
1948
|
}
|
|
1949
1949
|
/**
|
|
1950
1950
|
* @public
|
|
@@ -1954,18 +1954,18 @@ export interface DescribeFolderContentsResponse {
|
|
|
1954
1954
|
* <p>The subfolders in the specified folder.</p>
|
|
1955
1955
|
* @public
|
|
1956
1956
|
*/
|
|
1957
|
-
Folders?: FolderMetadata[];
|
|
1957
|
+
Folders?: FolderMetadata[] | undefined;
|
|
1958
1958
|
/**
|
|
1959
1959
|
* <p>The documents in the specified folder.</p>
|
|
1960
1960
|
* @public
|
|
1961
1961
|
*/
|
|
1962
|
-
Documents?: DocumentMetadata[];
|
|
1962
|
+
Documents?: DocumentMetadata[] | undefined;
|
|
1963
1963
|
/**
|
|
1964
1964
|
* <p>The marker to use when requesting the next set of results. If there are no
|
|
1965
1965
|
* additional results, the string is empty.</p>
|
|
1966
1966
|
* @public
|
|
1967
1967
|
*/
|
|
1968
|
-
Marker?: string;
|
|
1968
|
+
Marker?: string | undefined;
|
|
1969
1969
|
}
|
|
1970
1970
|
/**
|
|
1971
1971
|
* @public
|
|
@@ -1975,7 +1975,7 @@ export interface DescribeGroupsRequest {
|
|
|
1975
1975
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1976
1976
|
* @public
|
|
1977
1977
|
*/
|
|
1978
|
-
AuthenticationToken?: string;
|
|
1978
|
+
AuthenticationToken?: string | undefined;
|
|
1979
1979
|
/**
|
|
1980
1980
|
* <p>A query to describe groups by group name.</p>
|
|
1981
1981
|
* @public
|
|
@@ -1985,18 +1985,18 @@ export interface DescribeGroupsRequest {
|
|
|
1985
1985
|
* <p>The ID of the organization.</p>
|
|
1986
1986
|
* @public
|
|
1987
1987
|
*/
|
|
1988
|
-
OrganizationId?: string;
|
|
1988
|
+
OrganizationId?: string | undefined;
|
|
1989
1989
|
/**
|
|
1990
1990
|
* <p>The marker for the next set of results. (You received this marker from a previous
|
|
1991
1991
|
* call.)</p>
|
|
1992
1992
|
* @public
|
|
1993
1993
|
*/
|
|
1994
|
-
Marker?: string;
|
|
1994
|
+
Marker?: string | undefined;
|
|
1995
1995
|
/**
|
|
1996
1996
|
* <p>The maximum number of items to return with this call.</p>
|
|
1997
1997
|
* @public
|
|
1998
1998
|
*/
|
|
1999
|
-
Limit?: number;
|
|
1999
|
+
Limit?: number | undefined;
|
|
2000
2000
|
}
|
|
2001
2001
|
/**
|
|
2002
2002
|
* @public
|
|
@@ -2006,13 +2006,13 @@ export interface DescribeGroupsResponse {
|
|
|
2006
2006
|
* <p>The list of groups.</p>
|
|
2007
2007
|
* @public
|
|
2008
2008
|
*/
|
|
2009
|
-
Groups?: GroupMetadata[];
|
|
2009
|
+
Groups?: GroupMetadata[] | undefined;
|
|
2010
2010
|
/**
|
|
2011
2011
|
* <p>The marker to use when requesting the next set of results. If there are no additional
|
|
2012
2012
|
* results, the string is empty.</p>
|
|
2013
2013
|
* @public
|
|
2014
2014
|
*/
|
|
2015
|
-
Marker?: string;
|
|
2015
|
+
Marker?: string | undefined;
|
|
2016
2016
|
}
|
|
2017
2017
|
/**
|
|
2018
2018
|
* @public
|
|
@@ -2028,12 +2028,12 @@ export interface DescribeNotificationSubscriptionsRequest {
|
|
|
2028
2028
|
* call.)</p>
|
|
2029
2029
|
* @public
|
|
2030
2030
|
*/
|
|
2031
|
-
Marker?: string;
|
|
2031
|
+
Marker?: string | undefined;
|
|
2032
2032
|
/**
|
|
2033
2033
|
* <p>The maximum number of items to return with this call.</p>
|
|
2034
2034
|
* @public
|
|
2035
2035
|
*/
|
|
2036
|
-
Limit?: number;
|
|
2036
|
+
Limit?: number | undefined;
|
|
2037
2037
|
}
|
|
2038
2038
|
/**
|
|
2039
2039
|
* @public
|
|
@@ -2043,13 +2043,13 @@ export interface DescribeNotificationSubscriptionsResponse {
|
|
|
2043
2043
|
* <p>The subscriptions.</p>
|
|
2044
2044
|
* @public
|
|
2045
2045
|
*/
|
|
2046
|
-
Subscriptions?: Subscription[];
|
|
2046
|
+
Subscriptions?: Subscription[] | undefined;
|
|
2047
2047
|
/**
|
|
2048
2048
|
* <p>The marker to use when requesting the next set of results. If there are no
|
|
2049
2049
|
* additional results, the string is empty.</p>
|
|
2050
2050
|
* @public
|
|
2051
2051
|
*/
|
|
2052
|
-
Marker?: string;
|
|
2052
|
+
Marker?: string | undefined;
|
|
2053
2053
|
}
|
|
2054
2054
|
/**
|
|
2055
2055
|
* @public
|
|
@@ -2059,7 +2059,7 @@ export interface DescribeResourcePermissionsRequest {
|
|
|
2059
2059
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2060
2060
|
* @public
|
|
2061
2061
|
*/
|
|
2062
|
-
AuthenticationToken?: string;
|
|
2062
|
+
AuthenticationToken?: string | undefined;
|
|
2063
2063
|
/**
|
|
2064
2064
|
* <p>The ID of the resource.</p>
|
|
2065
2065
|
* @public
|
|
@@ -2069,18 +2069,18 @@ export interface DescribeResourcePermissionsRequest {
|
|
|
2069
2069
|
* <p>The ID of the principal to filter permissions by.</p>
|
|
2070
2070
|
* @public
|
|
2071
2071
|
*/
|
|
2072
|
-
PrincipalId?: string;
|
|
2072
|
+
PrincipalId?: string | undefined;
|
|
2073
2073
|
/**
|
|
2074
2074
|
* <p>The maximum number of items to return with this call.</p>
|
|
2075
2075
|
* @public
|
|
2076
2076
|
*/
|
|
2077
|
-
Limit?: number;
|
|
2077
|
+
Limit?: number | undefined;
|
|
2078
2078
|
/**
|
|
2079
2079
|
* <p>The marker for the next set of results. (You received this marker from a previous
|
|
2080
2080
|
* call)</p>
|
|
2081
2081
|
* @public
|
|
2082
2082
|
*/
|
|
2083
|
-
Marker?: string;
|
|
2083
|
+
Marker?: string | undefined;
|
|
2084
2084
|
}
|
|
2085
2085
|
/**
|
|
2086
2086
|
* @public
|
|
@@ -2103,12 +2103,12 @@ export interface PermissionInfo {
|
|
|
2103
2103
|
* <p>The role of the user.</p>
|
|
2104
2104
|
* @public
|
|
2105
2105
|
*/
|
|
2106
|
-
Role?: RoleType;
|
|
2106
|
+
Role?: RoleType | undefined;
|
|
2107
2107
|
/**
|
|
2108
2108
|
* <p>The type of permissions.</p>
|
|
2109
2109
|
* @public
|
|
2110
2110
|
*/
|
|
2111
|
-
Type?: RolePermissionType;
|
|
2111
|
+
Type?: RolePermissionType | undefined;
|
|
2112
2112
|
}
|
|
2113
2113
|
/**
|
|
2114
2114
|
* <p>Describes a resource.</p>
|
|
@@ -2119,17 +2119,17 @@ export interface Principal {
|
|
|
2119
2119
|
* <p>The ID of the resource.</p>
|
|
2120
2120
|
* @public
|
|
2121
2121
|
*/
|
|
2122
|
-
Id?: string;
|
|
2122
|
+
Id?: string | undefined;
|
|
2123
2123
|
/**
|
|
2124
2124
|
* <p>The type of resource.</p>
|
|
2125
2125
|
* @public
|
|
2126
2126
|
*/
|
|
2127
|
-
Type?: PrincipalType;
|
|
2127
|
+
Type?: PrincipalType | undefined;
|
|
2128
2128
|
/**
|
|
2129
2129
|
* <p>The permission information for the resource.</p>
|
|
2130
2130
|
* @public
|
|
2131
2131
|
*/
|
|
2132
|
-
Roles?: PermissionInfo[];
|
|
2132
|
+
Roles?: PermissionInfo[] | undefined;
|
|
2133
2133
|
}
|
|
2134
2134
|
/**
|
|
2135
2135
|
* @public
|
|
@@ -2139,13 +2139,13 @@ export interface DescribeResourcePermissionsResponse {
|
|
|
2139
2139
|
* <p>The principals.</p>
|
|
2140
2140
|
* @public
|
|
2141
2141
|
*/
|
|
2142
|
-
Principals?: Principal[];
|
|
2142
|
+
Principals?: Principal[] | undefined;
|
|
2143
2143
|
/**
|
|
2144
2144
|
* <p>The marker to use when requesting the next set of results. If there are no
|
|
2145
2145
|
* additional results, the string is empty.</p>
|
|
2146
2146
|
* @public
|
|
2147
2147
|
*/
|
|
2148
|
-
Marker?: string;
|
|
2148
|
+
Marker?: string | undefined;
|
|
2149
2149
|
}
|
|
2150
2150
|
/**
|
|
2151
2151
|
* @public
|
|
@@ -2160,13 +2160,13 @@ export interface DescribeRootFoldersRequest {
|
|
|
2160
2160
|
* <p>The maximum number of items to return.</p>
|
|
2161
2161
|
* @public
|
|
2162
2162
|
*/
|
|
2163
|
-
Limit?: number;
|
|
2163
|
+
Limit?: number | undefined;
|
|
2164
2164
|
/**
|
|
2165
2165
|
* <p>The marker for the next set of results. (You received this marker from a previous
|
|
2166
2166
|
* call.)</p>
|
|
2167
2167
|
* @public
|
|
2168
2168
|
*/
|
|
2169
|
-
Marker?: string;
|
|
2169
|
+
Marker?: string | undefined;
|
|
2170
2170
|
}
|
|
2171
2171
|
/**
|
|
2172
2172
|
* @public
|
|
@@ -2176,12 +2176,12 @@ export interface DescribeRootFoldersResponse {
|
|
|
2176
2176
|
* <p>The user's special folders.</p>
|
|
2177
2177
|
* @public
|
|
2178
2178
|
*/
|
|
2179
|
-
Folders?: FolderMetadata[];
|
|
2179
|
+
Folders?: FolderMetadata[] | undefined;
|
|
2180
2180
|
/**
|
|
2181
2181
|
* <p>The marker for the next set of results.</p>
|
|
2182
2182
|
* @public
|
|
2183
2183
|
*/
|
|
2184
|
-
Marker?: string;
|
|
2184
|
+
Marker?: string | undefined;
|
|
2185
2185
|
}
|
|
2186
2186
|
/**
|
|
2187
2187
|
* @public
|
|
@@ -2218,17 +2218,17 @@ export interface DescribeUsersRequest {
|
|
|
2218
2218
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2219
2219
|
* @public
|
|
2220
2220
|
*/
|
|
2221
|
-
AuthenticationToken?: string;
|
|
2221
|
+
AuthenticationToken?: string | undefined;
|
|
2222
2222
|
/**
|
|
2223
2223
|
* <p>The ID of the organization.</p>
|
|
2224
2224
|
* @public
|
|
2225
2225
|
*/
|
|
2226
|
-
OrganizationId?: string;
|
|
2226
|
+
OrganizationId?: string | undefined;
|
|
2227
2227
|
/**
|
|
2228
2228
|
* <p>The IDs of the users.</p>
|
|
2229
2229
|
* @public
|
|
2230
2230
|
*/
|
|
2231
|
-
UserIds?: string;
|
|
2231
|
+
UserIds?: string | undefined;
|
|
2232
2232
|
/**
|
|
2233
2233
|
* <p>A query to filter users by user name. Remember the following about the <code>Userids</code> and <code>Query</code> parameters:</p>
|
|
2234
2234
|
* <ul>
|
|
@@ -2250,39 +2250,39 @@ export interface DescribeUsersRequest {
|
|
|
2250
2250
|
* </ul>
|
|
2251
2251
|
* @public
|
|
2252
2252
|
*/
|
|
2253
|
-
Query?: string;
|
|
2253
|
+
Query?: string | undefined;
|
|
2254
2254
|
/**
|
|
2255
2255
|
* <p>The state of the users. Specify "ALL" to include inactive users.</p>
|
|
2256
2256
|
* @public
|
|
2257
2257
|
*/
|
|
2258
|
-
Include?: UserFilterType;
|
|
2258
|
+
Include?: UserFilterType | undefined;
|
|
2259
2259
|
/**
|
|
2260
2260
|
* <p>The order for the results.</p>
|
|
2261
2261
|
* @public
|
|
2262
2262
|
*/
|
|
2263
|
-
Order?: OrderType;
|
|
2263
|
+
Order?: OrderType | undefined;
|
|
2264
2264
|
/**
|
|
2265
2265
|
* <p>The sorting criteria.</p>
|
|
2266
2266
|
* @public
|
|
2267
2267
|
*/
|
|
2268
|
-
Sort?: UserSortType;
|
|
2268
|
+
Sort?: UserSortType | undefined;
|
|
2269
2269
|
/**
|
|
2270
2270
|
* <p>The marker for the next set of results. (You received this marker from a previous
|
|
2271
2271
|
* call.)</p>
|
|
2272
2272
|
* @public
|
|
2273
2273
|
*/
|
|
2274
|
-
Marker?: string;
|
|
2274
|
+
Marker?: string | undefined;
|
|
2275
2275
|
/**
|
|
2276
2276
|
* <p>The maximum number of items to return.</p>
|
|
2277
2277
|
* @public
|
|
2278
2278
|
*/
|
|
2279
|
-
Limit?: number;
|
|
2279
|
+
Limit?: number | undefined;
|
|
2280
2280
|
/**
|
|
2281
2281
|
* <p>A comma-separated list of values. Specify "STORAGE_METADATA" to include the user
|
|
2282
2282
|
* storage quota and utilization information.</p>
|
|
2283
2283
|
* @public
|
|
2284
2284
|
*/
|
|
2285
|
-
Fields?: string;
|
|
2285
|
+
Fields?: string | undefined;
|
|
2286
2286
|
}
|
|
2287
2287
|
/**
|
|
2288
2288
|
* @public
|
|
@@ -2292,20 +2292,20 @@ export interface DescribeUsersResponse {
|
|
|
2292
2292
|
* <p>The users.</p>
|
|
2293
2293
|
* @public
|
|
2294
2294
|
*/
|
|
2295
|
-
Users?: User[];
|
|
2295
|
+
Users?: User[] | undefined;
|
|
2296
2296
|
/**
|
|
2297
2297
|
* @deprecated
|
|
2298
2298
|
*
|
|
2299
2299
|
* <p>The total number of users included in the results.</p>
|
|
2300
2300
|
* @public
|
|
2301
2301
|
*/
|
|
2302
|
-
TotalNumberOfUsers?: number;
|
|
2302
|
+
TotalNumberOfUsers?: number | undefined;
|
|
2303
2303
|
/**
|
|
2304
2304
|
* <p>The marker to use when requesting the next set of results. If there are no
|
|
2305
2305
|
* additional results, the string is empty.</p>
|
|
2306
2306
|
* @public
|
|
2307
2307
|
*/
|
|
2308
|
-
Marker?: string;
|
|
2308
|
+
Marker?: string | undefined;
|
|
2309
2309
|
}
|
|
2310
2310
|
/**
|
|
2311
2311
|
* <p>The response is too large to return. The request must include a filter to reduce the size of the response.</p>
|
|
@@ -2314,7 +2314,7 @@ export interface DescribeUsersResponse {
|
|
|
2314
2314
|
export declare class RequestedEntityTooLargeException extends __BaseException {
|
|
2315
2315
|
readonly name: "RequestedEntityTooLargeException";
|
|
2316
2316
|
readonly $fault: "client";
|
|
2317
|
-
Message?: string;
|
|
2317
|
+
Message?: string | undefined;
|
|
2318
2318
|
/**
|
|
2319
2319
|
* @internal
|
|
2320
2320
|
*/
|
|
@@ -2338,7 +2338,7 @@ export interface GetCurrentUserResponse {
|
|
|
2338
2338
|
* <p>Metadata of the user.</p>
|
|
2339
2339
|
* @public
|
|
2340
2340
|
*/
|
|
2341
|
-
User?: User;
|
|
2341
|
+
User?: User | undefined;
|
|
2342
2342
|
}
|
|
2343
2343
|
/**
|
|
2344
2344
|
* @public
|
|
@@ -2348,7 +2348,7 @@ export interface GetDocumentRequest {
|
|
|
2348
2348
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2349
2349
|
* @public
|
|
2350
2350
|
*/
|
|
2351
|
-
AuthenticationToken?: string;
|
|
2351
|
+
AuthenticationToken?: string | undefined;
|
|
2352
2352
|
/**
|
|
2353
2353
|
* <p>The ID of the document.</p>
|
|
2354
2354
|
* @public
|
|
@@ -2358,7 +2358,7 @@ export interface GetDocumentRequest {
|
|
|
2358
2358
|
* <p>Set this to <code>TRUE</code> to include custom metadata in the response.</p>
|
|
2359
2359
|
* @public
|
|
2360
2360
|
*/
|
|
2361
|
-
IncludeCustomMetadata?: boolean;
|
|
2361
|
+
IncludeCustomMetadata?: boolean | undefined;
|
|
2362
2362
|
}
|
|
2363
2363
|
/**
|
|
2364
2364
|
* @public
|
|
@@ -2368,12 +2368,12 @@ export interface GetDocumentResponse {
|
|
|
2368
2368
|
* <p>The metadata details of the document.</p>
|
|
2369
2369
|
* @public
|
|
2370
2370
|
*/
|
|
2371
|
-
Metadata?: DocumentMetadata;
|
|
2371
|
+
Metadata?: DocumentMetadata | undefined;
|
|
2372
2372
|
/**
|
|
2373
2373
|
* <p>The custom metadata on the document.</p>
|
|
2374
2374
|
* @public
|
|
2375
2375
|
*/
|
|
2376
|
-
CustomMetadata?: Record<string, string
|
|
2376
|
+
CustomMetadata?: Record<string, string> | undefined;
|
|
2377
2377
|
}
|
|
2378
2378
|
/**
|
|
2379
2379
|
* @public
|
|
@@ -2383,7 +2383,7 @@ export interface GetDocumentPathRequest {
|
|
|
2383
2383
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2384
2384
|
* @public
|
|
2385
2385
|
*/
|
|
2386
|
-
AuthenticationToken?: string;
|
|
2386
|
+
AuthenticationToken?: string | undefined;
|
|
2387
2387
|
/**
|
|
2388
2388
|
* <p>The ID of the document.</p>
|
|
2389
2389
|
* @public
|
|
@@ -2393,18 +2393,18 @@ export interface GetDocumentPathRequest {
|
|
|
2393
2393
|
* <p>The maximum number of levels in the hierarchy to return.</p>
|
|
2394
2394
|
* @public
|
|
2395
2395
|
*/
|
|
2396
|
-
Limit?: number;
|
|
2396
|
+
Limit?: number | undefined;
|
|
2397
2397
|
/**
|
|
2398
2398
|
* <p>A comma-separated list of values. Specify <code>NAME</code> to include the names of
|
|
2399
2399
|
* the parent folders.</p>
|
|
2400
2400
|
* @public
|
|
2401
2401
|
*/
|
|
2402
|
-
Fields?: string;
|
|
2402
|
+
Fields?: string | undefined;
|
|
2403
2403
|
/**
|
|
2404
2404
|
* <p>This value is not supported.</p>
|
|
2405
2405
|
* @public
|
|
2406
2406
|
*/
|
|
2407
|
-
Marker?: string;
|
|
2407
|
+
Marker?: string | undefined;
|
|
2408
2408
|
}
|
|
2409
2409
|
/**
|
|
2410
2410
|
* <p>Describes the resource path.</p>
|
|
@@ -2415,12 +2415,12 @@ export interface ResourcePathComponent {
|
|
|
2415
2415
|
* <p>The ID of the resource path.</p>
|
|
2416
2416
|
* @public
|
|
2417
2417
|
*/
|
|
2418
|
-
Id?: string;
|
|
2418
|
+
Id?: string | undefined;
|
|
2419
2419
|
/**
|
|
2420
2420
|
* <p>The name of the resource path.</p>
|
|
2421
2421
|
* @public
|
|
2422
2422
|
*/
|
|
2423
|
-
Name?: string;
|
|
2423
|
+
Name?: string | undefined;
|
|
2424
2424
|
}
|
|
2425
2425
|
/**
|
|
2426
2426
|
* <p>Describes the path information of a resource.</p>
|
|
@@ -2431,7 +2431,7 @@ export interface ResourcePath {
|
|
|
2431
2431
|
* <p>The components of the resource path.</p>
|
|
2432
2432
|
* @public
|
|
2433
2433
|
*/
|
|
2434
|
-
Components?: ResourcePathComponent[];
|
|
2434
|
+
Components?: ResourcePathComponent[] | undefined;
|
|
2435
2435
|
}
|
|
2436
2436
|
/**
|
|
2437
2437
|
* @public
|
|
@@ -2441,7 +2441,7 @@ export interface GetDocumentPathResponse {
|
|
|
2441
2441
|
* <p>The path information.</p>
|
|
2442
2442
|
* @public
|
|
2443
2443
|
*/
|
|
2444
|
-
Path?: ResourcePath;
|
|
2444
|
+
Path?: ResourcePath | undefined;
|
|
2445
2445
|
}
|
|
2446
2446
|
/**
|
|
2447
2447
|
* @public
|
|
@@ -2451,7 +2451,7 @@ export interface GetDocumentVersionRequest {
|
|
|
2451
2451
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2452
2452
|
* @public
|
|
2453
2453
|
*/
|
|
2454
|
-
AuthenticationToken?: string;
|
|
2454
|
+
AuthenticationToken?: string | undefined;
|
|
2455
2455
|
/**
|
|
2456
2456
|
* <p>The ID of the document.</p>
|
|
2457
2457
|
* @public
|
|
@@ -2467,12 +2467,12 @@ export interface GetDocumentVersionRequest {
|
|
|
2467
2467
|
* document.</p>
|
|
2468
2468
|
* @public
|
|
2469
2469
|
*/
|
|
2470
|
-
Fields?: string;
|
|
2470
|
+
Fields?: string | undefined;
|
|
2471
2471
|
/**
|
|
2472
2472
|
* <p>Set this to TRUE to include custom metadata in the response.</p>
|
|
2473
2473
|
* @public
|
|
2474
2474
|
*/
|
|
2475
|
-
IncludeCustomMetadata?: boolean;
|
|
2475
|
+
IncludeCustomMetadata?: boolean | undefined;
|
|
2476
2476
|
}
|
|
2477
2477
|
/**
|
|
2478
2478
|
* @public
|
|
@@ -2482,12 +2482,12 @@ export interface GetDocumentVersionResponse {
|
|
|
2482
2482
|
* <p>The version metadata.</p>
|
|
2483
2483
|
* @public
|
|
2484
2484
|
*/
|
|
2485
|
-
Metadata?: DocumentVersionMetadata;
|
|
2485
|
+
Metadata?: DocumentVersionMetadata | undefined;
|
|
2486
2486
|
/**
|
|
2487
2487
|
* <p>The custom metadata on the document version.</p>
|
|
2488
2488
|
* @public
|
|
2489
2489
|
*/
|
|
2490
|
-
CustomMetadata?: Record<string, string
|
|
2490
|
+
CustomMetadata?: Record<string, string> | undefined;
|
|
2491
2491
|
}
|
|
2492
2492
|
/**
|
|
2493
2493
|
* @public
|
|
@@ -2497,7 +2497,7 @@ export interface GetFolderRequest {
|
|
|
2497
2497
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2498
2498
|
* @public
|
|
2499
2499
|
*/
|
|
2500
|
-
AuthenticationToken?: string;
|
|
2500
|
+
AuthenticationToken?: string | undefined;
|
|
2501
2501
|
/**
|
|
2502
2502
|
* <p>The ID of the folder.</p>
|
|
2503
2503
|
* @public
|
|
@@ -2507,7 +2507,7 @@ export interface GetFolderRequest {
|
|
|
2507
2507
|
* <p>Set to TRUE to include custom metadata in the response.</p>
|
|
2508
2508
|
* @public
|
|
2509
2509
|
*/
|
|
2510
|
-
IncludeCustomMetadata?: boolean;
|
|
2510
|
+
IncludeCustomMetadata?: boolean | undefined;
|
|
2511
2511
|
}
|
|
2512
2512
|
/**
|
|
2513
2513
|
* @public
|
|
@@ -2517,12 +2517,12 @@ export interface GetFolderResponse {
|
|
|
2517
2517
|
* <p>The metadata of the folder.</p>
|
|
2518
2518
|
* @public
|
|
2519
2519
|
*/
|
|
2520
|
-
Metadata?: FolderMetadata;
|
|
2520
|
+
Metadata?: FolderMetadata | undefined;
|
|
2521
2521
|
/**
|
|
2522
2522
|
* <p>The custom metadata on the folder.</p>
|
|
2523
2523
|
* @public
|
|
2524
2524
|
*/
|
|
2525
|
-
CustomMetadata?: Record<string, string
|
|
2525
|
+
CustomMetadata?: Record<string, string> | undefined;
|
|
2526
2526
|
}
|
|
2527
2527
|
/**
|
|
2528
2528
|
* @public
|
|
@@ -2532,7 +2532,7 @@ export interface GetFolderPathRequest {
|
|
|
2532
2532
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2533
2533
|
* @public
|
|
2534
2534
|
*/
|
|
2535
|
-
AuthenticationToken?: string;
|
|
2535
|
+
AuthenticationToken?: string | undefined;
|
|
2536
2536
|
/**
|
|
2537
2537
|
* <p>The ID of the folder.</p>
|
|
2538
2538
|
* @public
|
|
@@ -2542,18 +2542,18 @@ export interface GetFolderPathRequest {
|
|
|
2542
2542
|
* <p>The maximum number of levels in the hierarchy to return.</p>
|
|
2543
2543
|
* @public
|
|
2544
2544
|
*/
|
|
2545
|
-
Limit?: number;
|
|
2545
|
+
Limit?: number | undefined;
|
|
2546
2546
|
/**
|
|
2547
2547
|
* <p>A comma-separated list of values. Specify "NAME" to include the names of the parent
|
|
2548
2548
|
* folders.</p>
|
|
2549
2549
|
* @public
|
|
2550
2550
|
*/
|
|
2551
|
-
Fields?: string;
|
|
2551
|
+
Fields?: string | undefined;
|
|
2552
2552
|
/**
|
|
2553
2553
|
* <p>This value is not supported.</p>
|
|
2554
2554
|
* @public
|
|
2555
2555
|
*/
|
|
2556
|
-
Marker?: string;
|
|
2556
|
+
Marker?: string | undefined;
|
|
2557
2557
|
}
|
|
2558
2558
|
/**
|
|
2559
2559
|
* @public
|
|
@@ -2563,7 +2563,7 @@ export interface GetFolderPathResponse {
|
|
|
2563
2563
|
* <p>The path information.</p>
|
|
2564
2564
|
* @public
|
|
2565
2565
|
*/
|
|
2566
|
-
Path?: ResourcePath;
|
|
2566
|
+
Path?: ResourcePath | undefined;
|
|
2567
2567
|
}
|
|
2568
2568
|
/**
|
|
2569
2569
|
* @public
|
|
@@ -2584,28 +2584,28 @@ export interface GetResourcesRequest {
|
|
|
2584
2584
|
* <p>The Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2585
2585
|
* @public
|
|
2586
2586
|
*/
|
|
2587
|
-
AuthenticationToken?: string;
|
|
2587
|
+
AuthenticationToken?: string | undefined;
|
|
2588
2588
|
/**
|
|
2589
2589
|
* <p>The user ID for the resource collection. This is a required field for accessing the
|
|
2590
2590
|
* API operation using IAM credentials.</p>
|
|
2591
2591
|
* @public
|
|
2592
2592
|
*/
|
|
2593
|
-
UserId?: string;
|
|
2593
|
+
UserId?: string | undefined;
|
|
2594
2594
|
/**
|
|
2595
2595
|
* <p>The collection type.</p>
|
|
2596
2596
|
* @public
|
|
2597
2597
|
*/
|
|
2598
|
-
CollectionType?: ResourceCollectionType;
|
|
2598
|
+
CollectionType?: ResourceCollectionType | undefined;
|
|
2599
2599
|
/**
|
|
2600
2600
|
* <p>The maximum number of resources to return.</p>
|
|
2601
2601
|
* @public
|
|
2602
2602
|
*/
|
|
2603
|
-
Limit?: number;
|
|
2603
|
+
Limit?: number | undefined;
|
|
2604
2604
|
/**
|
|
2605
2605
|
* <p>The marker for the next set of results. This marker was received from a previous call.</p>
|
|
2606
2606
|
* @public
|
|
2607
2607
|
*/
|
|
2608
|
-
Marker?: string;
|
|
2608
|
+
Marker?: string | undefined;
|
|
2609
2609
|
}
|
|
2610
2610
|
/**
|
|
2611
2611
|
* @public
|
|
@@ -2615,17 +2615,17 @@ export interface GetResourcesResponse {
|
|
|
2615
2615
|
* <p>The folders in the specified folder.</p>
|
|
2616
2616
|
* @public
|
|
2617
2617
|
*/
|
|
2618
|
-
Folders?: FolderMetadata[];
|
|
2618
|
+
Folders?: FolderMetadata[] | undefined;
|
|
2619
2619
|
/**
|
|
2620
2620
|
* <p>The documents in the specified collection.</p>
|
|
2621
2621
|
* @public
|
|
2622
2622
|
*/
|
|
2623
|
-
Documents?: DocumentMetadata[];
|
|
2623
|
+
Documents?: DocumentMetadata[] | undefined;
|
|
2624
2624
|
/**
|
|
2625
2625
|
* <p>The marker to use when requesting the next set of results. If there are no additional results, the string is empty.</p>
|
|
2626
2626
|
* @public
|
|
2627
2627
|
*/
|
|
2628
|
-
Marker?: string;
|
|
2628
|
+
Marker?: string | undefined;
|
|
2629
2629
|
}
|
|
2630
2630
|
/**
|
|
2631
2631
|
* <p>This exception is thrown when a valid checkout ID is not presented on document
|
|
@@ -2635,7 +2635,7 @@ export interface GetResourcesResponse {
|
|
|
2635
2635
|
export declare class DraftUploadOutOfSyncException extends __BaseException {
|
|
2636
2636
|
readonly name: "DraftUploadOutOfSyncException";
|
|
2637
2637
|
readonly $fault: "client";
|
|
2638
|
-
Message?: string;
|
|
2638
|
+
Message?: string | undefined;
|
|
2639
2639
|
/**
|
|
2640
2640
|
* @internal
|
|
2641
2641
|
*/
|
|
@@ -2649,42 +2649,42 @@ export interface InitiateDocumentVersionUploadRequest {
|
|
|
2649
2649
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2650
2650
|
* @public
|
|
2651
2651
|
*/
|
|
2652
|
-
AuthenticationToken?: string;
|
|
2652
|
+
AuthenticationToken?: string | undefined;
|
|
2653
2653
|
/**
|
|
2654
2654
|
* <p>The ID of the document.</p>
|
|
2655
2655
|
* @public
|
|
2656
2656
|
*/
|
|
2657
|
-
Id?: string;
|
|
2657
|
+
Id?: string | undefined;
|
|
2658
2658
|
/**
|
|
2659
2659
|
* <p>The name of the document.</p>
|
|
2660
2660
|
* @public
|
|
2661
2661
|
*/
|
|
2662
|
-
Name?: string;
|
|
2662
|
+
Name?: string | undefined;
|
|
2663
2663
|
/**
|
|
2664
2664
|
* <p>The timestamp when the content of the document was originally created.</p>
|
|
2665
2665
|
* @public
|
|
2666
2666
|
*/
|
|
2667
|
-
ContentCreatedTimestamp?: Date;
|
|
2667
|
+
ContentCreatedTimestamp?: Date | undefined;
|
|
2668
2668
|
/**
|
|
2669
2669
|
* <p>The timestamp when the content of the document was modified.</p>
|
|
2670
2670
|
* @public
|
|
2671
2671
|
*/
|
|
2672
|
-
ContentModifiedTimestamp?: Date;
|
|
2672
|
+
ContentModifiedTimestamp?: Date | undefined;
|
|
2673
2673
|
/**
|
|
2674
2674
|
* <p>The content type of the document.</p>
|
|
2675
2675
|
* @public
|
|
2676
2676
|
*/
|
|
2677
|
-
ContentType?: string;
|
|
2677
|
+
ContentType?: string | undefined;
|
|
2678
2678
|
/**
|
|
2679
2679
|
* <p>The size of the document, in bytes.</p>
|
|
2680
2680
|
* @public
|
|
2681
2681
|
*/
|
|
2682
|
-
DocumentSizeInBytes?: number;
|
|
2682
|
+
DocumentSizeInBytes?: number | undefined;
|
|
2683
2683
|
/**
|
|
2684
2684
|
* <p>The ID of the parent folder.</p>
|
|
2685
2685
|
* @public
|
|
2686
2686
|
*/
|
|
2687
|
-
ParentFolderId?: string;
|
|
2687
|
+
ParentFolderId?: string | undefined;
|
|
2688
2688
|
}
|
|
2689
2689
|
/**
|
|
2690
2690
|
* <p>Describes the upload.</p>
|
|
@@ -2695,12 +2695,12 @@ export interface UploadMetadata {
|
|
|
2695
2695
|
* <p>The URL of the upload.</p>
|
|
2696
2696
|
* @public
|
|
2697
2697
|
*/
|
|
2698
|
-
UploadUrl?: string;
|
|
2698
|
+
UploadUrl?: string | undefined;
|
|
2699
2699
|
/**
|
|
2700
2700
|
* <p>The signed headers.</p>
|
|
2701
2701
|
* @public
|
|
2702
2702
|
*/
|
|
2703
|
-
SignedHeaders?: Record<string, string
|
|
2703
|
+
SignedHeaders?: Record<string, string> | undefined;
|
|
2704
2704
|
}
|
|
2705
2705
|
/**
|
|
2706
2706
|
* @public
|
|
@@ -2710,12 +2710,12 @@ export interface InitiateDocumentVersionUploadResponse {
|
|
|
2710
2710
|
* <p>The document metadata.</p>
|
|
2711
2711
|
* @public
|
|
2712
2712
|
*/
|
|
2713
|
-
Metadata?: DocumentMetadata;
|
|
2713
|
+
Metadata?: DocumentMetadata | undefined;
|
|
2714
2714
|
/**
|
|
2715
2715
|
* <p>The upload metadata.</p>
|
|
2716
2716
|
* @public
|
|
2717
2717
|
*/
|
|
2718
|
-
UploadMetadata?: UploadMetadata;
|
|
2718
|
+
UploadMetadata?: UploadMetadata | undefined;
|
|
2719
2719
|
}
|
|
2720
2720
|
/**
|
|
2721
2721
|
* <p>The resource is already checked out.</p>
|
|
@@ -2724,7 +2724,7 @@ export interface InitiateDocumentVersionUploadResponse {
|
|
|
2724
2724
|
export declare class ResourceAlreadyCheckedOutException extends __BaseException {
|
|
2725
2725
|
readonly name: "ResourceAlreadyCheckedOutException";
|
|
2726
2726
|
readonly $fault: "client";
|
|
2727
|
-
Message?: string;
|
|
2727
|
+
Message?: string | undefined;
|
|
2728
2728
|
/**
|
|
2729
2729
|
* @internal
|
|
2730
2730
|
*/
|
|
@@ -2737,7 +2737,7 @@ export declare class ResourceAlreadyCheckedOutException extends __BaseException
|
|
|
2737
2737
|
export declare class StorageLimitExceededException extends __BaseException {
|
|
2738
2738
|
readonly name: "StorageLimitExceededException";
|
|
2739
2739
|
readonly $fault: "client";
|
|
2740
|
-
Message?: string;
|
|
2740
|
+
Message?: string | undefined;
|
|
2741
2741
|
/**
|
|
2742
2742
|
* @internal
|
|
2743
2743
|
*/
|
|
@@ -2750,7 +2750,7 @@ export declare class StorageLimitExceededException extends __BaseException {
|
|
|
2750
2750
|
export declare class StorageLimitWillExceedException extends __BaseException {
|
|
2751
2751
|
readonly name: "StorageLimitWillExceedException";
|
|
2752
2752
|
readonly $fault: "client";
|
|
2753
|
-
Message?: string;
|
|
2753
|
+
Message?: string | undefined;
|
|
2754
2754
|
/**
|
|
2755
2755
|
* @internal
|
|
2756
2756
|
*/
|
|
@@ -2764,7 +2764,7 @@ export interface RemoveAllResourcePermissionsRequest {
|
|
|
2764
2764
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2765
2765
|
* @public
|
|
2766
2766
|
*/
|
|
2767
|
-
AuthenticationToken?: string;
|
|
2767
|
+
AuthenticationToken?: string | undefined;
|
|
2768
2768
|
/**
|
|
2769
2769
|
* <p>The ID of the resource.</p>
|
|
2770
2770
|
* @public
|
|
@@ -2779,7 +2779,7 @@ export interface RemoveResourcePermissionRequest {
|
|
|
2779
2779
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2780
2780
|
* @public
|
|
2781
2781
|
*/
|
|
2782
|
-
AuthenticationToken?: string;
|
|
2782
|
+
AuthenticationToken?: string | undefined;
|
|
2783
2783
|
/**
|
|
2784
2784
|
* <p>The ID of the resource.</p>
|
|
2785
2785
|
* @public
|
|
@@ -2794,7 +2794,7 @@ export interface RemoveResourcePermissionRequest {
|
|
|
2794
2794
|
* <p>The principal type of the resource.</p>
|
|
2795
2795
|
* @public
|
|
2796
2796
|
*/
|
|
2797
|
-
PrincipalType?: PrincipalType;
|
|
2797
|
+
PrincipalType?: PrincipalType | undefined;
|
|
2798
2798
|
}
|
|
2799
2799
|
/**
|
|
2800
2800
|
* @public
|
|
@@ -2804,7 +2804,7 @@ export interface RestoreDocumentVersionsRequest {
|
|
|
2804
2804
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2805
2805
|
* @public
|
|
2806
2806
|
*/
|
|
2807
|
-
AuthenticationToken?: string;
|
|
2807
|
+
AuthenticationToken?: string | undefined;
|
|
2808
2808
|
/**
|
|
2809
2809
|
* <p>The ID of the document.</p>
|
|
2810
2810
|
* @public
|
|
@@ -2839,12 +2839,12 @@ export interface DateRangeType {
|
|
|
2839
2839
|
* <p>Timestamp range start value (in epochs)</p>
|
|
2840
2840
|
* @public
|
|
2841
2841
|
*/
|
|
2842
|
-
StartValue?: Date;
|
|
2842
|
+
StartValue?: Date | undefined;
|
|
2843
2843
|
/**
|
|
2844
2844
|
* <p>Timestamp range end value (in epochs).</p>
|
|
2845
2845
|
* @public
|
|
2846
2846
|
*/
|
|
2847
|
-
EndValue?: Date;
|
|
2847
|
+
EndValue?: Date | undefined;
|
|
2848
2848
|
}
|
|
2849
2849
|
/**
|
|
2850
2850
|
* @public
|
|
@@ -2874,7 +2874,7 @@ export interface SearchPrincipalType {
|
|
|
2874
2874
|
* <p>The Role of a User or Group.</p>
|
|
2875
2875
|
* @public
|
|
2876
2876
|
*/
|
|
2877
|
-
Roles?: PrincipalRoleType[];
|
|
2877
|
+
Roles?: PrincipalRoleType[] | undefined;
|
|
2878
2878
|
}
|
|
2879
2879
|
/**
|
|
2880
2880
|
* @public
|
|
@@ -2911,12 +2911,12 @@ export interface LongRangeType {
|
|
|
2911
2911
|
* <p>The size start range (in bytes).</p>
|
|
2912
2912
|
* @public
|
|
2913
2913
|
*/
|
|
2914
|
-
StartValue?: number;
|
|
2914
|
+
StartValue?: number | undefined;
|
|
2915
2915
|
/**
|
|
2916
2916
|
* <p>The size end range (in bytes).</p>
|
|
2917
2917
|
* @public
|
|
2918
2918
|
*/
|
|
2919
|
-
EndValue?: number;
|
|
2919
|
+
EndValue?: number | undefined;
|
|
2920
2920
|
}
|
|
2921
2921
|
/**
|
|
2922
2922
|
* @public
|
|
@@ -2968,52 +2968,52 @@ export interface Filters {
|
|
|
2968
2968
|
* <p>Filters by the locale of the content or comment.</p>
|
|
2969
2969
|
* @public
|
|
2970
2970
|
*/
|
|
2971
|
-
TextLocales?: LanguageCodeType[];
|
|
2971
|
+
TextLocales?: LanguageCodeType[] | undefined;
|
|
2972
2972
|
/**
|
|
2973
2973
|
* <p>Filters by content category.</p>
|
|
2974
2974
|
* @public
|
|
2975
2975
|
*/
|
|
2976
|
-
ContentCategories?: ContentCategoryType[];
|
|
2976
|
+
ContentCategories?: ContentCategoryType[] | undefined;
|
|
2977
2977
|
/**
|
|
2978
2978
|
* <p>Filters based on entity type.</p>
|
|
2979
2979
|
* @public
|
|
2980
2980
|
*/
|
|
2981
|
-
ResourceTypes?: SearchResourceType[];
|
|
2981
|
+
ResourceTypes?: SearchResourceType[] | undefined;
|
|
2982
2982
|
/**
|
|
2983
2983
|
* <p>Filter by labels using exact match.</p>
|
|
2984
2984
|
* @public
|
|
2985
2985
|
*/
|
|
2986
|
-
Labels?: string[];
|
|
2986
|
+
Labels?: string[] | undefined;
|
|
2987
2987
|
/**
|
|
2988
2988
|
* <p>Filter based on UserIds or GroupIds.</p>
|
|
2989
2989
|
* @public
|
|
2990
2990
|
*/
|
|
2991
|
-
Principals?: SearchPrincipalType[];
|
|
2991
|
+
Principals?: SearchPrincipalType[] | undefined;
|
|
2992
2992
|
/**
|
|
2993
2993
|
* <p>Filter based on resource’s path.</p>
|
|
2994
2994
|
* @public
|
|
2995
2995
|
*/
|
|
2996
|
-
AncestorIds?: string[];
|
|
2996
|
+
AncestorIds?: string[] | undefined;
|
|
2997
2997
|
/**
|
|
2998
2998
|
* <p>Filter based on file groupings.</p>
|
|
2999
2999
|
* @public
|
|
3000
3000
|
*/
|
|
3001
|
-
SearchCollectionTypes?: SearchCollectionType[];
|
|
3001
|
+
SearchCollectionTypes?: SearchCollectionType[] | undefined;
|
|
3002
3002
|
/**
|
|
3003
3003
|
* <p>Filter based on size (in bytes).</p>
|
|
3004
3004
|
* @public
|
|
3005
3005
|
*/
|
|
3006
|
-
SizeRange?: LongRangeType;
|
|
3006
|
+
SizeRange?: LongRangeType | undefined;
|
|
3007
3007
|
/**
|
|
3008
3008
|
* <p>Filter based on resource’s creation timestamp.</p>
|
|
3009
3009
|
* @public
|
|
3010
3010
|
*/
|
|
3011
|
-
CreatedRange?: DateRangeType;
|
|
3011
|
+
CreatedRange?: DateRangeType | undefined;
|
|
3012
3012
|
/**
|
|
3013
3013
|
* <p>Filter based on resource’s modified timestamp.</p>
|
|
3014
3014
|
* @public
|
|
3015
3015
|
*/
|
|
3016
|
-
ModifiedRange?: DateRangeType;
|
|
3016
|
+
ModifiedRange?: DateRangeType | undefined;
|
|
3017
3017
|
}
|
|
3018
3018
|
/**
|
|
3019
3019
|
* @public
|
|
@@ -3051,12 +3051,12 @@ export interface SearchSortResult {
|
|
|
3051
3051
|
* <p>Sort search results based on this field name.</p>
|
|
3052
3052
|
* @public
|
|
3053
3053
|
*/
|
|
3054
|
-
Field?: OrderByFieldType;
|
|
3054
|
+
Field?: OrderByFieldType | undefined;
|
|
3055
3055
|
/**
|
|
3056
3056
|
* <p>Sort direction.</p>
|
|
3057
3057
|
* @public
|
|
3058
3058
|
*/
|
|
3059
|
-
Order?: SortOrder;
|
|
3059
|
+
Order?: SortOrder | undefined;
|
|
3060
3060
|
}
|
|
3061
3061
|
/**
|
|
3062
3062
|
* @public
|
|
@@ -3078,48 +3078,48 @@ export interface SearchResourcesRequest {
|
|
|
3078
3078
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
3079
3079
|
* @public
|
|
3080
3080
|
*/
|
|
3081
|
-
AuthenticationToken?: string;
|
|
3081
|
+
AuthenticationToken?: string | undefined;
|
|
3082
3082
|
/**
|
|
3083
3083
|
* <p>The String to search for. Searches across different text fields based on request parameters. Use double quotes around the query string for exact phrase matches.</p>
|
|
3084
3084
|
* @public
|
|
3085
3085
|
*/
|
|
3086
|
-
QueryText?: string;
|
|
3086
|
+
QueryText?: string | undefined;
|
|
3087
3087
|
/**
|
|
3088
3088
|
* <p>Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content</p>
|
|
3089
3089
|
* @public
|
|
3090
3090
|
*/
|
|
3091
|
-
QueryScopes?: SearchQueryScopeType[];
|
|
3091
|
+
QueryScopes?: SearchQueryScopeType[] | undefined;
|
|
3092
3092
|
/**
|
|
3093
3093
|
* <p>Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.</p>
|
|
3094
3094
|
* @public
|
|
3095
3095
|
*/
|
|
3096
|
-
OrganizationId?: string;
|
|
3096
|
+
OrganizationId?: string | undefined;
|
|
3097
3097
|
/**
|
|
3098
3098
|
* <p>A list of attributes to include in the response. Used to request fields that are not normally
|
|
3099
3099
|
* returned in a standard response.</p>
|
|
3100
3100
|
* @public
|
|
3101
3101
|
*/
|
|
3102
|
-
AdditionalResponseFields?: AdditionalResponseFieldType[];
|
|
3102
|
+
AdditionalResponseFields?: AdditionalResponseFieldType[] | undefined;
|
|
3103
3103
|
/**
|
|
3104
3104
|
* <p>Filters results based on entity metadata.</p>
|
|
3105
3105
|
* @public
|
|
3106
3106
|
*/
|
|
3107
|
-
Filters?: Filters;
|
|
3107
|
+
Filters?: Filters | undefined;
|
|
3108
3108
|
/**
|
|
3109
3109
|
* <p>Order by results in one or more categories.</p>
|
|
3110
3110
|
* @public
|
|
3111
3111
|
*/
|
|
3112
|
-
OrderBy?: SearchSortResult[];
|
|
3112
|
+
OrderBy?: SearchSortResult[] | undefined;
|
|
3113
3113
|
/**
|
|
3114
3114
|
* <p>Max results count per page.</p>
|
|
3115
3115
|
* @public
|
|
3116
3116
|
*/
|
|
3117
|
-
Limit?: number;
|
|
3117
|
+
Limit?: number | undefined;
|
|
3118
3118
|
/**
|
|
3119
3119
|
* <p>The marker for the next set of results.</p>
|
|
3120
3120
|
* @public
|
|
3121
3121
|
*/
|
|
3122
|
-
Marker?: string;
|
|
3122
|
+
Marker?: string | undefined;
|
|
3123
3123
|
}
|
|
3124
3124
|
/**
|
|
3125
3125
|
* @public
|
|
@@ -3144,32 +3144,32 @@ export interface ResponseItem {
|
|
|
3144
3144
|
* <p>The type of item being returned.</p>
|
|
3145
3145
|
* @public
|
|
3146
3146
|
*/
|
|
3147
|
-
ResourceType?: ResponseItemType;
|
|
3147
|
+
ResourceType?: ResponseItemType | undefined;
|
|
3148
3148
|
/**
|
|
3149
3149
|
* <p>The webUrl of the item being returned.</p>
|
|
3150
3150
|
* @public
|
|
3151
3151
|
*/
|
|
3152
|
-
WebUrl?: string;
|
|
3152
|
+
WebUrl?: string | undefined;
|
|
3153
3153
|
/**
|
|
3154
3154
|
* <p>The document that matches the query.</p>
|
|
3155
3155
|
* @public
|
|
3156
3156
|
*/
|
|
3157
|
-
DocumentMetadata?: DocumentMetadata;
|
|
3157
|
+
DocumentMetadata?: DocumentMetadata | undefined;
|
|
3158
3158
|
/**
|
|
3159
3159
|
* <p>The folder that matches the query.</p>
|
|
3160
3160
|
* @public
|
|
3161
3161
|
*/
|
|
3162
|
-
FolderMetadata?: FolderMetadata;
|
|
3162
|
+
FolderMetadata?: FolderMetadata | undefined;
|
|
3163
3163
|
/**
|
|
3164
3164
|
* <p>The comment that matches the query.</p>
|
|
3165
3165
|
* @public
|
|
3166
3166
|
*/
|
|
3167
|
-
CommentMetadata?: CommentMetadata;
|
|
3167
|
+
CommentMetadata?: CommentMetadata | undefined;
|
|
3168
3168
|
/**
|
|
3169
3169
|
* <p>The document version that matches the metadata.</p>
|
|
3170
3170
|
* @public
|
|
3171
3171
|
*/
|
|
3172
|
-
DocumentVersionMetadata?: DocumentVersionMetadata;
|
|
3172
|
+
DocumentVersionMetadata?: DocumentVersionMetadata | undefined;
|
|
3173
3173
|
}
|
|
3174
3174
|
/**
|
|
3175
3175
|
* @public
|
|
@@ -3179,12 +3179,12 @@ export interface SearchResourcesResponse {
|
|
|
3179
3179
|
* <p>List of Documents, Folders, Comments, and Document Versions matching the query.</p>
|
|
3180
3180
|
* @public
|
|
3181
3181
|
*/
|
|
3182
|
-
Items?: ResponseItem[];
|
|
3182
|
+
Items?: ResponseItem[] | undefined;
|
|
3183
3183
|
/**
|
|
3184
3184
|
* <p>The marker to use when requesting the next set of results. If there are no additional results, the string is empty.</p>
|
|
3185
3185
|
* @public
|
|
3186
3186
|
*/
|
|
3187
|
-
Marker?: string;
|
|
3187
|
+
Marker?: string | undefined;
|
|
3188
3188
|
}
|
|
3189
3189
|
/**
|
|
3190
3190
|
* @public
|
|
@@ -3194,7 +3194,7 @@ export interface UpdateDocumentRequest {
|
|
|
3194
3194
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
3195
3195
|
* @public
|
|
3196
3196
|
*/
|
|
3197
|
-
AuthenticationToken?: string;
|
|
3197
|
+
AuthenticationToken?: string | undefined;
|
|
3198
3198
|
/**
|
|
3199
3199
|
* <p>The ID of the document.</p>
|
|
3200
3200
|
* @public
|
|
@@ -3204,18 +3204,18 @@ export interface UpdateDocumentRequest {
|
|
|
3204
3204
|
* <p>The name of the document.</p>
|
|
3205
3205
|
* @public
|
|
3206
3206
|
*/
|
|
3207
|
-
Name?: string;
|
|
3207
|
+
Name?: string | undefined;
|
|
3208
3208
|
/**
|
|
3209
3209
|
* <p>The ID of the parent folder.</p>
|
|
3210
3210
|
* @public
|
|
3211
3211
|
*/
|
|
3212
|
-
ParentFolderId?: string;
|
|
3212
|
+
ParentFolderId?: string | undefined;
|
|
3213
3213
|
/**
|
|
3214
3214
|
* <p>The resource state of the document. Only ACTIVE and RECYCLED are
|
|
3215
3215
|
* supported.</p>
|
|
3216
3216
|
* @public
|
|
3217
3217
|
*/
|
|
3218
|
-
ResourceState?: ResourceStateType;
|
|
3218
|
+
ResourceState?: ResourceStateType | undefined;
|
|
3219
3219
|
}
|
|
3220
3220
|
/**
|
|
3221
3221
|
* @public
|
|
@@ -3236,7 +3236,7 @@ export interface UpdateDocumentVersionRequest {
|
|
|
3236
3236
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
3237
3237
|
* @public
|
|
3238
3238
|
*/
|
|
3239
|
-
AuthenticationToken?: string;
|
|
3239
|
+
AuthenticationToken?: string | undefined;
|
|
3240
3240
|
/**
|
|
3241
3241
|
* <p>The ID of the document.</p>
|
|
3242
3242
|
* @public
|
|
@@ -3251,7 +3251,7 @@ export interface UpdateDocumentVersionRequest {
|
|
|
3251
3251
|
* <p>The status of the version.</p>
|
|
3252
3252
|
* @public
|
|
3253
3253
|
*/
|
|
3254
|
-
VersionStatus?: DocumentVersionStatus;
|
|
3254
|
+
VersionStatus?: DocumentVersionStatus | undefined;
|
|
3255
3255
|
}
|
|
3256
3256
|
/**
|
|
3257
3257
|
* @public
|
|
@@ -3261,7 +3261,7 @@ export interface UpdateFolderRequest {
|
|
|
3261
3261
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
3262
3262
|
* @public
|
|
3263
3263
|
*/
|
|
3264
|
-
AuthenticationToken?: string;
|
|
3264
|
+
AuthenticationToken?: string | undefined;
|
|
3265
3265
|
/**
|
|
3266
3266
|
* <p>The ID of the folder.</p>
|
|
3267
3267
|
* @public
|
|
@@ -3271,18 +3271,18 @@ export interface UpdateFolderRequest {
|
|
|
3271
3271
|
* <p>The name of the folder.</p>
|
|
3272
3272
|
* @public
|
|
3273
3273
|
*/
|
|
3274
|
-
Name?: string;
|
|
3274
|
+
Name?: string | undefined;
|
|
3275
3275
|
/**
|
|
3276
3276
|
* <p>The ID of the parent folder.</p>
|
|
3277
3277
|
* @public
|
|
3278
3278
|
*/
|
|
3279
|
-
ParentFolderId?: string;
|
|
3279
|
+
ParentFolderId?: string | undefined;
|
|
3280
3280
|
/**
|
|
3281
3281
|
* <p>The resource state of the folder. Only ACTIVE and RECYCLED are accepted values from
|
|
3282
3282
|
* the API.</p>
|
|
3283
3283
|
* @public
|
|
3284
3284
|
*/
|
|
3285
|
-
ResourceState?: ResourceStateType;
|
|
3285
|
+
ResourceState?: ResourceStateType | undefined;
|
|
3286
3286
|
}
|
|
3287
3287
|
/**
|
|
3288
3288
|
* <p>The last user in the organization is being deactivated.</p>
|
|
@@ -3291,8 +3291,8 @@ export interface UpdateFolderRequest {
|
|
|
3291
3291
|
export declare class DeactivatingLastSystemUserException extends __BaseException {
|
|
3292
3292
|
readonly name: "DeactivatingLastSystemUserException";
|
|
3293
3293
|
readonly $fault: "client";
|
|
3294
|
-
Message?: string;
|
|
3295
|
-
Code?: string;
|
|
3294
|
+
Message?: string | undefined;
|
|
3295
|
+
Code?: string | undefined;
|
|
3296
3296
|
/**
|
|
3297
3297
|
* @internal
|
|
3298
3298
|
*/
|
|
@@ -3305,7 +3305,7 @@ export declare class DeactivatingLastSystemUserException extends __BaseException
|
|
|
3305
3305
|
export declare class IllegalUserStateException extends __BaseException {
|
|
3306
3306
|
readonly name: "IllegalUserStateException";
|
|
3307
3307
|
readonly $fault: "client";
|
|
3308
|
-
Message?: string;
|
|
3308
|
+
Message?: string | undefined;
|
|
3309
3309
|
/**
|
|
3310
3310
|
* @internal
|
|
3311
3311
|
*/
|
|
@@ -3331,7 +3331,7 @@ export interface UpdateUserRequest {
|
|
|
3331
3331
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
3332
3332
|
* @public
|
|
3333
3333
|
*/
|
|
3334
|
-
AuthenticationToken?: string;
|
|
3334
|
+
AuthenticationToken?: string | undefined;
|
|
3335
3335
|
/**
|
|
3336
3336
|
* <p>The ID of the user.</p>
|
|
3337
3337
|
* @public
|
|
@@ -3341,37 +3341,37 @@ export interface UpdateUserRequest {
|
|
|
3341
3341
|
* <p>The given name of the user.</p>
|
|
3342
3342
|
* @public
|
|
3343
3343
|
*/
|
|
3344
|
-
GivenName?: string;
|
|
3344
|
+
GivenName?: string | undefined;
|
|
3345
3345
|
/**
|
|
3346
3346
|
* <p>The surname of the user.</p>
|
|
3347
3347
|
* @public
|
|
3348
3348
|
*/
|
|
3349
|
-
Surname?: string;
|
|
3349
|
+
Surname?: string | undefined;
|
|
3350
3350
|
/**
|
|
3351
3351
|
* <p>The type of the user.</p>
|
|
3352
3352
|
* @public
|
|
3353
3353
|
*/
|
|
3354
|
-
Type?: UserType;
|
|
3354
|
+
Type?: UserType | undefined;
|
|
3355
3355
|
/**
|
|
3356
3356
|
* <p>The amount of storage for the user.</p>
|
|
3357
3357
|
* @public
|
|
3358
3358
|
*/
|
|
3359
|
-
StorageRule?: StorageRuleType;
|
|
3359
|
+
StorageRule?: StorageRuleType | undefined;
|
|
3360
3360
|
/**
|
|
3361
3361
|
* <p>The time zone ID of the user.</p>
|
|
3362
3362
|
* @public
|
|
3363
3363
|
*/
|
|
3364
|
-
TimeZoneId?: string;
|
|
3364
|
+
TimeZoneId?: string | undefined;
|
|
3365
3365
|
/**
|
|
3366
3366
|
* <p>The locale of the user.</p>
|
|
3367
3367
|
* @public
|
|
3368
3368
|
*/
|
|
3369
|
-
Locale?: LocaleType;
|
|
3369
|
+
Locale?: LocaleType | undefined;
|
|
3370
3370
|
/**
|
|
3371
3371
|
* <p>Boolean value to determine whether the user is granted Power user privileges.</p>
|
|
3372
3372
|
* @public
|
|
3373
3373
|
*/
|
|
3374
|
-
GrantPoweruserPrivileges?: BooleanEnumType;
|
|
3374
|
+
GrantPoweruserPrivileges?: BooleanEnumType | undefined;
|
|
3375
3375
|
}
|
|
3376
3376
|
/**
|
|
3377
3377
|
* @public
|
|
@@ -3381,7 +3381,7 @@ export interface UpdateUserResponse {
|
|
|
3381
3381
|
* <p>The user information.</p>
|
|
3382
3382
|
* @public
|
|
3383
3383
|
*/
|
|
3384
|
-
User?: User;
|
|
3384
|
+
User?: User | undefined;
|
|
3385
3385
|
}
|
|
3386
3386
|
/**
|
|
3387
3387
|
* @internal
|