@aws-sdk/client-workdocs 3.533.0 → 3.540.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-cjs/endpoint/endpointResolver.js +4 -2
- package/dist-cjs/index.js +0 -3
- package/dist-es/endpoint/endpointResolver.js +3 -1
- package/dist-es/index.js +0 -1
- package/dist-types/WorkDocs.d.ts +6 -1
- package/dist-types/WorkDocsClient.d.ts +1 -1
- package/dist-types/commands/AbortDocumentVersionUploadCommand.d.ts +2 -1
- package/dist-types/commands/ActivateUserCommand.d.ts +2 -1
- package/dist-types/commands/AddResourcePermissionsCommand.d.ts +2 -1
- package/dist-types/commands/CreateCommentCommand.d.ts +2 -1
- package/dist-types/commands/CreateCustomMetadataCommand.d.ts +2 -1
- package/dist-types/commands/CreateFolderCommand.d.ts +2 -1
- package/dist-types/commands/CreateLabelsCommand.d.ts +2 -1
- package/dist-types/commands/CreateNotificationSubscriptionCommand.d.ts +2 -1
- package/dist-types/commands/CreateUserCommand.d.ts +2 -1
- package/dist-types/commands/DeactivateUserCommand.d.ts +2 -1
- package/dist-types/commands/DeleteCommentCommand.d.ts +2 -1
- package/dist-types/commands/DeleteCustomMetadataCommand.d.ts +2 -1
- package/dist-types/commands/DeleteDocumentCommand.d.ts +2 -1
- package/dist-types/commands/DeleteDocumentVersionCommand.d.ts +2 -1
- package/dist-types/commands/DeleteFolderCommand.d.ts +2 -1
- package/dist-types/commands/DeleteFolderContentsCommand.d.ts +2 -1
- package/dist-types/commands/DeleteLabelsCommand.d.ts +2 -1
- package/dist-types/commands/DeleteNotificationSubscriptionCommand.d.ts +2 -1
- package/dist-types/commands/DeleteUserCommand.d.ts +2 -1
- package/dist-types/commands/DescribeActivitiesCommand.d.ts +2 -1
- package/dist-types/commands/DescribeCommentsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeDocumentVersionsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeFolderContentsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeGroupsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeNotificationSubscriptionsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeResourcePermissionsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeRootFoldersCommand.d.ts +2 -1
- package/dist-types/commands/DescribeUsersCommand.d.ts +2 -1
- package/dist-types/commands/GetCurrentUserCommand.d.ts +2 -1
- package/dist-types/commands/GetDocumentCommand.d.ts +2 -1
- package/dist-types/commands/GetDocumentPathCommand.d.ts +2 -1
- package/dist-types/commands/GetDocumentVersionCommand.d.ts +2 -1
- package/dist-types/commands/GetFolderCommand.d.ts +2 -1
- package/dist-types/commands/GetFolderPathCommand.d.ts +2 -1
- package/dist-types/commands/GetResourcesCommand.d.ts +2 -1
- package/dist-types/commands/InitiateDocumentVersionUploadCommand.d.ts +2 -1
- package/dist-types/commands/RemoveAllResourcePermissionsCommand.d.ts +2 -1
- package/dist-types/commands/RemoveResourcePermissionCommand.d.ts +2 -1
- package/dist-types/commands/RestoreDocumentVersionsCommand.d.ts +2 -1
- package/dist-types/commands/SearchResourcesCommand.d.ts +2 -1
- package/dist-types/commands/UpdateDocumentCommand.d.ts +2 -1
- package/dist-types/commands/UpdateDocumentVersionCommand.d.ts +2 -1
- package/dist-types/commands/UpdateFolderCommand.d.ts +2 -1
- package/dist-types/commands/UpdateUserCommand.d.ts +2 -1
- package/dist-types/index.d.ts +0 -1
- package/dist-types/models/models_0.d.ts +435 -435
- package/dist-types/ts3.4/WorkDocs.d.ts +5 -0
- package/dist-types/ts3.4/commands/AbortDocumentVersionUploadCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ActivateUserCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/AddResourcePermissionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateCommentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateCustomMetadataCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateFolderCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateLabelsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateNotificationSubscriptionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateUserCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeactivateUserCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteCommentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteCustomMetadataCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteDocumentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteDocumentVersionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteFolderCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteFolderContentsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteLabelsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteNotificationSubscriptionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteUserCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeActivitiesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeCommentsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeDocumentVersionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeFolderContentsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeGroupsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeNotificationSubscriptionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeResourcePermissionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeRootFoldersCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeUsersCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetCurrentUserCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetDocumentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetDocumentPathCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetDocumentVersionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetFolderCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetFolderPathCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetResourcesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/InitiateDocumentVersionUploadCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RemoveAllResourcePermissionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RemoveResourcePermissionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RestoreDocumentVersionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchResourcesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateDocumentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateDocumentVersionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateFolderCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateUserCommand.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +0 -1
- package/package.json +40 -40
|
@@ -5,24 +5,24 @@ import { WorkDocsServiceException as __BaseException } from "./WorkDocsServiceEx
|
|
|
5
5
|
*/
|
|
6
6
|
export interface AbortDocumentVersionUploadRequest {
|
|
7
7
|
/**
|
|
8
|
-
* @public
|
|
9
8
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
9
|
+
* @public
|
|
10
10
|
*/
|
|
11
11
|
AuthenticationToken?: string;
|
|
12
12
|
/**
|
|
13
|
-
* @public
|
|
14
13
|
* <p>The ID of the document.</p>
|
|
14
|
+
* @public
|
|
15
15
|
*/
|
|
16
16
|
DocumentId: string | undefined;
|
|
17
17
|
/**
|
|
18
|
-
* @public
|
|
19
18
|
* <p>The ID of the version.</p>
|
|
19
|
+
* @public
|
|
20
20
|
*/
|
|
21
21
|
VersionId: string | undefined;
|
|
22
22
|
}
|
|
23
23
|
/**
|
|
24
|
-
* @public
|
|
25
24
|
* <p>The resource hierarchy is changing.</p>
|
|
25
|
+
* @public
|
|
26
26
|
*/
|
|
27
27
|
export declare class ConcurrentModificationException extends __BaseException {
|
|
28
28
|
readonly name: "ConcurrentModificationException";
|
|
@@ -34,16 +34,16 @@ export declare class ConcurrentModificationException extends __BaseException {
|
|
|
34
34
|
constructor(opts: __ExceptionOptionType<ConcurrentModificationException, __BaseException>);
|
|
35
35
|
}
|
|
36
36
|
/**
|
|
37
|
-
* @public
|
|
38
37
|
* <p>The resource does not exist.</p>
|
|
38
|
+
* @public
|
|
39
39
|
*/
|
|
40
40
|
export declare class EntityNotExistsException extends __BaseException {
|
|
41
41
|
readonly name: "EntityNotExistsException";
|
|
42
42
|
readonly $fault: "client";
|
|
43
43
|
Message?: string;
|
|
44
44
|
/**
|
|
45
|
-
* @public
|
|
46
45
|
* <p>The IDs of the non-existent resources.</p>
|
|
46
|
+
* @public
|
|
47
47
|
*/
|
|
48
48
|
EntityIds?: string[];
|
|
49
49
|
/**
|
|
@@ -52,10 +52,10 @@ export declare class EntityNotExistsException extends __BaseException {
|
|
|
52
52
|
constructor(opts: __ExceptionOptionType<EntityNotExistsException, __BaseException>);
|
|
53
53
|
}
|
|
54
54
|
/**
|
|
55
|
-
* @public
|
|
56
55
|
* <p>The Directory Service cannot reach an on-premises instance. Or a dependency
|
|
57
56
|
* under the control of the organization is failing, such as a connected Active
|
|
58
57
|
* Directory.</p>
|
|
58
|
+
* @public
|
|
59
59
|
*/
|
|
60
60
|
export declare class FailedDependencyException extends __BaseException {
|
|
61
61
|
readonly name: "FailedDependencyException";
|
|
@@ -67,8 +67,8 @@ export declare class FailedDependencyException extends __BaseException {
|
|
|
67
67
|
constructor(opts: __ExceptionOptionType<FailedDependencyException, __BaseException>);
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
70
|
-
* @public
|
|
71
70
|
* <p>The specified document version is not in the INITIALIZED state.</p>
|
|
71
|
+
* @public
|
|
72
72
|
*/
|
|
73
73
|
export declare class ProhibitedStateException extends __BaseException {
|
|
74
74
|
readonly name: "ProhibitedStateException";
|
|
@@ -80,8 +80,8 @@ export declare class ProhibitedStateException extends __BaseException {
|
|
|
80
80
|
constructor(opts: __ExceptionOptionType<ProhibitedStateException, __BaseException>);
|
|
81
81
|
}
|
|
82
82
|
/**
|
|
83
|
-
* @public
|
|
84
83
|
* <p>One or more of the dependencies is unavailable.</p>
|
|
84
|
+
* @public
|
|
85
85
|
*/
|
|
86
86
|
export declare class ServiceUnavailableException extends __BaseException {
|
|
87
87
|
readonly name: "ServiceUnavailableException";
|
|
@@ -93,8 +93,8 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
93
93
|
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
94
94
|
}
|
|
95
95
|
/**
|
|
96
|
-
* @public
|
|
97
96
|
* <p>The operation is not permitted.</p>
|
|
97
|
+
* @public
|
|
98
98
|
*/
|
|
99
99
|
export declare class UnauthorizedOperationException extends __BaseException {
|
|
100
100
|
readonly name: "UnauthorizedOperationException";
|
|
@@ -107,8 +107,8 @@ export declare class UnauthorizedOperationException extends __BaseException {
|
|
|
107
107
|
constructor(opts: __ExceptionOptionType<UnauthorizedOperationException, __BaseException>);
|
|
108
108
|
}
|
|
109
109
|
/**
|
|
110
|
-
* @public
|
|
111
110
|
* <p>The caller does not have access to perform the action on the resource.</p>
|
|
111
|
+
* @public
|
|
112
112
|
*/
|
|
113
113
|
export declare class UnauthorizedResourceAccessException extends __BaseException {
|
|
114
114
|
readonly name: "UnauthorizedResourceAccessException";
|
|
@@ -124,13 +124,13 @@ export declare class UnauthorizedResourceAccessException extends __BaseException
|
|
|
124
124
|
*/
|
|
125
125
|
export interface ActivateUserRequest {
|
|
126
126
|
/**
|
|
127
|
-
* @public
|
|
128
127
|
* <p>The ID of the user.</p>
|
|
128
|
+
* @public
|
|
129
129
|
*/
|
|
130
130
|
UserId: string | undefined;
|
|
131
131
|
/**
|
|
132
|
-
* @public
|
|
133
132
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
133
|
+
* @public
|
|
134
134
|
*/
|
|
135
135
|
AuthenticationToken?: string;
|
|
136
136
|
}
|
|
@@ -181,34 +181,34 @@ export declare const StorageType: {
|
|
|
181
181
|
*/
|
|
182
182
|
export type StorageType = (typeof StorageType)[keyof typeof StorageType];
|
|
183
183
|
/**
|
|
184
|
-
* @public
|
|
185
184
|
* <p>Describes the storage for a user.</p>
|
|
185
|
+
* @public
|
|
186
186
|
*/
|
|
187
187
|
export interface StorageRuleType {
|
|
188
188
|
/**
|
|
189
|
-
* @public
|
|
190
189
|
* <p>The amount of storage allocated, in bytes.</p>
|
|
190
|
+
* @public
|
|
191
191
|
*/
|
|
192
192
|
StorageAllocatedInBytes?: number;
|
|
193
193
|
/**
|
|
194
|
-
* @public
|
|
195
194
|
* <p>The type of storage.</p>
|
|
195
|
+
* @public
|
|
196
196
|
*/
|
|
197
197
|
StorageType?: StorageType;
|
|
198
198
|
}
|
|
199
199
|
/**
|
|
200
|
-
* @public
|
|
201
200
|
* <p>Describes the storage for a user.</p>
|
|
201
|
+
* @public
|
|
202
202
|
*/
|
|
203
203
|
export interface UserStorageMetadata {
|
|
204
204
|
/**
|
|
205
|
-
* @public
|
|
206
205
|
* <p>The amount of storage used, in bytes.</p>
|
|
206
|
+
* @public
|
|
207
207
|
*/
|
|
208
208
|
StorageUtilizedInBytes?: number;
|
|
209
209
|
/**
|
|
210
|
-
* @public
|
|
211
210
|
* <p>The storage for a user.</p>
|
|
211
|
+
* @public
|
|
212
212
|
*/
|
|
213
213
|
StorageRule?: StorageRuleType;
|
|
214
214
|
}
|
|
@@ -228,83 +228,83 @@ export declare const UserType: {
|
|
|
228
228
|
*/
|
|
229
229
|
export type UserType = (typeof UserType)[keyof typeof UserType];
|
|
230
230
|
/**
|
|
231
|
-
* @public
|
|
232
231
|
* <p>Describes a user.</p>
|
|
232
|
+
* @public
|
|
233
233
|
*/
|
|
234
234
|
export interface User {
|
|
235
235
|
/**
|
|
236
|
-
* @public
|
|
237
236
|
* <p>The ID of the user.</p>
|
|
237
|
+
* @public
|
|
238
238
|
*/
|
|
239
239
|
Id?: string;
|
|
240
240
|
/**
|
|
241
|
-
* @public
|
|
242
241
|
* <p>The login name of the user.</p>
|
|
242
|
+
* @public
|
|
243
243
|
*/
|
|
244
244
|
Username?: string;
|
|
245
245
|
/**
|
|
246
|
-
* @public
|
|
247
246
|
* <p>The email address of the user.</p>
|
|
247
|
+
* @public
|
|
248
248
|
*/
|
|
249
249
|
EmailAddress?: string;
|
|
250
250
|
/**
|
|
251
|
-
* @public
|
|
252
251
|
* <p>The given name of the user.</p>
|
|
252
|
+
* @public
|
|
253
253
|
*/
|
|
254
254
|
GivenName?: string;
|
|
255
255
|
/**
|
|
256
|
-
* @public
|
|
257
256
|
* <p>The surname of the user.</p>
|
|
257
|
+
* @public
|
|
258
258
|
*/
|
|
259
259
|
Surname?: string;
|
|
260
260
|
/**
|
|
261
|
-
* @public
|
|
262
261
|
* <p>The ID of the organization.</p>
|
|
262
|
+
* @public
|
|
263
263
|
*/
|
|
264
264
|
OrganizationId?: string;
|
|
265
265
|
/**
|
|
266
|
-
* @public
|
|
267
266
|
* <p>The ID of the root folder.</p>
|
|
267
|
+
* @public
|
|
268
268
|
*/
|
|
269
269
|
RootFolderId?: string;
|
|
270
270
|
/**
|
|
271
|
-
* @public
|
|
272
271
|
* <p>The ID of the recycle bin folder.</p>
|
|
272
|
+
* @public
|
|
273
273
|
*/
|
|
274
274
|
RecycleBinFolderId?: string;
|
|
275
275
|
/**
|
|
276
|
-
* @public
|
|
277
276
|
* <p>The status of the user.</p>
|
|
277
|
+
* @public
|
|
278
278
|
*/
|
|
279
279
|
Status?: UserStatusType;
|
|
280
280
|
/**
|
|
281
|
-
* @public
|
|
282
281
|
* <p>The type of user.</p>
|
|
282
|
+
* @public
|
|
283
283
|
*/
|
|
284
284
|
Type?: UserType;
|
|
285
285
|
/**
|
|
286
|
-
* @public
|
|
287
286
|
* <p>The time when the user was created.</p>
|
|
287
|
+
* @public
|
|
288
288
|
*/
|
|
289
289
|
CreatedTimestamp?: Date;
|
|
290
290
|
/**
|
|
291
|
-
* @public
|
|
292
291
|
* <p>The time when the user was modified.</p>
|
|
292
|
+
* @public
|
|
293
293
|
*/
|
|
294
294
|
ModifiedTimestamp?: Date;
|
|
295
295
|
/**
|
|
296
|
-
* @public
|
|
297
296
|
* <p>The time zone ID of the user.</p>
|
|
297
|
+
* @public
|
|
298
298
|
*/
|
|
299
299
|
TimeZoneId?: string;
|
|
300
300
|
/**
|
|
301
|
-
* @public
|
|
302
301
|
* <p>The locale of the user.</p>
|
|
302
|
+
* @public
|
|
303
303
|
*/
|
|
304
304
|
Locale?: LocaleType;
|
|
305
305
|
/**
|
|
306
|
-
* @public
|
|
307
306
|
* <p>The storage for the user.</p>
|
|
307
|
+
* @public
|
|
308
308
|
*/
|
|
309
309
|
Storage?: UserStorageMetadata;
|
|
310
310
|
}
|
|
@@ -313,8 +313,8 @@ export interface User {
|
|
|
313
313
|
*/
|
|
314
314
|
export interface ActivateUserResponse {
|
|
315
315
|
/**
|
|
316
|
-
* @public
|
|
317
316
|
* <p>The user information.</p>
|
|
317
|
+
* @public
|
|
318
318
|
*/
|
|
319
319
|
User?: User;
|
|
320
320
|
}
|
|
@@ -332,69 +332,69 @@ export declare const CommentStatusType: {
|
|
|
332
332
|
*/
|
|
333
333
|
export type CommentStatusType = (typeof CommentStatusType)[keyof typeof CommentStatusType];
|
|
334
334
|
/**
|
|
335
|
-
* @public
|
|
336
335
|
* <p>Describes the metadata of a comment.</p>
|
|
336
|
+
* @public
|
|
337
337
|
*/
|
|
338
338
|
export interface CommentMetadata {
|
|
339
339
|
/**
|
|
340
|
-
* @public
|
|
341
340
|
* <p>The ID of the comment.</p>
|
|
341
|
+
* @public
|
|
342
342
|
*/
|
|
343
343
|
CommentId?: string;
|
|
344
344
|
/**
|
|
345
|
-
* @public
|
|
346
345
|
* <p>The user who made the comment.</p>
|
|
346
|
+
* @public
|
|
347
347
|
*/
|
|
348
348
|
Contributor?: User;
|
|
349
349
|
/**
|
|
350
|
-
* @public
|
|
351
350
|
* <p>The timestamp that the comment was created.</p>
|
|
351
|
+
* @public
|
|
352
352
|
*/
|
|
353
353
|
CreatedTimestamp?: Date;
|
|
354
354
|
/**
|
|
355
|
-
* @public
|
|
356
355
|
* <p>The status of the comment.</p>
|
|
356
|
+
* @public
|
|
357
357
|
*/
|
|
358
358
|
CommentStatus?: CommentStatusType;
|
|
359
359
|
/**
|
|
360
|
-
* @public
|
|
361
360
|
* <p>The ID of the user being replied to.</p>
|
|
361
|
+
* @public
|
|
362
362
|
*/
|
|
363
363
|
RecipientId?: string;
|
|
364
364
|
/**
|
|
365
|
-
* @public
|
|
366
365
|
* <p>The ID of the user who made the comment.</p>
|
|
366
|
+
* @public
|
|
367
367
|
*/
|
|
368
368
|
ContributorId?: string;
|
|
369
369
|
}
|
|
370
370
|
/**
|
|
371
|
-
* @public
|
|
372
371
|
* <p>Describes the metadata of the user.</p>
|
|
372
|
+
* @public
|
|
373
373
|
*/
|
|
374
374
|
export interface UserMetadata {
|
|
375
375
|
/**
|
|
376
|
-
* @public
|
|
377
376
|
* <p>The ID of the user.</p>
|
|
377
|
+
* @public
|
|
378
378
|
*/
|
|
379
379
|
Id?: string;
|
|
380
380
|
/**
|
|
381
|
-
* @public
|
|
382
381
|
* <p>The name of the user.</p>
|
|
382
|
+
* @public
|
|
383
383
|
*/
|
|
384
384
|
Username?: string;
|
|
385
385
|
/**
|
|
386
|
-
* @public
|
|
387
386
|
* <p>The given name of the user before a rename operation.</p>
|
|
387
|
+
* @public
|
|
388
388
|
*/
|
|
389
389
|
GivenName?: string;
|
|
390
390
|
/**
|
|
391
|
-
* @public
|
|
392
391
|
* <p>The surname of the user.</p>
|
|
392
|
+
* @public
|
|
393
393
|
*/
|
|
394
394
|
Surname?: string;
|
|
395
395
|
/**
|
|
396
|
-
* @public
|
|
397
396
|
* <p>The email address of the user.</p>
|
|
397
|
+
* @public
|
|
398
398
|
*/
|
|
399
399
|
EmailAddress?: string;
|
|
400
400
|
}
|
|
@@ -411,76 +411,76 @@ export declare const ResourceType: {
|
|
|
411
411
|
*/
|
|
412
412
|
export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
|
|
413
413
|
/**
|
|
414
|
-
* @public
|
|
415
414
|
* <p>Describes the metadata of a resource.</p>
|
|
415
|
+
* @public
|
|
416
416
|
*/
|
|
417
417
|
export interface ResourceMetadata {
|
|
418
418
|
/**
|
|
419
|
-
* @public
|
|
420
419
|
* <p>The type of resource.</p>
|
|
420
|
+
* @public
|
|
421
421
|
*/
|
|
422
422
|
Type?: ResourceType;
|
|
423
423
|
/**
|
|
424
|
-
* @public
|
|
425
424
|
* <p>The name of the resource.</p>
|
|
425
|
+
* @public
|
|
426
426
|
*/
|
|
427
427
|
Name?: string;
|
|
428
428
|
/**
|
|
429
|
-
* @public
|
|
430
429
|
* <p>The original name of the resource before a rename operation.</p>
|
|
430
|
+
* @public
|
|
431
431
|
*/
|
|
432
432
|
OriginalName?: string;
|
|
433
433
|
/**
|
|
434
|
-
* @public
|
|
435
434
|
* <p>The ID of the resource.</p>
|
|
435
|
+
* @public
|
|
436
436
|
*/
|
|
437
437
|
Id?: string;
|
|
438
438
|
/**
|
|
439
|
-
* @public
|
|
440
439
|
* <p>The version ID of the resource. This is an optional field and is filled for action
|
|
441
440
|
* on document version.</p>
|
|
441
|
+
* @public
|
|
442
442
|
*/
|
|
443
443
|
VersionId?: string;
|
|
444
444
|
/**
|
|
445
|
-
* @public
|
|
446
445
|
* <p>The owner of the resource.</p>
|
|
446
|
+
* @public
|
|
447
447
|
*/
|
|
448
448
|
Owner?: UserMetadata;
|
|
449
449
|
/**
|
|
450
|
-
* @public
|
|
451
450
|
* <p>The parent ID of the resource before a rename operation.</p>
|
|
451
|
+
* @public
|
|
452
452
|
*/
|
|
453
453
|
ParentId?: string;
|
|
454
454
|
}
|
|
455
455
|
/**
|
|
456
|
-
* @public
|
|
457
456
|
* <p>Describes the metadata of a user group.</p>
|
|
457
|
+
* @public
|
|
458
458
|
*/
|
|
459
459
|
export interface GroupMetadata {
|
|
460
460
|
/**
|
|
461
|
-
* @public
|
|
462
461
|
* <p>The ID of the user group.</p>
|
|
462
|
+
* @public
|
|
463
463
|
*/
|
|
464
464
|
Id?: string;
|
|
465
465
|
/**
|
|
466
|
-
* @public
|
|
467
466
|
* <p>The name of the group.</p>
|
|
467
|
+
* @public
|
|
468
468
|
*/
|
|
469
469
|
Name?: string;
|
|
470
470
|
}
|
|
471
471
|
/**
|
|
472
|
-
* @public
|
|
473
472
|
* <p>Describes the users or user groups.</p>
|
|
473
|
+
* @public
|
|
474
474
|
*/
|
|
475
475
|
export interface Participants {
|
|
476
476
|
/**
|
|
477
|
-
* @public
|
|
478
477
|
* <p>The list of users.</p>
|
|
478
|
+
* @public
|
|
479
479
|
*/
|
|
480
480
|
Users?: UserMetadata[];
|
|
481
481
|
/**
|
|
482
|
-
* @public
|
|
483
482
|
* <p>The list of user groups.</p>
|
|
483
|
+
* @public
|
|
484
484
|
*/
|
|
485
485
|
Groups?: GroupMetadata[];
|
|
486
486
|
}
|
|
@@ -528,60 +528,60 @@ export declare const ActivityType: {
|
|
|
528
528
|
*/
|
|
529
529
|
export type ActivityType = (typeof ActivityType)[keyof typeof ActivityType];
|
|
530
530
|
/**
|
|
531
|
-
* @public
|
|
532
531
|
* <p>Describes the activity information.</p>
|
|
532
|
+
* @public
|
|
533
533
|
*/
|
|
534
534
|
export interface Activity {
|
|
535
535
|
/**
|
|
536
|
-
* @public
|
|
537
536
|
* <p>The activity type.</p>
|
|
537
|
+
* @public
|
|
538
538
|
*/
|
|
539
539
|
Type?: ActivityType;
|
|
540
540
|
/**
|
|
541
|
-
* @public
|
|
542
541
|
* <p>The timestamp when the action was performed.</p>
|
|
542
|
+
* @public
|
|
543
543
|
*/
|
|
544
544
|
TimeStamp?: Date;
|
|
545
545
|
/**
|
|
546
|
-
* @public
|
|
547
546
|
* <p>Indicates whether an activity is indirect or direct. An indirect activity results
|
|
548
547
|
* from a direct activity performed on a parent resource. For example, sharing a parent
|
|
549
548
|
* folder (the direct activity) shares all of the subfolders and documents within the
|
|
550
549
|
* parent folder (the indirect activity).</p>
|
|
550
|
+
* @public
|
|
551
551
|
*/
|
|
552
552
|
IsIndirectActivity?: boolean;
|
|
553
553
|
/**
|
|
554
|
-
* @public
|
|
555
554
|
* <p>The ID of the organization.</p>
|
|
555
|
+
* @public
|
|
556
556
|
*/
|
|
557
557
|
OrganizationId?: string;
|
|
558
558
|
/**
|
|
559
|
-
* @public
|
|
560
559
|
* <p>The user who performed the action.</p>
|
|
560
|
+
* @public
|
|
561
561
|
*/
|
|
562
562
|
Initiator?: UserMetadata;
|
|
563
563
|
/**
|
|
564
|
-
* @public
|
|
565
564
|
* <p>The list of users or groups impacted by this action. This is an optional field and
|
|
566
565
|
* is filled for the following sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED,
|
|
567
566
|
* DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED.</p>
|
|
567
|
+
* @public
|
|
568
568
|
*/
|
|
569
569
|
Participants?: Participants;
|
|
570
570
|
/**
|
|
571
|
-
* @public
|
|
572
571
|
* <p>The metadata of the resource involved in the user action.</p>
|
|
572
|
+
* @public
|
|
573
573
|
*/
|
|
574
574
|
ResourceMetadata?: ResourceMetadata;
|
|
575
575
|
/**
|
|
576
|
-
* @public
|
|
577
576
|
* <p>The original parent of the resource. This is an optional field and is filled for
|
|
578
577
|
* move activities.</p>
|
|
578
|
+
* @public
|
|
579
579
|
*/
|
|
580
580
|
OriginalParent?: ResourceMetadata;
|
|
581
581
|
/**
|
|
582
|
-
* @public
|
|
583
582
|
* <p>Metadata of the commenting activity. This is an optional field and is filled for
|
|
584
583
|
* commenting activities.</p>
|
|
584
|
+
* @public
|
|
585
585
|
*/
|
|
586
586
|
CommentMetadata?: CommentMetadata;
|
|
587
587
|
}
|
|
@@ -597,19 +597,19 @@ export declare const AdditionalResponseFieldType: {
|
|
|
597
597
|
*/
|
|
598
598
|
export type AdditionalResponseFieldType = (typeof AdditionalResponseFieldType)[keyof typeof AdditionalResponseFieldType];
|
|
599
599
|
/**
|
|
600
|
-
* @public
|
|
601
600
|
* <p>Set of options which defines notification preferences of given action.</p>
|
|
601
|
+
* @public
|
|
602
602
|
*/
|
|
603
603
|
export interface NotificationOptions {
|
|
604
604
|
/**
|
|
605
|
-
* @public
|
|
606
605
|
* <p>Boolean value to indicate an email notification should be sent to the
|
|
607
606
|
* recipients.</p>
|
|
607
|
+
* @public
|
|
608
608
|
*/
|
|
609
609
|
SendEmail?: boolean;
|
|
610
610
|
/**
|
|
611
|
-
* @public
|
|
612
611
|
* <p>Text value to be included in the email body.</p>
|
|
612
|
+
* @public
|
|
613
613
|
*/
|
|
614
614
|
EmailMessage?: string;
|
|
615
615
|
}
|
|
@@ -643,23 +643,23 @@ export declare const PrincipalType: {
|
|
|
643
643
|
*/
|
|
644
644
|
export type PrincipalType = (typeof PrincipalType)[keyof typeof PrincipalType];
|
|
645
645
|
/**
|
|
646
|
-
* @public
|
|
647
646
|
* <p>Describes the recipient type and ID, if available.</p>
|
|
647
|
+
* @public
|
|
648
648
|
*/
|
|
649
649
|
export interface SharePrincipal {
|
|
650
650
|
/**
|
|
651
|
-
* @public
|
|
652
651
|
* <p>The ID of the recipient.</p>
|
|
652
|
+
* @public
|
|
653
653
|
*/
|
|
654
654
|
Id: string | undefined;
|
|
655
655
|
/**
|
|
656
|
-
* @public
|
|
657
656
|
* <p>The type of the recipient.</p>
|
|
657
|
+
* @public
|
|
658
658
|
*/
|
|
659
659
|
Type: PrincipalType | undefined;
|
|
660
660
|
/**
|
|
661
|
-
* @public
|
|
662
661
|
* <p>The role of the recipient.</p>
|
|
662
|
+
* @public
|
|
663
663
|
*/
|
|
664
664
|
Role: RoleType | undefined;
|
|
665
665
|
}
|
|
@@ -668,23 +668,23 @@ export interface SharePrincipal {
|
|
|
668
668
|
*/
|
|
669
669
|
export interface AddResourcePermissionsRequest {
|
|
670
670
|
/**
|
|
671
|
-
* @public
|
|
672
671
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
672
|
+
* @public
|
|
673
673
|
*/
|
|
674
674
|
AuthenticationToken?: string;
|
|
675
675
|
/**
|
|
676
|
-
* @public
|
|
677
676
|
* <p>The ID of the resource.</p>
|
|
677
|
+
* @public
|
|
678
678
|
*/
|
|
679
679
|
ResourceId: string | undefined;
|
|
680
680
|
/**
|
|
681
|
-
* @public
|
|
682
681
|
* <p>The users, groups, or organization being granted permission.</p>
|
|
682
|
+
* @public
|
|
683
683
|
*/
|
|
684
684
|
Principals: SharePrincipal[] | undefined;
|
|
685
685
|
/**
|
|
686
|
-
* @public
|
|
687
686
|
* <p>The notification options.</p>
|
|
687
|
+
* @public
|
|
688
688
|
*/
|
|
689
689
|
NotificationOptions?: NotificationOptions;
|
|
690
690
|
}
|
|
@@ -701,38 +701,38 @@ export declare const ShareStatusType: {
|
|
|
701
701
|
*/
|
|
702
702
|
export type ShareStatusType = (typeof ShareStatusType)[keyof typeof ShareStatusType];
|
|
703
703
|
/**
|
|
704
|
-
* @public
|
|
705
704
|
* <p>Describes the share results of a resource.</p>
|
|
705
|
+
* @public
|
|
706
706
|
*/
|
|
707
707
|
export interface ShareResult {
|
|
708
708
|
/**
|
|
709
|
-
* @public
|
|
710
709
|
* <p>The ID of the principal.</p>
|
|
710
|
+
* @public
|
|
711
711
|
*/
|
|
712
712
|
PrincipalId?: string;
|
|
713
713
|
/**
|
|
714
|
-
* @public
|
|
715
714
|
* <p>The ID of the invited user.</p>
|
|
715
|
+
* @public
|
|
716
716
|
*/
|
|
717
717
|
InviteePrincipalId?: string;
|
|
718
718
|
/**
|
|
719
|
-
* @public
|
|
720
719
|
* <p>The role.</p>
|
|
720
|
+
* @public
|
|
721
721
|
*/
|
|
722
722
|
Role?: RoleType;
|
|
723
723
|
/**
|
|
724
|
-
* @public
|
|
725
724
|
* <p>The status.</p>
|
|
725
|
+
* @public
|
|
726
726
|
*/
|
|
727
727
|
Status?: ShareStatusType;
|
|
728
728
|
/**
|
|
729
|
-
* @public
|
|
730
729
|
* <p>The ID of the resource that was shared.</p>
|
|
730
|
+
* @public
|
|
731
731
|
*/
|
|
732
732
|
ShareId?: string;
|
|
733
733
|
/**
|
|
734
|
-
* @public
|
|
735
734
|
* <p>The status message.</p>
|
|
735
|
+
* @public
|
|
736
736
|
*/
|
|
737
737
|
StatusMessage?: string;
|
|
738
738
|
}
|
|
@@ -741,8 +741,8 @@ export interface ShareResult {
|
|
|
741
741
|
*/
|
|
742
742
|
export interface AddResourcePermissionsResponse {
|
|
743
743
|
/**
|
|
744
|
-
* @public
|
|
745
744
|
* <p>The share results.</p>
|
|
745
|
+
* @public
|
|
746
746
|
*/
|
|
747
747
|
ShareResults?: ShareResult[];
|
|
748
748
|
}
|
|
@@ -763,100 +763,100 @@ export type CommentVisibilityType = (typeof CommentVisibilityType)[keyof typeof
|
|
|
763
763
|
*/
|
|
764
764
|
export interface CreateCommentRequest {
|
|
765
765
|
/**
|
|
766
|
-
* @public
|
|
767
766
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
767
|
+
* @public
|
|
768
768
|
*/
|
|
769
769
|
AuthenticationToken?: string;
|
|
770
770
|
/**
|
|
771
|
-
* @public
|
|
772
771
|
* <p>The ID of the document.</p>
|
|
772
|
+
* @public
|
|
773
773
|
*/
|
|
774
774
|
DocumentId: string | undefined;
|
|
775
775
|
/**
|
|
776
|
-
* @public
|
|
777
776
|
* <p>The ID of the document version.</p>
|
|
777
|
+
* @public
|
|
778
778
|
*/
|
|
779
779
|
VersionId: string | undefined;
|
|
780
780
|
/**
|
|
781
|
-
* @public
|
|
782
781
|
* <p>The ID of the parent comment.</p>
|
|
782
|
+
* @public
|
|
783
783
|
*/
|
|
784
784
|
ParentId?: string;
|
|
785
785
|
/**
|
|
786
|
-
* @public
|
|
787
786
|
* <p>The ID of the root comment in the thread.</p>
|
|
787
|
+
* @public
|
|
788
788
|
*/
|
|
789
789
|
ThreadId?: string;
|
|
790
790
|
/**
|
|
791
|
-
* @public
|
|
792
791
|
* <p>The text of the comment.</p>
|
|
792
|
+
* @public
|
|
793
793
|
*/
|
|
794
794
|
Text: string | undefined;
|
|
795
795
|
/**
|
|
796
|
-
* @public
|
|
797
796
|
* <p>The visibility of the comment. Options are either PRIVATE, where the comment is
|
|
798
797
|
* visible only to the comment author and document owner and co-owners, or PUBLIC, where
|
|
799
798
|
* the comment is visible to document owners, co-owners, and contributors.</p>
|
|
799
|
+
* @public
|
|
800
800
|
*/
|
|
801
801
|
Visibility?: CommentVisibilityType;
|
|
802
802
|
/**
|
|
803
|
-
* @public
|
|
804
803
|
* <p>Set this parameter to TRUE to send an email out to the document collaborators after
|
|
805
804
|
* the comment is created.</p>
|
|
805
|
+
* @public
|
|
806
806
|
*/
|
|
807
807
|
NotifyCollaborators?: boolean;
|
|
808
808
|
}
|
|
809
809
|
/**
|
|
810
|
-
* @public
|
|
811
810
|
* <p>Describes a comment.</p>
|
|
811
|
+
* @public
|
|
812
812
|
*/
|
|
813
813
|
export interface Comment {
|
|
814
814
|
/**
|
|
815
|
-
* @public
|
|
816
815
|
* <p>The ID of the comment.</p>
|
|
816
|
+
* @public
|
|
817
817
|
*/
|
|
818
818
|
CommentId: string | undefined;
|
|
819
819
|
/**
|
|
820
|
-
* @public
|
|
821
820
|
* <p>The ID of the parent comment.</p>
|
|
821
|
+
* @public
|
|
822
822
|
*/
|
|
823
823
|
ParentId?: string;
|
|
824
824
|
/**
|
|
825
|
-
* @public
|
|
826
825
|
* <p>The ID of the root comment in the thread.</p>
|
|
826
|
+
* @public
|
|
827
827
|
*/
|
|
828
828
|
ThreadId?: string;
|
|
829
829
|
/**
|
|
830
|
-
* @public
|
|
831
830
|
* <p>The text of the comment.</p>
|
|
831
|
+
* @public
|
|
832
832
|
*/
|
|
833
833
|
Text?: string;
|
|
834
834
|
/**
|
|
835
|
-
* @public
|
|
836
835
|
* <p>The details of the user who made the comment.</p>
|
|
836
|
+
* @public
|
|
837
837
|
*/
|
|
838
838
|
Contributor?: User;
|
|
839
839
|
/**
|
|
840
|
-
* @public
|
|
841
840
|
* <p>The time that the comment was created.</p>
|
|
841
|
+
* @public
|
|
842
842
|
*/
|
|
843
843
|
CreatedTimestamp?: Date;
|
|
844
844
|
/**
|
|
845
|
-
* @public
|
|
846
845
|
* <p>The status of the comment.</p>
|
|
846
|
+
* @public
|
|
847
847
|
*/
|
|
848
848
|
Status?: CommentStatusType;
|
|
849
849
|
/**
|
|
850
|
-
* @public
|
|
851
850
|
* <p>The visibility of the comment. Options are either PRIVATE, where the comment is
|
|
852
851
|
* visible only to the comment author and document owner and co-owners, or PUBLIC, where
|
|
853
852
|
* the comment is visible to document owners, co-owners, and contributors.</p>
|
|
853
|
+
* @public
|
|
854
854
|
*/
|
|
855
855
|
Visibility?: CommentVisibilityType;
|
|
856
856
|
/**
|
|
857
|
-
* @public
|
|
858
857
|
* <p>If the comment is a reply to another user's comment, this field contains the user
|
|
859
858
|
* ID of the user being replied to.</p>
|
|
859
|
+
* @public
|
|
860
860
|
*/
|
|
861
861
|
RecipientId?: string;
|
|
862
862
|
}
|
|
@@ -865,15 +865,15 @@ export interface Comment {
|
|
|
865
865
|
*/
|
|
866
866
|
export interface CreateCommentResponse {
|
|
867
867
|
/**
|
|
868
|
-
* @public
|
|
869
868
|
* <p>The comment that has been created.</p>
|
|
869
|
+
* @public
|
|
870
870
|
*/
|
|
871
871
|
Comment?: Comment;
|
|
872
872
|
}
|
|
873
873
|
/**
|
|
874
|
-
* @public
|
|
875
874
|
* <p>This exception is thrown when the document is locked for comments and user tries to
|
|
876
875
|
* create or delete a comment on that document.</p>
|
|
876
|
+
* @public
|
|
877
877
|
*/
|
|
878
878
|
export declare class DocumentLockedForCommentsException extends __BaseException {
|
|
879
879
|
readonly name: "DocumentLockedForCommentsException";
|
|
@@ -885,8 +885,8 @@ export declare class DocumentLockedForCommentsException extends __BaseException
|
|
|
885
885
|
constructor(opts: __ExceptionOptionType<DocumentLockedForCommentsException, __BaseException>);
|
|
886
886
|
}
|
|
887
887
|
/**
|
|
888
|
-
* @public
|
|
889
888
|
* <p>The requested operation is not allowed on the specified comment object.</p>
|
|
889
|
+
* @public
|
|
890
890
|
*/
|
|
891
891
|
export declare class InvalidCommentOperationException extends __BaseException {
|
|
892
892
|
readonly name: "InvalidCommentOperationException";
|
|
@@ -902,24 +902,24 @@ export declare class InvalidCommentOperationException extends __BaseException {
|
|
|
902
902
|
*/
|
|
903
903
|
export interface CreateCustomMetadataRequest {
|
|
904
904
|
/**
|
|
905
|
-
* @public
|
|
906
905
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
906
|
+
* @public
|
|
907
907
|
*/
|
|
908
908
|
AuthenticationToken?: string;
|
|
909
909
|
/**
|
|
910
|
-
* @public
|
|
911
910
|
* <p>The ID of the resource.</p>
|
|
911
|
+
* @public
|
|
912
912
|
*/
|
|
913
913
|
ResourceId: string | undefined;
|
|
914
914
|
/**
|
|
915
|
-
* @public
|
|
916
915
|
* <p>The ID of the version, if the custom metadata is being added to a document
|
|
917
916
|
* version.</p>
|
|
917
|
+
* @public
|
|
918
918
|
*/
|
|
919
919
|
VersionId?: string;
|
|
920
920
|
/**
|
|
921
|
-
* @public
|
|
922
921
|
* <p>Custom metadata in the form of name-value pairs.</p>
|
|
922
|
+
* @public
|
|
923
923
|
*/
|
|
924
924
|
CustomMetadata: Record<string, string> | undefined;
|
|
925
925
|
}
|
|
@@ -929,9 +929,9 @@ export interface CreateCustomMetadataRequest {
|
|
|
929
929
|
export interface CreateCustomMetadataResponse {
|
|
930
930
|
}
|
|
931
931
|
/**
|
|
932
|
-
* @public
|
|
933
932
|
* <p>The limit has been reached on the number of custom properties for the specified
|
|
934
933
|
* resource.</p>
|
|
934
|
+
* @public
|
|
935
935
|
*/
|
|
936
936
|
export declare class CustomMetadataLimitExceededException extends __BaseException {
|
|
937
937
|
readonly name: "CustomMetadataLimitExceededException";
|
|
@@ -943,8 +943,8 @@ export declare class CustomMetadataLimitExceededException extends __BaseExceptio
|
|
|
943
943
|
constructor(opts: __ExceptionOptionType<CustomMetadataLimitExceededException, __BaseException>);
|
|
944
944
|
}
|
|
945
945
|
/**
|
|
946
|
-
* @public
|
|
947
946
|
* <p>Another operation is in progress on the resource that conflicts with the current operation.</p>
|
|
947
|
+
* @public
|
|
948
948
|
*/
|
|
949
949
|
export declare class ConflictingOperationException extends __BaseException {
|
|
950
950
|
readonly name: "ConflictingOperationException";
|
|
@@ -960,18 +960,18 @@ export declare class ConflictingOperationException extends __BaseException {
|
|
|
960
960
|
*/
|
|
961
961
|
export interface CreateFolderRequest {
|
|
962
962
|
/**
|
|
963
|
-
* @public
|
|
964
963
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
964
|
+
* @public
|
|
965
965
|
*/
|
|
966
966
|
AuthenticationToken?: string;
|
|
967
967
|
/**
|
|
968
|
-
* @public
|
|
969
968
|
* <p>The name of the new folder.</p>
|
|
969
|
+
* @public
|
|
970
970
|
*/
|
|
971
971
|
Name?: string;
|
|
972
972
|
/**
|
|
973
|
-
* @public
|
|
974
973
|
* <p>The ID of the parent folder.</p>
|
|
974
|
+
* @public
|
|
975
975
|
*/
|
|
976
976
|
ParentFolderId: string | undefined;
|
|
977
977
|
}
|
|
@@ -990,64 +990,64 @@ export declare const ResourceStateType: {
|
|
|
990
990
|
*/
|
|
991
991
|
export type ResourceStateType = (typeof ResourceStateType)[keyof typeof ResourceStateType];
|
|
992
992
|
/**
|
|
993
|
-
* @public
|
|
994
993
|
* <p>Describes a folder.</p>
|
|
994
|
+
* @public
|
|
995
995
|
*/
|
|
996
996
|
export interface FolderMetadata {
|
|
997
997
|
/**
|
|
998
|
-
* @public
|
|
999
998
|
* <p>The ID of the folder.</p>
|
|
999
|
+
* @public
|
|
1000
1000
|
*/
|
|
1001
1001
|
Id?: string;
|
|
1002
1002
|
/**
|
|
1003
|
-
* @public
|
|
1004
1003
|
* <p>The name of the folder.</p>
|
|
1004
|
+
* @public
|
|
1005
1005
|
*/
|
|
1006
1006
|
Name?: string;
|
|
1007
1007
|
/**
|
|
1008
|
-
* @public
|
|
1009
1008
|
* <p>The ID of the creator.</p>
|
|
1009
|
+
* @public
|
|
1010
1010
|
*/
|
|
1011
1011
|
CreatorId?: string;
|
|
1012
1012
|
/**
|
|
1013
|
-
* @public
|
|
1014
1013
|
* <p>The ID of the parent folder.</p>
|
|
1014
|
+
* @public
|
|
1015
1015
|
*/
|
|
1016
1016
|
ParentFolderId?: string;
|
|
1017
1017
|
/**
|
|
1018
|
-
* @public
|
|
1019
1018
|
* <p>The time when the folder was created.</p>
|
|
1019
|
+
* @public
|
|
1020
1020
|
*/
|
|
1021
1021
|
CreatedTimestamp?: Date;
|
|
1022
1022
|
/**
|
|
1023
|
-
* @public
|
|
1024
1023
|
* <p>The time when the folder was updated.</p>
|
|
1024
|
+
* @public
|
|
1025
1025
|
*/
|
|
1026
1026
|
ModifiedTimestamp?: Date;
|
|
1027
1027
|
/**
|
|
1028
|
-
* @public
|
|
1029
1028
|
* <p>The resource state of the folder.</p>
|
|
1029
|
+
* @public
|
|
1030
1030
|
*/
|
|
1031
1031
|
ResourceState?: ResourceStateType;
|
|
1032
1032
|
/**
|
|
1033
|
-
* @public
|
|
1034
1033
|
* <p>The unique identifier created from the subfolders and documents of the
|
|
1035
1034
|
* folder.</p>
|
|
1035
|
+
* @public
|
|
1036
1036
|
*/
|
|
1037
1037
|
Signature?: string;
|
|
1038
1038
|
/**
|
|
1039
|
-
* @public
|
|
1040
1039
|
* <p>List of labels on the folder.</p>
|
|
1040
|
+
* @public
|
|
1041
1041
|
*/
|
|
1042
1042
|
Labels?: string[];
|
|
1043
1043
|
/**
|
|
1044
|
-
* @public
|
|
1045
1044
|
* <p>The size of the folder metadata.</p>
|
|
1045
|
+
* @public
|
|
1046
1046
|
*/
|
|
1047
1047
|
Size?: number;
|
|
1048
1048
|
/**
|
|
1049
|
-
* @public
|
|
1050
1049
|
* <p>The size of the latest version of the folder metadata.</p>
|
|
1050
|
+
* @public
|
|
1051
1051
|
*/
|
|
1052
1052
|
LatestVersionSize?: number;
|
|
1053
1053
|
}
|
|
@@ -1056,14 +1056,14 @@ export interface FolderMetadata {
|
|
|
1056
1056
|
*/
|
|
1057
1057
|
export interface CreateFolderResponse {
|
|
1058
1058
|
/**
|
|
1059
|
-
* @public
|
|
1060
1059
|
* <p>The metadata of the folder.</p>
|
|
1060
|
+
* @public
|
|
1061
1061
|
*/
|
|
1062
1062
|
Metadata?: FolderMetadata;
|
|
1063
1063
|
}
|
|
1064
1064
|
/**
|
|
1065
|
-
* @public
|
|
1066
1065
|
* <p>The resource already exists.</p>
|
|
1066
|
+
* @public
|
|
1067
1067
|
*/
|
|
1068
1068
|
export declare class EntityAlreadyExistsException extends __BaseException {
|
|
1069
1069
|
readonly name: "EntityAlreadyExistsException";
|
|
@@ -1075,8 +1075,8 @@ export declare class EntityAlreadyExistsException extends __BaseException {
|
|
|
1075
1075
|
constructor(opts: __ExceptionOptionType<EntityAlreadyExistsException, __BaseException>);
|
|
1076
1076
|
}
|
|
1077
1077
|
/**
|
|
1078
|
-
* @public
|
|
1079
1078
|
* <p>The maximum of 100,000 files and folders under the parent folder has been exceeded.</p>
|
|
1079
|
+
* @public
|
|
1080
1080
|
*/
|
|
1081
1081
|
export declare class LimitExceededException extends __BaseException {
|
|
1082
1082
|
readonly name: "LimitExceededException";
|
|
@@ -1092,18 +1092,18 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
1092
1092
|
*/
|
|
1093
1093
|
export interface CreateLabelsRequest {
|
|
1094
1094
|
/**
|
|
1095
|
-
* @public
|
|
1096
1095
|
* <p>The ID of the resource.</p>
|
|
1096
|
+
* @public
|
|
1097
1097
|
*/
|
|
1098
1098
|
ResourceId: string | undefined;
|
|
1099
1099
|
/**
|
|
1100
|
-
* @public
|
|
1101
1100
|
* <p>List of labels to add to the resource.</p>
|
|
1101
|
+
* @public
|
|
1102
1102
|
*/
|
|
1103
1103
|
Labels: string[] | undefined;
|
|
1104
1104
|
/**
|
|
1105
|
-
* @public
|
|
1106
1105
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1106
|
+
* @public
|
|
1107
1107
|
*/
|
|
1108
1108
|
AuthenticationToken?: string;
|
|
1109
1109
|
}
|
|
@@ -1113,9 +1113,9 @@ export interface CreateLabelsRequest {
|
|
|
1113
1113
|
export interface CreateLabelsResponse {
|
|
1114
1114
|
}
|
|
1115
1115
|
/**
|
|
1116
|
-
* @public
|
|
1117
1116
|
* <p>The limit has been reached on the number of labels for the specified
|
|
1118
1117
|
* resource.</p>
|
|
1118
|
+
* @public
|
|
1119
1119
|
*/
|
|
1120
1120
|
export declare class TooManyLabelsException extends __BaseException {
|
|
1121
1121
|
readonly name: "TooManyLabelsException";
|
|
@@ -1154,46 +1154,46 @@ export type SubscriptionType = (typeof SubscriptionType)[keyof typeof Subscripti
|
|
|
1154
1154
|
*/
|
|
1155
1155
|
export interface CreateNotificationSubscriptionRequest {
|
|
1156
1156
|
/**
|
|
1157
|
-
* @public
|
|
1158
1157
|
* <p>The ID of the organization.</p>
|
|
1158
|
+
* @public
|
|
1159
1159
|
*/
|
|
1160
1160
|
OrganizationId: string | undefined;
|
|
1161
1161
|
/**
|
|
1162
|
-
* @public
|
|
1163
1162
|
* <p>The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint
|
|
1164
1163
|
* is a URL that begins with <code>https</code>.</p>
|
|
1164
|
+
* @public
|
|
1165
1165
|
*/
|
|
1166
1166
|
Endpoint: string | undefined;
|
|
1167
1167
|
/**
|
|
1168
|
-
* @public
|
|
1169
1168
|
* <p>The protocol to use. The supported value is https, which delivers JSON-encoded
|
|
1170
1169
|
* messages using HTTPS POST.</p>
|
|
1170
|
+
* @public
|
|
1171
1171
|
*/
|
|
1172
1172
|
Protocol: SubscriptionProtocolType | undefined;
|
|
1173
1173
|
/**
|
|
1174
|
-
* @public
|
|
1175
1174
|
* <p>The notification type.</p>
|
|
1175
|
+
* @public
|
|
1176
1176
|
*/
|
|
1177
1177
|
SubscriptionType: SubscriptionType | undefined;
|
|
1178
1178
|
}
|
|
1179
1179
|
/**
|
|
1180
|
-
* @public
|
|
1181
1180
|
* <p>Describes a subscription.</p>
|
|
1181
|
+
* @public
|
|
1182
1182
|
*/
|
|
1183
1183
|
export interface Subscription {
|
|
1184
1184
|
/**
|
|
1185
|
-
* @public
|
|
1186
1185
|
* <p>The ID of the subscription.</p>
|
|
1186
|
+
* @public
|
|
1187
1187
|
*/
|
|
1188
1188
|
SubscriptionId?: string;
|
|
1189
1189
|
/**
|
|
1190
|
-
* @public
|
|
1191
1190
|
* <p>The endpoint of the subscription.</p>
|
|
1191
|
+
* @public
|
|
1192
1192
|
*/
|
|
1193
1193
|
EndPoint?: string;
|
|
1194
1194
|
/**
|
|
1195
|
-
* @public
|
|
1196
1195
|
* <p>The protocol of the subscription.</p>
|
|
1196
|
+
* @public
|
|
1197
1197
|
*/
|
|
1198
1198
|
Protocol?: SubscriptionProtocolType;
|
|
1199
1199
|
}
|
|
@@ -1202,14 +1202,14 @@ export interface Subscription {
|
|
|
1202
1202
|
*/
|
|
1203
1203
|
export interface CreateNotificationSubscriptionResponse {
|
|
1204
1204
|
/**
|
|
1205
|
-
* @public
|
|
1206
1205
|
* <p>The subscription.</p>
|
|
1206
|
+
* @public
|
|
1207
1207
|
*/
|
|
1208
1208
|
Subscription?: Subscription;
|
|
1209
1209
|
}
|
|
1210
1210
|
/**
|
|
1211
|
-
* @public
|
|
1212
1211
|
* <p>The pagination marker or limit fields are not valid.</p>
|
|
1212
|
+
* @public
|
|
1213
1213
|
*/
|
|
1214
1214
|
export declare class InvalidArgumentException extends __BaseException {
|
|
1215
1215
|
readonly name: "InvalidArgumentException";
|
|
@@ -1221,9 +1221,9 @@ export declare class InvalidArgumentException extends __BaseException {
|
|
|
1221
1221
|
constructor(opts: __ExceptionOptionType<InvalidArgumentException, __BaseException>);
|
|
1222
1222
|
}
|
|
1223
1223
|
/**
|
|
1224
|
-
* @public
|
|
1225
1224
|
* <p>You've reached the limit on the number of subscriptions for the WorkDocs
|
|
1226
1225
|
* instance.</p>
|
|
1226
|
+
* @public
|
|
1227
1227
|
*/
|
|
1228
1228
|
export declare class TooManySubscriptionsException extends __BaseException {
|
|
1229
1229
|
readonly name: "TooManySubscriptionsException";
|
|
@@ -1239,48 +1239,48 @@ export declare class TooManySubscriptionsException extends __BaseException {
|
|
|
1239
1239
|
*/
|
|
1240
1240
|
export interface CreateUserRequest {
|
|
1241
1241
|
/**
|
|
1242
|
-
* @public
|
|
1243
1242
|
* <p>The ID of the organization.</p>
|
|
1243
|
+
* @public
|
|
1244
1244
|
*/
|
|
1245
1245
|
OrganizationId?: string;
|
|
1246
1246
|
/**
|
|
1247
|
-
* @public
|
|
1248
1247
|
* <p>The login name of the user.</p>
|
|
1248
|
+
* @public
|
|
1249
1249
|
*/
|
|
1250
1250
|
Username: string | undefined;
|
|
1251
1251
|
/**
|
|
1252
|
-
* @public
|
|
1253
1252
|
* <p>The email address of the user.</p>
|
|
1253
|
+
* @public
|
|
1254
1254
|
*/
|
|
1255
1255
|
EmailAddress?: string;
|
|
1256
1256
|
/**
|
|
1257
|
-
* @public
|
|
1258
1257
|
* <p>The given name of the user.</p>
|
|
1258
|
+
* @public
|
|
1259
1259
|
*/
|
|
1260
1260
|
GivenName: string | undefined;
|
|
1261
1261
|
/**
|
|
1262
|
-
* @public
|
|
1263
1262
|
* <p>The surname of the user.</p>
|
|
1263
|
+
* @public
|
|
1264
1264
|
*/
|
|
1265
1265
|
Surname: string | undefined;
|
|
1266
1266
|
/**
|
|
1267
|
-
* @public
|
|
1268
1267
|
* <p>The password of the user.</p>
|
|
1268
|
+
* @public
|
|
1269
1269
|
*/
|
|
1270
1270
|
Password: string | undefined;
|
|
1271
1271
|
/**
|
|
1272
|
-
* @public
|
|
1273
1272
|
* <p>The time zone ID of the user.</p>
|
|
1273
|
+
* @public
|
|
1274
1274
|
*/
|
|
1275
1275
|
TimeZoneId?: string;
|
|
1276
1276
|
/**
|
|
1277
|
-
* @public
|
|
1278
1277
|
* <p>The amount of storage for the user.</p>
|
|
1278
|
+
* @public
|
|
1279
1279
|
*/
|
|
1280
1280
|
StorageRule?: StorageRuleType;
|
|
1281
1281
|
/**
|
|
1282
|
-
* @public
|
|
1283
1282
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1283
|
+
* @public
|
|
1284
1284
|
*/
|
|
1285
1285
|
AuthenticationToken?: string;
|
|
1286
1286
|
}
|
|
@@ -1289,8 +1289,8 @@ export interface CreateUserRequest {
|
|
|
1289
1289
|
*/
|
|
1290
1290
|
export interface CreateUserResponse {
|
|
1291
1291
|
/**
|
|
1292
|
-
* @public
|
|
1293
1292
|
* <p>The user information.</p>
|
|
1293
|
+
* @public
|
|
1294
1294
|
*/
|
|
1295
1295
|
User?: User;
|
|
1296
1296
|
}
|
|
@@ -1299,13 +1299,13 @@ export interface CreateUserResponse {
|
|
|
1299
1299
|
*/
|
|
1300
1300
|
export interface DeactivateUserRequest {
|
|
1301
1301
|
/**
|
|
1302
|
-
* @public
|
|
1303
1302
|
* <p>The ID of the user.</p>
|
|
1303
|
+
* @public
|
|
1304
1304
|
*/
|
|
1305
1305
|
UserId: string | undefined;
|
|
1306
1306
|
/**
|
|
1307
|
-
* @public
|
|
1308
1307
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1308
|
+
* @public
|
|
1309
1309
|
*/
|
|
1310
1310
|
AuthenticationToken?: string;
|
|
1311
1311
|
}
|
|
@@ -1314,23 +1314,23 @@ export interface DeactivateUserRequest {
|
|
|
1314
1314
|
*/
|
|
1315
1315
|
export interface DeleteCommentRequest {
|
|
1316
1316
|
/**
|
|
1317
|
-
* @public
|
|
1318
1317
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1318
|
+
* @public
|
|
1319
1319
|
*/
|
|
1320
1320
|
AuthenticationToken?: string;
|
|
1321
1321
|
/**
|
|
1322
|
-
* @public
|
|
1323
1322
|
* <p>The ID of the document.</p>
|
|
1323
|
+
* @public
|
|
1324
1324
|
*/
|
|
1325
1325
|
DocumentId: string | undefined;
|
|
1326
1326
|
/**
|
|
1327
|
-
* @public
|
|
1328
1327
|
* <p>The ID of the document version.</p>
|
|
1328
|
+
* @public
|
|
1329
1329
|
*/
|
|
1330
1330
|
VersionId: string | undefined;
|
|
1331
1331
|
/**
|
|
1332
|
-
* @public
|
|
1333
1332
|
* <p>The ID of the comment.</p>
|
|
1333
|
+
* @public
|
|
1334
1334
|
*/
|
|
1335
1335
|
CommentId: string | undefined;
|
|
1336
1336
|
}
|
|
@@ -1339,30 +1339,30 @@ export interface DeleteCommentRequest {
|
|
|
1339
1339
|
*/
|
|
1340
1340
|
export interface DeleteCustomMetadataRequest {
|
|
1341
1341
|
/**
|
|
1342
|
-
* @public
|
|
1343
1342
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1343
|
+
* @public
|
|
1344
1344
|
*/
|
|
1345
1345
|
AuthenticationToken?: string;
|
|
1346
1346
|
/**
|
|
1347
|
-
* @public
|
|
1348
1347
|
* <p>The ID of the resource, either a document or folder.</p>
|
|
1348
|
+
* @public
|
|
1349
1349
|
*/
|
|
1350
1350
|
ResourceId: string | undefined;
|
|
1351
1351
|
/**
|
|
1352
|
-
* @public
|
|
1353
1352
|
* <p>The ID of the version, if the custom metadata is being deleted from a document
|
|
1354
1353
|
* version.</p>
|
|
1354
|
+
* @public
|
|
1355
1355
|
*/
|
|
1356
1356
|
VersionId?: string;
|
|
1357
1357
|
/**
|
|
1358
|
-
* @public
|
|
1359
1358
|
* <p>List of properties to remove.</p>
|
|
1359
|
+
* @public
|
|
1360
1360
|
*/
|
|
1361
1361
|
Keys?: string[];
|
|
1362
1362
|
/**
|
|
1363
|
-
* @public
|
|
1364
1363
|
* <p>Flag to indicate removal of all custom metadata properties from the specified
|
|
1365
1364
|
* resource.</p>
|
|
1365
|
+
* @public
|
|
1366
1366
|
*/
|
|
1367
1367
|
DeleteAll?: boolean;
|
|
1368
1368
|
}
|
|
@@ -1376,13 +1376,13 @@ export interface DeleteCustomMetadataResponse {
|
|
|
1376
1376
|
*/
|
|
1377
1377
|
export interface DeleteDocumentRequest {
|
|
1378
1378
|
/**
|
|
1379
|
-
* @public
|
|
1380
1379
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1380
|
+
* @public
|
|
1381
1381
|
*/
|
|
1382
1382
|
AuthenticationToken?: string;
|
|
1383
1383
|
/**
|
|
1384
|
-
* @public
|
|
1385
1384
|
* <p>The ID of the document.</p>
|
|
1385
|
+
* @public
|
|
1386
1386
|
*/
|
|
1387
1387
|
DocumentId: string | undefined;
|
|
1388
1388
|
}
|
|
@@ -1391,29 +1391,29 @@ export interface DeleteDocumentRequest {
|
|
|
1391
1391
|
*/
|
|
1392
1392
|
export interface DeleteDocumentVersionRequest {
|
|
1393
1393
|
/**
|
|
1394
|
-
* @public
|
|
1395
1394
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1395
|
+
* @public
|
|
1396
1396
|
*/
|
|
1397
1397
|
AuthenticationToken?: string;
|
|
1398
1398
|
/**
|
|
1399
|
-
* @public
|
|
1400
1399
|
* <p>The ID of the document associated with the version being deleted.</p>
|
|
1400
|
+
* @public
|
|
1401
1401
|
*/
|
|
1402
1402
|
DocumentId: string | undefined;
|
|
1403
1403
|
/**
|
|
1404
|
-
* @public
|
|
1405
1404
|
* <p>The ID of the version being deleted.</p>
|
|
1405
|
+
* @public
|
|
1406
1406
|
*/
|
|
1407
1407
|
VersionId: string | undefined;
|
|
1408
1408
|
/**
|
|
1409
|
-
* @public
|
|
1410
1409
|
* <p>Deletes all versions of a document prior to the current version.</p>
|
|
1410
|
+
* @public
|
|
1411
1411
|
*/
|
|
1412
1412
|
DeletePriorVersions: boolean | undefined;
|
|
1413
1413
|
}
|
|
1414
1414
|
/**
|
|
1415
|
-
* @public
|
|
1416
1415
|
* <p>The operation is invalid.</p>
|
|
1416
|
+
* @public
|
|
1417
1417
|
*/
|
|
1418
1418
|
export declare class InvalidOperationException extends __BaseException {
|
|
1419
1419
|
readonly name: "InvalidOperationException";
|
|
@@ -1429,13 +1429,13 @@ export declare class InvalidOperationException extends __BaseException {
|
|
|
1429
1429
|
*/
|
|
1430
1430
|
export interface DeleteFolderRequest {
|
|
1431
1431
|
/**
|
|
1432
|
-
* @public
|
|
1433
1432
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1433
|
+
* @public
|
|
1434
1434
|
*/
|
|
1435
1435
|
AuthenticationToken?: string;
|
|
1436
1436
|
/**
|
|
1437
|
-
* @public
|
|
1438
1437
|
* <p>The ID of the folder.</p>
|
|
1438
|
+
* @public
|
|
1439
1439
|
*/
|
|
1440
1440
|
FolderId: string | undefined;
|
|
1441
1441
|
}
|
|
@@ -1444,13 +1444,13 @@ export interface DeleteFolderRequest {
|
|
|
1444
1444
|
*/
|
|
1445
1445
|
export interface DeleteFolderContentsRequest {
|
|
1446
1446
|
/**
|
|
1447
|
-
* @public
|
|
1448
1447
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1448
|
+
* @public
|
|
1449
1449
|
*/
|
|
1450
1450
|
AuthenticationToken?: string;
|
|
1451
1451
|
/**
|
|
1452
|
-
* @public
|
|
1453
1452
|
* <p>The ID of the folder.</p>
|
|
1453
|
+
* @public
|
|
1454
1454
|
*/
|
|
1455
1455
|
FolderId: string | undefined;
|
|
1456
1456
|
}
|
|
@@ -1459,23 +1459,23 @@ export interface DeleteFolderContentsRequest {
|
|
|
1459
1459
|
*/
|
|
1460
1460
|
export interface DeleteLabelsRequest {
|
|
1461
1461
|
/**
|
|
1462
|
-
* @public
|
|
1463
1462
|
* <p>The ID of the resource.</p>
|
|
1463
|
+
* @public
|
|
1464
1464
|
*/
|
|
1465
1465
|
ResourceId: string | undefined;
|
|
1466
1466
|
/**
|
|
1467
|
-
* @public
|
|
1468
1467
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1468
|
+
* @public
|
|
1469
1469
|
*/
|
|
1470
1470
|
AuthenticationToken?: string;
|
|
1471
1471
|
/**
|
|
1472
|
-
* @public
|
|
1473
1472
|
* <p>List of labels to delete from the resource.</p>
|
|
1473
|
+
* @public
|
|
1474
1474
|
*/
|
|
1475
1475
|
Labels?: string[];
|
|
1476
1476
|
/**
|
|
1477
|
-
* @public
|
|
1478
1477
|
* <p>Flag to request removal of all labels from the specified resource.</p>
|
|
1478
|
+
* @public
|
|
1479
1479
|
*/
|
|
1480
1480
|
DeleteAll?: boolean;
|
|
1481
1481
|
}
|
|
@@ -1489,13 +1489,13 @@ export interface DeleteLabelsResponse {
|
|
|
1489
1489
|
*/
|
|
1490
1490
|
export interface DeleteNotificationSubscriptionRequest {
|
|
1491
1491
|
/**
|
|
1492
|
-
* @public
|
|
1493
1492
|
* <p>The ID of the subscription.</p>
|
|
1493
|
+
* @public
|
|
1494
1494
|
*/
|
|
1495
1495
|
SubscriptionId: string | undefined;
|
|
1496
1496
|
/**
|
|
1497
|
-
* @public
|
|
1498
1497
|
* <p>The ID of the organization.</p>
|
|
1498
|
+
* @public
|
|
1499
1499
|
*/
|
|
1500
1500
|
OrganizationId: string | undefined;
|
|
1501
1501
|
}
|
|
@@ -1504,14 +1504,14 @@ export interface DeleteNotificationSubscriptionRequest {
|
|
|
1504
1504
|
*/
|
|
1505
1505
|
export interface DeleteUserRequest {
|
|
1506
1506
|
/**
|
|
1507
|
-
* @public
|
|
1508
1507
|
* <p>Amazon WorkDocs authentication token. Do not set this field when using
|
|
1509
1508
|
* administrative API actions, as in accessing the API using Amazon Web Services credentials.</p>
|
|
1509
|
+
* @public
|
|
1510
1510
|
*/
|
|
1511
1511
|
AuthenticationToken?: string;
|
|
1512
1512
|
/**
|
|
1513
|
-
* @public
|
|
1514
1513
|
* <p>The ID of the user.</p>
|
|
1514
|
+
* @public
|
|
1515
1515
|
*/
|
|
1516
1516
|
UserId: string | undefined;
|
|
1517
1517
|
}
|
|
@@ -1520,62 +1520,62 @@ export interface DeleteUserRequest {
|
|
|
1520
1520
|
*/
|
|
1521
1521
|
export interface DescribeActivitiesRequest {
|
|
1522
1522
|
/**
|
|
1523
|
-
* @public
|
|
1524
1523
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1524
|
+
* @public
|
|
1525
1525
|
*/
|
|
1526
1526
|
AuthenticationToken?: string;
|
|
1527
1527
|
/**
|
|
1528
|
-
* @public
|
|
1529
1528
|
* <p>The timestamp that determines the starting time of the activities. The response
|
|
1530
1529
|
* includes the activities performed after the specified timestamp.</p>
|
|
1530
|
+
* @public
|
|
1531
1531
|
*/
|
|
1532
1532
|
StartTime?: Date;
|
|
1533
1533
|
/**
|
|
1534
|
-
* @public
|
|
1535
1534
|
* <p>The timestamp that determines the end time of the activities. The response includes
|
|
1536
1535
|
* the activities performed before the specified timestamp.</p>
|
|
1536
|
+
* @public
|
|
1537
1537
|
*/
|
|
1538
1538
|
EndTime?: Date;
|
|
1539
1539
|
/**
|
|
1540
|
-
* @public
|
|
1541
1540
|
* <p>The ID of the organization. This is a mandatory parameter when using administrative
|
|
1542
1541
|
* API (SigV4) requests.</p>
|
|
1542
|
+
* @public
|
|
1543
1543
|
*/
|
|
1544
1544
|
OrganizationId?: string;
|
|
1545
1545
|
/**
|
|
1546
|
-
* @public
|
|
1547
1546
|
* <p>Specifies which activity types to include in the response. If this field is left
|
|
1548
1547
|
* empty, all activity types are returned.</p>
|
|
1548
|
+
* @public
|
|
1549
1549
|
*/
|
|
1550
1550
|
ActivityTypes?: string;
|
|
1551
1551
|
/**
|
|
1552
|
-
* @public
|
|
1553
1552
|
* <p>The document or folder ID for which to describe activity types.</p>
|
|
1553
|
+
* @public
|
|
1554
1554
|
*/
|
|
1555
1555
|
ResourceId?: string;
|
|
1556
1556
|
/**
|
|
1557
|
-
* @public
|
|
1558
1557
|
* <p>The ID of the user who performed the action. The response includes activities
|
|
1559
1558
|
* pertaining to this user. This is an optional parameter and is only applicable for
|
|
1560
1559
|
* administrative API (SigV4) requests.</p>
|
|
1560
|
+
* @public
|
|
1561
1561
|
*/
|
|
1562
1562
|
UserId?: string;
|
|
1563
1563
|
/**
|
|
1564
|
-
* @public
|
|
1565
1564
|
* <p>Includes indirect activities. An indirect activity results from a direct activity
|
|
1566
1565
|
* performed on a parent resource. For example, sharing a parent folder (the direct
|
|
1567
1566
|
* activity) shares all of the subfolders and documents within the parent folder (the
|
|
1568
1567
|
* indirect activity).</p>
|
|
1568
|
+
* @public
|
|
1569
1569
|
*/
|
|
1570
1570
|
IncludeIndirectActivities?: boolean;
|
|
1571
1571
|
/**
|
|
1572
|
-
* @public
|
|
1573
1572
|
* <p>The maximum number of items to return.</p>
|
|
1573
|
+
* @public
|
|
1574
1574
|
*/
|
|
1575
1575
|
Limit?: number;
|
|
1576
1576
|
/**
|
|
1577
|
-
* @public
|
|
1578
1577
|
* <p>The marker for the next set of results.</p>
|
|
1578
|
+
* @public
|
|
1579
1579
|
*/
|
|
1580
1580
|
Marker?: string;
|
|
1581
1581
|
}
|
|
@@ -1584,13 +1584,13 @@ export interface DescribeActivitiesRequest {
|
|
|
1584
1584
|
*/
|
|
1585
1585
|
export interface DescribeActivitiesResponse {
|
|
1586
1586
|
/**
|
|
1587
|
-
* @public
|
|
1588
1587
|
* <p>The list of activities for the specified user and time period.</p>
|
|
1588
|
+
* @public
|
|
1589
1589
|
*/
|
|
1590
1590
|
UserActivities?: Activity[];
|
|
1591
1591
|
/**
|
|
1592
|
-
* @public
|
|
1593
1592
|
* <p>The marker for the next set of results.</p>
|
|
1593
|
+
* @public
|
|
1594
1594
|
*/
|
|
1595
1595
|
Marker?: string;
|
|
1596
1596
|
}
|
|
@@ -1599,29 +1599,29 @@ export interface DescribeActivitiesResponse {
|
|
|
1599
1599
|
*/
|
|
1600
1600
|
export interface DescribeCommentsRequest {
|
|
1601
1601
|
/**
|
|
1602
|
-
* @public
|
|
1603
1602
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1603
|
+
* @public
|
|
1604
1604
|
*/
|
|
1605
1605
|
AuthenticationToken?: string;
|
|
1606
1606
|
/**
|
|
1607
|
-
* @public
|
|
1608
1607
|
* <p>The ID of the document.</p>
|
|
1608
|
+
* @public
|
|
1609
1609
|
*/
|
|
1610
1610
|
DocumentId: string | undefined;
|
|
1611
1611
|
/**
|
|
1612
|
-
* @public
|
|
1613
1612
|
* <p>The ID of the document version.</p>
|
|
1613
|
+
* @public
|
|
1614
1614
|
*/
|
|
1615
1615
|
VersionId: string | undefined;
|
|
1616
1616
|
/**
|
|
1617
|
-
* @public
|
|
1618
1617
|
* <p>The maximum number of items to return.</p>
|
|
1618
|
+
* @public
|
|
1619
1619
|
*/
|
|
1620
1620
|
Limit?: number;
|
|
1621
1621
|
/**
|
|
1622
|
-
* @public
|
|
1623
1622
|
* <p>The marker for the next set of results. This marker was received from a previous
|
|
1624
1623
|
* call.</p>
|
|
1624
|
+
* @public
|
|
1625
1625
|
*/
|
|
1626
1626
|
Marker?: string;
|
|
1627
1627
|
}
|
|
@@ -1630,14 +1630,14 @@ export interface DescribeCommentsRequest {
|
|
|
1630
1630
|
*/
|
|
1631
1631
|
export interface DescribeCommentsResponse {
|
|
1632
1632
|
/**
|
|
1633
|
-
* @public
|
|
1634
1633
|
* <p>The list of comments for the specified document version.</p>
|
|
1634
|
+
* @public
|
|
1635
1635
|
*/
|
|
1636
1636
|
Comments?: Comment[];
|
|
1637
1637
|
/**
|
|
1638
|
-
* @public
|
|
1639
1638
|
* <p>The marker for the next set of results. This marker was received from a previous
|
|
1640
1639
|
* call.</p>
|
|
1640
|
+
* @public
|
|
1641
1641
|
*/
|
|
1642
1642
|
Marker?: string;
|
|
1643
1643
|
}
|
|
@@ -1646,36 +1646,36 @@ export interface DescribeCommentsResponse {
|
|
|
1646
1646
|
*/
|
|
1647
1647
|
export interface DescribeDocumentVersionsRequest {
|
|
1648
1648
|
/**
|
|
1649
|
-
* @public
|
|
1650
1649
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1650
|
+
* @public
|
|
1651
1651
|
*/
|
|
1652
1652
|
AuthenticationToken?: string;
|
|
1653
1653
|
/**
|
|
1654
|
-
* @public
|
|
1655
1654
|
* <p>The ID of the document.</p>
|
|
1655
|
+
* @public
|
|
1656
1656
|
*/
|
|
1657
1657
|
DocumentId: string | undefined;
|
|
1658
1658
|
/**
|
|
1659
|
-
* @public
|
|
1660
1659
|
* <p>The marker for the next set of results. (You received this marker from a previous
|
|
1661
1660
|
* call.)</p>
|
|
1661
|
+
* @public
|
|
1662
1662
|
*/
|
|
1663
1663
|
Marker?: string;
|
|
1664
1664
|
/**
|
|
1665
|
-
* @public
|
|
1666
1665
|
* <p>The maximum number of versions to return with this call.</p>
|
|
1666
|
+
* @public
|
|
1667
1667
|
*/
|
|
1668
1668
|
Limit?: number;
|
|
1669
1669
|
/**
|
|
1670
|
-
* @public
|
|
1671
1670
|
* <p>A comma-separated list of values. Specify "INITIALIZED" to include incomplete
|
|
1672
1671
|
* versions.</p>
|
|
1672
|
+
* @public
|
|
1673
1673
|
*/
|
|
1674
1674
|
Include?: string;
|
|
1675
1675
|
/**
|
|
1676
|
-
* @public
|
|
1677
1676
|
* <p>Specify "SOURCE" to include initialized versions and a URL for the source
|
|
1678
1677
|
* document.</p>
|
|
1678
|
+
* @public
|
|
1679
1679
|
*/
|
|
1680
1680
|
Fields?: string;
|
|
1681
1681
|
}
|
|
@@ -1717,73 +1717,73 @@ export declare const DocumentThumbnailType: {
|
|
|
1717
1717
|
*/
|
|
1718
1718
|
export type DocumentThumbnailType = (typeof DocumentThumbnailType)[keyof typeof DocumentThumbnailType];
|
|
1719
1719
|
/**
|
|
1720
|
-
* @public
|
|
1721
1720
|
* <p>Describes a version of a document.</p>
|
|
1721
|
+
* @public
|
|
1722
1722
|
*/
|
|
1723
1723
|
export interface DocumentVersionMetadata {
|
|
1724
1724
|
/**
|
|
1725
|
-
* @public
|
|
1726
1725
|
* <p>The ID of the version.</p>
|
|
1726
|
+
* @public
|
|
1727
1727
|
*/
|
|
1728
1728
|
Id?: string;
|
|
1729
1729
|
/**
|
|
1730
|
-
* @public
|
|
1731
1730
|
* <p>The name of the version.</p>
|
|
1731
|
+
* @public
|
|
1732
1732
|
*/
|
|
1733
1733
|
Name?: string;
|
|
1734
1734
|
/**
|
|
1735
|
-
* @public
|
|
1736
1735
|
* <p>The content type of the document.</p>
|
|
1736
|
+
* @public
|
|
1737
1737
|
*/
|
|
1738
1738
|
ContentType?: string;
|
|
1739
1739
|
/**
|
|
1740
|
-
* @public
|
|
1741
1740
|
* <p>The size of the document, in bytes.</p>
|
|
1741
|
+
* @public
|
|
1742
1742
|
*/
|
|
1743
1743
|
Size?: number;
|
|
1744
1744
|
/**
|
|
1745
|
-
* @public
|
|
1746
1745
|
* <p>The signature of the document.</p>
|
|
1746
|
+
* @public
|
|
1747
1747
|
*/
|
|
1748
1748
|
Signature?: string;
|
|
1749
1749
|
/**
|
|
1750
|
-
* @public
|
|
1751
1750
|
* <p>The status of the document.</p>
|
|
1751
|
+
* @public
|
|
1752
1752
|
*/
|
|
1753
1753
|
Status?: DocumentStatusType;
|
|
1754
1754
|
/**
|
|
1755
|
-
* @public
|
|
1756
1755
|
* <p>The timestamp when the document was first uploaded.</p>
|
|
1756
|
+
* @public
|
|
1757
1757
|
*/
|
|
1758
1758
|
CreatedTimestamp?: Date;
|
|
1759
1759
|
/**
|
|
1760
|
-
* @public
|
|
1761
1760
|
* <p>The timestamp when the document was last uploaded.</p>
|
|
1761
|
+
* @public
|
|
1762
1762
|
*/
|
|
1763
1763
|
ModifiedTimestamp?: Date;
|
|
1764
1764
|
/**
|
|
1765
|
-
* @public
|
|
1766
1765
|
* <p>The timestamp when the content of the document was originally created.</p>
|
|
1766
|
+
* @public
|
|
1767
1767
|
*/
|
|
1768
1768
|
ContentCreatedTimestamp?: Date;
|
|
1769
1769
|
/**
|
|
1770
|
-
* @public
|
|
1771
1770
|
* <p>The timestamp when the content of the document was modified.</p>
|
|
1771
|
+
* @public
|
|
1772
1772
|
*/
|
|
1773
1773
|
ContentModifiedTimestamp?: Date;
|
|
1774
1774
|
/**
|
|
1775
|
-
* @public
|
|
1776
1775
|
* <p>The ID of the creator.</p>
|
|
1776
|
+
* @public
|
|
1777
1777
|
*/
|
|
1778
1778
|
CreatorId?: string;
|
|
1779
1779
|
/**
|
|
1780
|
-
* @public
|
|
1781
1780
|
* <p>The thumbnail of the document.</p>
|
|
1781
|
+
* @public
|
|
1782
1782
|
*/
|
|
1783
1783
|
Thumbnail?: Partial<Record<DocumentThumbnailType, string>>;
|
|
1784
1784
|
/**
|
|
1785
|
-
* @public
|
|
1786
1785
|
* <p>The source of the document.</p>
|
|
1786
|
+
* @public
|
|
1787
1787
|
*/
|
|
1788
1788
|
Source?: Partial<Record<DocumentSourceType, string>>;
|
|
1789
1789
|
}
|
|
@@ -1792,20 +1792,20 @@ export interface DocumentVersionMetadata {
|
|
|
1792
1792
|
*/
|
|
1793
1793
|
export interface DescribeDocumentVersionsResponse {
|
|
1794
1794
|
/**
|
|
1795
|
-
* @public
|
|
1796
1795
|
* <p>The document versions.</p>
|
|
1796
|
+
* @public
|
|
1797
1797
|
*/
|
|
1798
1798
|
DocumentVersions?: DocumentVersionMetadata[];
|
|
1799
1799
|
/**
|
|
1800
|
-
* @public
|
|
1801
1800
|
* <p>The marker to use when requesting the next set of results. If there are no
|
|
1802
1801
|
* additional results, the string is empty.</p>
|
|
1802
|
+
* @public
|
|
1803
1803
|
*/
|
|
1804
1804
|
Marker?: string;
|
|
1805
1805
|
}
|
|
1806
1806
|
/**
|
|
1807
|
-
* @public
|
|
1808
1807
|
* <p>The password is invalid.</p>
|
|
1808
|
+
* @public
|
|
1809
1809
|
*/
|
|
1810
1810
|
export declare class InvalidPasswordException extends __BaseException {
|
|
1811
1811
|
readonly name: "InvalidPasswordException";
|
|
@@ -1858,91 +1858,91 @@ export type FolderContentType = (typeof FolderContentType)[keyof typeof FolderCo
|
|
|
1858
1858
|
*/
|
|
1859
1859
|
export interface DescribeFolderContentsRequest {
|
|
1860
1860
|
/**
|
|
1861
|
-
* @public
|
|
1862
1861
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1862
|
+
* @public
|
|
1863
1863
|
*/
|
|
1864
1864
|
AuthenticationToken?: string;
|
|
1865
1865
|
/**
|
|
1866
|
-
* @public
|
|
1867
1866
|
* <p>The ID of the folder.</p>
|
|
1867
|
+
* @public
|
|
1868
1868
|
*/
|
|
1869
1869
|
FolderId: string | undefined;
|
|
1870
1870
|
/**
|
|
1871
|
-
* @public
|
|
1872
1871
|
* <p>The sorting criteria.</p>
|
|
1872
|
+
* @public
|
|
1873
1873
|
*/
|
|
1874
1874
|
Sort?: ResourceSortType;
|
|
1875
1875
|
/**
|
|
1876
|
-
* @public
|
|
1877
1876
|
* <p>The order for the contents of the folder.</p>
|
|
1877
|
+
* @public
|
|
1878
1878
|
*/
|
|
1879
1879
|
Order?: OrderType;
|
|
1880
1880
|
/**
|
|
1881
|
-
* @public
|
|
1882
1881
|
* <p>The maximum number of items to return with this call.</p>
|
|
1882
|
+
* @public
|
|
1883
1883
|
*/
|
|
1884
1884
|
Limit?: number;
|
|
1885
1885
|
/**
|
|
1886
|
-
* @public
|
|
1887
1886
|
* <p>The marker for the next set of results. This marker was received from a previous
|
|
1888
1887
|
* call.</p>
|
|
1888
|
+
* @public
|
|
1889
1889
|
*/
|
|
1890
1890
|
Marker?: string;
|
|
1891
1891
|
/**
|
|
1892
|
-
* @public
|
|
1893
1892
|
* <p>The type of items.</p>
|
|
1893
|
+
* @public
|
|
1894
1894
|
*/
|
|
1895
1895
|
Type?: FolderContentType;
|
|
1896
1896
|
/**
|
|
1897
|
-
* @public
|
|
1898
1897
|
* <p>The contents to include. Specify "INITIALIZED" to include initialized
|
|
1899
1898
|
* documents.</p>
|
|
1899
|
+
* @public
|
|
1900
1900
|
*/
|
|
1901
1901
|
Include?: string;
|
|
1902
1902
|
}
|
|
1903
1903
|
/**
|
|
1904
|
-
* @public
|
|
1905
1904
|
* <p>Describes the document.</p>
|
|
1905
|
+
* @public
|
|
1906
1906
|
*/
|
|
1907
1907
|
export interface DocumentMetadata {
|
|
1908
1908
|
/**
|
|
1909
|
-
* @public
|
|
1910
1909
|
* <p>The ID of the document.</p>
|
|
1910
|
+
* @public
|
|
1911
1911
|
*/
|
|
1912
1912
|
Id?: string;
|
|
1913
1913
|
/**
|
|
1914
|
-
* @public
|
|
1915
1914
|
* <p>The ID of the creator.</p>
|
|
1915
|
+
* @public
|
|
1916
1916
|
*/
|
|
1917
1917
|
CreatorId?: string;
|
|
1918
1918
|
/**
|
|
1919
|
-
* @public
|
|
1920
1919
|
* <p>The ID of the parent folder.</p>
|
|
1920
|
+
* @public
|
|
1921
1921
|
*/
|
|
1922
1922
|
ParentFolderId?: string;
|
|
1923
1923
|
/**
|
|
1924
|
-
* @public
|
|
1925
1924
|
* <p>The time when the document was created.</p>
|
|
1925
|
+
* @public
|
|
1926
1926
|
*/
|
|
1927
1927
|
CreatedTimestamp?: Date;
|
|
1928
1928
|
/**
|
|
1929
|
-
* @public
|
|
1930
1929
|
* <p>The time when the document was updated.</p>
|
|
1930
|
+
* @public
|
|
1931
1931
|
*/
|
|
1932
1932
|
ModifiedTimestamp?: Date;
|
|
1933
1933
|
/**
|
|
1934
|
-
* @public
|
|
1935
1934
|
* <p>The latest version of the document.</p>
|
|
1935
|
+
* @public
|
|
1936
1936
|
*/
|
|
1937
1937
|
LatestVersionMetadata?: DocumentVersionMetadata;
|
|
1938
1938
|
/**
|
|
1939
|
-
* @public
|
|
1940
1939
|
* <p>The resource state.</p>
|
|
1940
|
+
* @public
|
|
1941
1941
|
*/
|
|
1942
1942
|
ResourceState?: ResourceStateType;
|
|
1943
1943
|
/**
|
|
1944
|
-
* @public
|
|
1945
1944
|
* <p>List of labels on the document.</p>
|
|
1945
|
+
* @public
|
|
1946
1946
|
*/
|
|
1947
1947
|
Labels?: string[];
|
|
1948
1948
|
}
|
|
@@ -1951,19 +1951,19 @@ export interface DocumentMetadata {
|
|
|
1951
1951
|
*/
|
|
1952
1952
|
export interface DescribeFolderContentsResponse {
|
|
1953
1953
|
/**
|
|
1954
|
-
* @public
|
|
1955
1954
|
* <p>The subfolders in the specified folder.</p>
|
|
1955
|
+
* @public
|
|
1956
1956
|
*/
|
|
1957
1957
|
Folders?: FolderMetadata[];
|
|
1958
1958
|
/**
|
|
1959
|
-
* @public
|
|
1960
1959
|
* <p>The documents in the specified folder.</p>
|
|
1960
|
+
* @public
|
|
1961
1961
|
*/
|
|
1962
1962
|
Documents?: DocumentMetadata[];
|
|
1963
1963
|
/**
|
|
1964
|
-
* @public
|
|
1965
1964
|
* <p>The marker to use when requesting the next set of results. If there are no
|
|
1966
1965
|
* additional results, the string is empty.</p>
|
|
1966
|
+
* @public
|
|
1967
1967
|
*/
|
|
1968
1968
|
Marker?: string;
|
|
1969
1969
|
}
|
|
@@ -1972,29 +1972,29 @@ export interface DescribeFolderContentsResponse {
|
|
|
1972
1972
|
*/
|
|
1973
1973
|
export interface DescribeGroupsRequest {
|
|
1974
1974
|
/**
|
|
1975
|
-
* @public
|
|
1976
1975
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
1976
|
+
* @public
|
|
1977
1977
|
*/
|
|
1978
1978
|
AuthenticationToken?: string;
|
|
1979
1979
|
/**
|
|
1980
|
-
* @public
|
|
1981
1980
|
* <p>A query to describe groups by group name.</p>
|
|
1981
|
+
* @public
|
|
1982
1982
|
*/
|
|
1983
1983
|
SearchQuery: string | undefined;
|
|
1984
1984
|
/**
|
|
1985
|
-
* @public
|
|
1986
1985
|
* <p>The ID of the organization.</p>
|
|
1986
|
+
* @public
|
|
1987
1987
|
*/
|
|
1988
1988
|
OrganizationId?: string;
|
|
1989
1989
|
/**
|
|
1990
|
-
* @public
|
|
1991
1990
|
* <p>The marker for the next set of results. (You received this marker from a previous
|
|
1992
1991
|
* call.)</p>
|
|
1992
|
+
* @public
|
|
1993
1993
|
*/
|
|
1994
1994
|
Marker?: string;
|
|
1995
1995
|
/**
|
|
1996
|
-
* @public
|
|
1997
1996
|
* <p>The maximum number of items to return with this call.</p>
|
|
1997
|
+
* @public
|
|
1998
1998
|
*/
|
|
1999
1999
|
Limit?: number;
|
|
2000
2000
|
}
|
|
@@ -2003,14 +2003,14 @@ export interface DescribeGroupsRequest {
|
|
|
2003
2003
|
*/
|
|
2004
2004
|
export interface DescribeGroupsResponse {
|
|
2005
2005
|
/**
|
|
2006
|
-
* @public
|
|
2007
2006
|
* <p>The list of groups.</p>
|
|
2007
|
+
* @public
|
|
2008
2008
|
*/
|
|
2009
2009
|
Groups?: GroupMetadata[];
|
|
2010
2010
|
/**
|
|
2011
|
-
* @public
|
|
2012
2011
|
* <p>The marker to use when requesting the next set of results. If there are no additional
|
|
2013
2012
|
* results, the string is empty.</p>
|
|
2013
|
+
* @public
|
|
2014
2014
|
*/
|
|
2015
2015
|
Marker?: string;
|
|
2016
2016
|
}
|
|
@@ -2019,19 +2019,19 @@ export interface DescribeGroupsResponse {
|
|
|
2019
2019
|
*/
|
|
2020
2020
|
export interface DescribeNotificationSubscriptionsRequest {
|
|
2021
2021
|
/**
|
|
2022
|
-
* @public
|
|
2023
2022
|
* <p>The ID of the organization.</p>
|
|
2023
|
+
* @public
|
|
2024
2024
|
*/
|
|
2025
2025
|
OrganizationId: string | undefined;
|
|
2026
2026
|
/**
|
|
2027
|
-
* @public
|
|
2028
2027
|
* <p>The marker for the next set of results. (You received this marker from a previous
|
|
2029
2028
|
* call.)</p>
|
|
2029
|
+
* @public
|
|
2030
2030
|
*/
|
|
2031
2031
|
Marker?: string;
|
|
2032
2032
|
/**
|
|
2033
|
-
* @public
|
|
2034
2033
|
* <p>The maximum number of items to return with this call.</p>
|
|
2034
|
+
* @public
|
|
2035
2035
|
*/
|
|
2036
2036
|
Limit?: number;
|
|
2037
2037
|
}
|
|
@@ -2040,14 +2040,14 @@ export interface DescribeNotificationSubscriptionsRequest {
|
|
|
2040
2040
|
*/
|
|
2041
2041
|
export interface DescribeNotificationSubscriptionsResponse {
|
|
2042
2042
|
/**
|
|
2043
|
-
* @public
|
|
2044
2043
|
* <p>The subscriptions.</p>
|
|
2044
|
+
* @public
|
|
2045
2045
|
*/
|
|
2046
2046
|
Subscriptions?: Subscription[];
|
|
2047
2047
|
/**
|
|
2048
|
-
* @public
|
|
2049
2048
|
* <p>The marker to use when requesting the next set of results. If there are no
|
|
2050
2049
|
* additional results, the string is empty.</p>
|
|
2050
|
+
* @public
|
|
2051
2051
|
*/
|
|
2052
2052
|
Marker?: string;
|
|
2053
2053
|
}
|
|
@@ -2056,29 +2056,29 @@ export interface DescribeNotificationSubscriptionsResponse {
|
|
|
2056
2056
|
*/
|
|
2057
2057
|
export interface DescribeResourcePermissionsRequest {
|
|
2058
2058
|
/**
|
|
2059
|
-
* @public
|
|
2060
2059
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2060
|
+
* @public
|
|
2061
2061
|
*/
|
|
2062
2062
|
AuthenticationToken?: string;
|
|
2063
2063
|
/**
|
|
2064
|
-
* @public
|
|
2065
2064
|
* <p>The ID of the resource.</p>
|
|
2065
|
+
* @public
|
|
2066
2066
|
*/
|
|
2067
2067
|
ResourceId: string | undefined;
|
|
2068
2068
|
/**
|
|
2069
|
-
* @public
|
|
2070
2069
|
* <p>The ID of the principal to filter permissions by.</p>
|
|
2070
|
+
* @public
|
|
2071
2071
|
*/
|
|
2072
2072
|
PrincipalId?: string;
|
|
2073
2073
|
/**
|
|
2074
|
-
* @public
|
|
2075
2074
|
* <p>The maximum number of items to return with this call.</p>
|
|
2075
|
+
* @public
|
|
2076
2076
|
*/
|
|
2077
2077
|
Limit?: number;
|
|
2078
2078
|
/**
|
|
2079
|
-
* @public
|
|
2080
2079
|
* <p>The marker for the next set of results. (You received this marker from a previous
|
|
2081
2080
|
* call)</p>
|
|
2081
|
+
* @public
|
|
2082
2082
|
*/
|
|
2083
2083
|
Marker?: string;
|
|
2084
2084
|
}
|
|
@@ -2095,39 +2095,39 @@ export declare const RolePermissionType: {
|
|
|
2095
2095
|
*/
|
|
2096
2096
|
export type RolePermissionType = (typeof RolePermissionType)[keyof typeof RolePermissionType];
|
|
2097
2097
|
/**
|
|
2098
|
-
* @public
|
|
2099
2098
|
* <p>Describes the permissions.</p>
|
|
2099
|
+
* @public
|
|
2100
2100
|
*/
|
|
2101
2101
|
export interface PermissionInfo {
|
|
2102
2102
|
/**
|
|
2103
|
-
* @public
|
|
2104
2103
|
* <p>The role of the user.</p>
|
|
2104
|
+
* @public
|
|
2105
2105
|
*/
|
|
2106
2106
|
Role?: RoleType;
|
|
2107
2107
|
/**
|
|
2108
|
-
* @public
|
|
2109
2108
|
* <p>The type of permissions.</p>
|
|
2109
|
+
* @public
|
|
2110
2110
|
*/
|
|
2111
2111
|
Type?: RolePermissionType;
|
|
2112
2112
|
}
|
|
2113
2113
|
/**
|
|
2114
|
-
* @public
|
|
2115
2114
|
* <p>Describes a resource.</p>
|
|
2115
|
+
* @public
|
|
2116
2116
|
*/
|
|
2117
2117
|
export interface Principal {
|
|
2118
2118
|
/**
|
|
2119
|
-
* @public
|
|
2120
2119
|
* <p>The ID of the resource.</p>
|
|
2120
|
+
* @public
|
|
2121
2121
|
*/
|
|
2122
2122
|
Id?: string;
|
|
2123
2123
|
/**
|
|
2124
|
-
* @public
|
|
2125
2124
|
* <p>The type of resource.</p>
|
|
2125
|
+
* @public
|
|
2126
2126
|
*/
|
|
2127
2127
|
Type?: PrincipalType;
|
|
2128
2128
|
/**
|
|
2129
|
-
* @public
|
|
2130
2129
|
* <p>The permission information for the resource.</p>
|
|
2130
|
+
* @public
|
|
2131
2131
|
*/
|
|
2132
2132
|
Roles?: PermissionInfo[];
|
|
2133
2133
|
}
|
|
@@ -2136,14 +2136,14 @@ export interface Principal {
|
|
|
2136
2136
|
*/
|
|
2137
2137
|
export interface DescribeResourcePermissionsResponse {
|
|
2138
2138
|
/**
|
|
2139
|
-
* @public
|
|
2140
2139
|
* <p>The principals.</p>
|
|
2140
|
+
* @public
|
|
2141
2141
|
*/
|
|
2142
2142
|
Principals?: Principal[];
|
|
2143
2143
|
/**
|
|
2144
|
-
* @public
|
|
2145
2144
|
* <p>The marker to use when requesting the next set of results. If there are no
|
|
2146
2145
|
* additional results, the string is empty.</p>
|
|
2146
|
+
* @public
|
|
2147
2147
|
*/
|
|
2148
2148
|
Marker?: string;
|
|
2149
2149
|
}
|
|
@@ -2152,19 +2152,19 @@ export interface DescribeResourcePermissionsResponse {
|
|
|
2152
2152
|
*/
|
|
2153
2153
|
export interface DescribeRootFoldersRequest {
|
|
2154
2154
|
/**
|
|
2155
|
-
* @public
|
|
2156
2155
|
* <p>Amazon WorkDocs authentication token.</p>
|
|
2156
|
+
* @public
|
|
2157
2157
|
*/
|
|
2158
2158
|
AuthenticationToken: string | undefined;
|
|
2159
2159
|
/**
|
|
2160
|
-
* @public
|
|
2161
2160
|
* <p>The maximum number of items to return.</p>
|
|
2161
|
+
* @public
|
|
2162
2162
|
*/
|
|
2163
2163
|
Limit?: number;
|
|
2164
2164
|
/**
|
|
2165
|
-
* @public
|
|
2166
2165
|
* <p>The marker for the next set of results. (You received this marker from a previous
|
|
2167
2166
|
* call.)</p>
|
|
2167
|
+
* @public
|
|
2168
2168
|
*/
|
|
2169
2169
|
Marker?: string;
|
|
2170
2170
|
}
|
|
@@ -2173,13 +2173,13 @@ export interface DescribeRootFoldersRequest {
|
|
|
2173
2173
|
*/
|
|
2174
2174
|
export interface DescribeRootFoldersResponse {
|
|
2175
2175
|
/**
|
|
2176
|
-
* @public
|
|
2177
2176
|
* <p>The user's special folders.</p>
|
|
2177
|
+
* @public
|
|
2178
2178
|
*/
|
|
2179
2179
|
Folders?: FolderMetadata[];
|
|
2180
2180
|
/**
|
|
2181
|
-
* @public
|
|
2182
2181
|
* <p>The marker for the next set of results.</p>
|
|
2182
|
+
* @public
|
|
2183
2183
|
*/
|
|
2184
2184
|
Marker?: string;
|
|
2185
2185
|
}
|
|
@@ -2215,22 +2215,21 @@ export type UserSortType = (typeof UserSortType)[keyof typeof UserSortType];
|
|
|
2215
2215
|
*/
|
|
2216
2216
|
export interface DescribeUsersRequest {
|
|
2217
2217
|
/**
|
|
2218
|
-
* @public
|
|
2219
2218
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2219
|
+
* @public
|
|
2220
2220
|
*/
|
|
2221
2221
|
AuthenticationToken?: string;
|
|
2222
2222
|
/**
|
|
2223
|
-
* @public
|
|
2224
2223
|
* <p>The ID of the organization.</p>
|
|
2224
|
+
* @public
|
|
2225
2225
|
*/
|
|
2226
2226
|
OrganizationId?: string;
|
|
2227
2227
|
/**
|
|
2228
|
-
* @public
|
|
2229
2228
|
* <p>The IDs of the users.</p>
|
|
2229
|
+
* @public
|
|
2230
2230
|
*/
|
|
2231
2231
|
UserIds?: string;
|
|
2232
2232
|
/**
|
|
2233
|
-
* @public
|
|
2234
2233
|
* <p>A query to filter users by user name. Remember the following about the <code>Userids</code> and <code>Query</code> parameters:</p>
|
|
2235
2234
|
* <ul>
|
|
2236
2235
|
* <li>
|
|
@@ -2249,38 +2248,39 @@ export interface DescribeUsersRequest {
|
|
|
2249
2248
|
* returns Mateo Jackson.</p>
|
|
2250
2249
|
* </li>
|
|
2251
2250
|
* </ul>
|
|
2251
|
+
* @public
|
|
2252
2252
|
*/
|
|
2253
2253
|
Query?: string;
|
|
2254
2254
|
/**
|
|
2255
|
-
* @public
|
|
2256
2255
|
* <p>The state of the users. Specify "ALL" to include inactive users.</p>
|
|
2256
|
+
* @public
|
|
2257
2257
|
*/
|
|
2258
2258
|
Include?: UserFilterType;
|
|
2259
2259
|
/**
|
|
2260
|
-
* @public
|
|
2261
2260
|
* <p>The order for the results.</p>
|
|
2261
|
+
* @public
|
|
2262
2262
|
*/
|
|
2263
2263
|
Order?: OrderType;
|
|
2264
2264
|
/**
|
|
2265
|
-
* @public
|
|
2266
2265
|
* <p>The sorting criteria.</p>
|
|
2266
|
+
* @public
|
|
2267
2267
|
*/
|
|
2268
2268
|
Sort?: UserSortType;
|
|
2269
2269
|
/**
|
|
2270
|
-
* @public
|
|
2271
2270
|
* <p>The marker for the next set of results. (You received this marker from a previous
|
|
2272
2271
|
* call.)</p>
|
|
2272
|
+
* @public
|
|
2273
2273
|
*/
|
|
2274
2274
|
Marker?: string;
|
|
2275
2275
|
/**
|
|
2276
|
-
* @public
|
|
2277
2276
|
* <p>The maximum number of items to return.</p>
|
|
2277
|
+
* @public
|
|
2278
2278
|
*/
|
|
2279
2279
|
Limit?: number;
|
|
2280
2280
|
/**
|
|
2281
|
-
* @public
|
|
2282
2281
|
* <p>A comma-separated list of values. Specify "STORAGE_METADATA" to include the user
|
|
2283
2282
|
* storage quota and utilization information.</p>
|
|
2283
|
+
* @public
|
|
2284
2284
|
*/
|
|
2285
2285
|
Fields?: string;
|
|
2286
2286
|
}
|
|
@@ -2289,27 +2289,27 @@ export interface DescribeUsersRequest {
|
|
|
2289
2289
|
*/
|
|
2290
2290
|
export interface DescribeUsersResponse {
|
|
2291
2291
|
/**
|
|
2292
|
-
* @public
|
|
2293
2292
|
* <p>The users.</p>
|
|
2293
|
+
* @public
|
|
2294
2294
|
*/
|
|
2295
2295
|
Users?: User[];
|
|
2296
2296
|
/**
|
|
2297
|
-
* @public
|
|
2298
2297
|
* @deprecated
|
|
2299
2298
|
*
|
|
2300
2299
|
* <p>The total number of users included in the results.</p>
|
|
2300
|
+
* @public
|
|
2301
2301
|
*/
|
|
2302
2302
|
TotalNumberOfUsers?: number;
|
|
2303
2303
|
/**
|
|
2304
|
-
* @public
|
|
2305
2304
|
* <p>The marker to use when requesting the next set of results. If there are no
|
|
2306
2305
|
* additional results, the string is empty.</p>
|
|
2306
|
+
* @public
|
|
2307
2307
|
*/
|
|
2308
2308
|
Marker?: string;
|
|
2309
2309
|
}
|
|
2310
2310
|
/**
|
|
2311
|
-
* @public
|
|
2312
2311
|
* <p>The response is too large to return. The request must include a filter to reduce the size of the response.</p>
|
|
2312
|
+
* @public
|
|
2313
2313
|
*/
|
|
2314
2314
|
export declare class RequestedEntityTooLargeException extends __BaseException {
|
|
2315
2315
|
readonly name: "RequestedEntityTooLargeException";
|
|
@@ -2325,8 +2325,8 @@ export declare class RequestedEntityTooLargeException extends __BaseException {
|
|
|
2325
2325
|
*/
|
|
2326
2326
|
export interface GetCurrentUserRequest {
|
|
2327
2327
|
/**
|
|
2328
|
-
* @public
|
|
2329
2328
|
* <p>Amazon WorkDocs authentication token.</p>
|
|
2329
|
+
* @public
|
|
2330
2330
|
*/
|
|
2331
2331
|
AuthenticationToken: string | undefined;
|
|
2332
2332
|
}
|
|
@@ -2335,8 +2335,8 @@ export interface GetCurrentUserRequest {
|
|
|
2335
2335
|
*/
|
|
2336
2336
|
export interface GetCurrentUserResponse {
|
|
2337
2337
|
/**
|
|
2338
|
-
* @public
|
|
2339
2338
|
* <p>Metadata of the user.</p>
|
|
2339
|
+
* @public
|
|
2340
2340
|
*/
|
|
2341
2341
|
User?: User;
|
|
2342
2342
|
}
|
|
@@ -2345,18 +2345,18 @@ export interface GetCurrentUserResponse {
|
|
|
2345
2345
|
*/
|
|
2346
2346
|
export interface GetDocumentRequest {
|
|
2347
2347
|
/**
|
|
2348
|
-
* @public
|
|
2349
2348
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2349
|
+
* @public
|
|
2350
2350
|
*/
|
|
2351
2351
|
AuthenticationToken?: string;
|
|
2352
2352
|
/**
|
|
2353
|
-
* @public
|
|
2354
2353
|
* <p>The ID of the document.</p>
|
|
2354
|
+
* @public
|
|
2355
2355
|
*/
|
|
2356
2356
|
DocumentId: string | undefined;
|
|
2357
2357
|
/**
|
|
2358
|
-
* @public
|
|
2359
2358
|
* <p>Set this to <code>TRUE</code> to include custom metadata in the response.</p>
|
|
2359
|
+
* @public
|
|
2360
2360
|
*/
|
|
2361
2361
|
IncludeCustomMetadata?: boolean;
|
|
2362
2362
|
}
|
|
@@ -2365,13 +2365,13 @@ export interface GetDocumentRequest {
|
|
|
2365
2365
|
*/
|
|
2366
2366
|
export interface GetDocumentResponse {
|
|
2367
2367
|
/**
|
|
2368
|
-
* @public
|
|
2369
2368
|
* <p>The metadata details of the document.</p>
|
|
2369
|
+
* @public
|
|
2370
2370
|
*/
|
|
2371
2371
|
Metadata?: DocumentMetadata;
|
|
2372
2372
|
/**
|
|
2373
|
-
* @public
|
|
2374
2373
|
* <p>The custom metadata on the document.</p>
|
|
2374
|
+
* @public
|
|
2375
2375
|
*/
|
|
2376
2376
|
CustomMetadata?: Record<string, string>;
|
|
2377
2377
|
}
|
|
@@ -2380,56 +2380,56 @@ export interface GetDocumentResponse {
|
|
|
2380
2380
|
*/
|
|
2381
2381
|
export interface GetDocumentPathRequest {
|
|
2382
2382
|
/**
|
|
2383
|
-
* @public
|
|
2384
2383
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2384
|
+
* @public
|
|
2385
2385
|
*/
|
|
2386
2386
|
AuthenticationToken?: string;
|
|
2387
2387
|
/**
|
|
2388
|
-
* @public
|
|
2389
2388
|
* <p>The ID of the document.</p>
|
|
2389
|
+
* @public
|
|
2390
2390
|
*/
|
|
2391
2391
|
DocumentId: string | undefined;
|
|
2392
2392
|
/**
|
|
2393
|
-
* @public
|
|
2394
2393
|
* <p>The maximum number of levels in the hierarchy to return.</p>
|
|
2394
|
+
* @public
|
|
2395
2395
|
*/
|
|
2396
2396
|
Limit?: number;
|
|
2397
2397
|
/**
|
|
2398
|
-
* @public
|
|
2399
2398
|
* <p>A comma-separated list of values. Specify <code>NAME</code> to include the names of
|
|
2400
2399
|
* the parent folders.</p>
|
|
2400
|
+
* @public
|
|
2401
2401
|
*/
|
|
2402
2402
|
Fields?: string;
|
|
2403
2403
|
/**
|
|
2404
|
-
* @public
|
|
2405
2404
|
* <p>This value is not supported.</p>
|
|
2405
|
+
* @public
|
|
2406
2406
|
*/
|
|
2407
2407
|
Marker?: string;
|
|
2408
2408
|
}
|
|
2409
2409
|
/**
|
|
2410
|
-
* @public
|
|
2411
2410
|
* <p>Describes the resource path.</p>
|
|
2411
|
+
* @public
|
|
2412
2412
|
*/
|
|
2413
2413
|
export interface ResourcePathComponent {
|
|
2414
2414
|
/**
|
|
2415
|
-
* @public
|
|
2416
2415
|
* <p>The ID of the resource path.</p>
|
|
2416
|
+
* @public
|
|
2417
2417
|
*/
|
|
2418
2418
|
Id?: string;
|
|
2419
2419
|
/**
|
|
2420
|
-
* @public
|
|
2421
2420
|
* <p>The name of the resource path.</p>
|
|
2421
|
+
* @public
|
|
2422
2422
|
*/
|
|
2423
2423
|
Name?: string;
|
|
2424
2424
|
}
|
|
2425
2425
|
/**
|
|
2426
|
-
* @public
|
|
2427
2426
|
* <p>Describes the path information of a resource.</p>
|
|
2427
|
+
* @public
|
|
2428
2428
|
*/
|
|
2429
2429
|
export interface ResourcePath {
|
|
2430
2430
|
/**
|
|
2431
|
-
* @public
|
|
2432
2431
|
* <p>The components of the resource path.</p>
|
|
2432
|
+
* @public
|
|
2433
2433
|
*/
|
|
2434
2434
|
Components?: ResourcePathComponent[];
|
|
2435
2435
|
}
|
|
@@ -2438,8 +2438,8 @@ export interface ResourcePath {
|
|
|
2438
2438
|
*/
|
|
2439
2439
|
export interface GetDocumentPathResponse {
|
|
2440
2440
|
/**
|
|
2441
|
-
* @public
|
|
2442
2441
|
* <p>The path information.</p>
|
|
2442
|
+
* @public
|
|
2443
2443
|
*/
|
|
2444
2444
|
Path?: ResourcePath;
|
|
2445
2445
|
}
|
|
@@ -2448,29 +2448,29 @@ export interface GetDocumentPathResponse {
|
|
|
2448
2448
|
*/
|
|
2449
2449
|
export interface GetDocumentVersionRequest {
|
|
2450
2450
|
/**
|
|
2451
|
-
* @public
|
|
2452
2451
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2452
|
+
* @public
|
|
2453
2453
|
*/
|
|
2454
2454
|
AuthenticationToken?: string;
|
|
2455
2455
|
/**
|
|
2456
|
-
* @public
|
|
2457
2456
|
* <p>The ID of the document.</p>
|
|
2457
|
+
* @public
|
|
2458
2458
|
*/
|
|
2459
2459
|
DocumentId: string | undefined;
|
|
2460
2460
|
/**
|
|
2461
|
-
* @public
|
|
2462
2461
|
* <p>The version ID of the document.</p>
|
|
2462
|
+
* @public
|
|
2463
2463
|
*/
|
|
2464
2464
|
VersionId: string | undefined;
|
|
2465
2465
|
/**
|
|
2466
|
-
* @public
|
|
2467
2466
|
* <p>A comma-separated list of values. Specify "SOURCE" to include a URL for the source
|
|
2468
2467
|
* document.</p>
|
|
2468
|
+
* @public
|
|
2469
2469
|
*/
|
|
2470
2470
|
Fields?: string;
|
|
2471
2471
|
/**
|
|
2472
|
-
* @public
|
|
2473
2472
|
* <p>Set this to TRUE to include custom metadata in the response.</p>
|
|
2473
|
+
* @public
|
|
2474
2474
|
*/
|
|
2475
2475
|
IncludeCustomMetadata?: boolean;
|
|
2476
2476
|
}
|
|
@@ -2479,13 +2479,13 @@ export interface GetDocumentVersionRequest {
|
|
|
2479
2479
|
*/
|
|
2480
2480
|
export interface GetDocumentVersionResponse {
|
|
2481
2481
|
/**
|
|
2482
|
-
* @public
|
|
2483
2482
|
* <p>The version metadata.</p>
|
|
2483
|
+
* @public
|
|
2484
2484
|
*/
|
|
2485
2485
|
Metadata?: DocumentVersionMetadata;
|
|
2486
2486
|
/**
|
|
2487
|
-
* @public
|
|
2488
2487
|
* <p>The custom metadata on the document version.</p>
|
|
2488
|
+
* @public
|
|
2489
2489
|
*/
|
|
2490
2490
|
CustomMetadata?: Record<string, string>;
|
|
2491
2491
|
}
|
|
@@ -2494,18 +2494,18 @@ export interface GetDocumentVersionResponse {
|
|
|
2494
2494
|
*/
|
|
2495
2495
|
export interface GetFolderRequest {
|
|
2496
2496
|
/**
|
|
2497
|
-
* @public
|
|
2498
2497
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2498
|
+
* @public
|
|
2499
2499
|
*/
|
|
2500
2500
|
AuthenticationToken?: string;
|
|
2501
2501
|
/**
|
|
2502
|
-
* @public
|
|
2503
2502
|
* <p>The ID of the folder.</p>
|
|
2503
|
+
* @public
|
|
2504
2504
|
*/
|
|
2505
2505
|
FolderId: string | undefined;
|
|
2506
2506
|
/**
|
|
2507
|
-
* @public
|
|
2508
2507
|
* <p>Set to TRUE to include custom metadata in the response.</p>
|
|
2508
|
+
* @public
|
|
2509
2509
|
*/
|
|
2510
2510
|
IncludeCustomMetadata?: boolean;
|
|
2511
2511
|
}
|
|
@@ -2514,13 +2514,13 @@ export interface GetFolderRequest {
|
|
|
2514
2514
|
*/
|
|
2515
2515
|
export interface GetFolderResponse {
|
|
2516
2516
|
/**
|
|
2517
|
-
* @public
|
|
2518
2517
|
* <p>The metadata of the folder.</p>
|
|
2518
|
+
* @public
|
|
2519
2519
|
*/
|
|
2520
2520
|
Metadata?: FolderMetadata;
|
|
2521
2521
|
/**
|
|
2522
|
-
* @public
|
|
2523
2522
|
* <p>The custom metadata on the folder.</p>
|
|
2523
|
+
* @public
|
|
2524
2524
|
*/
|
|
2525
2525
|
CustomMetadata?: Record<string, string>;
|
|
2526
2526
|
}
|
|
@@ -2529,29 +2529,29 @@ export interface GetFolderResponse {
|
|
|
2529
2529
|
*/
|
|
2530
2530
|
export interface GetFolderPathRequest {
|
|
2531
2531
|
/**
|
|
2532
|
-
* @public
|
|
2533
2532
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2533
|
+
* @public
|
|
2534
2534
|
*/
|
|
2535
2535
|
AuthenticationToken?: string;
|
|
2536
2536
|
/**
|
|
2537
|
-
* @public
|
|
2538
2537
|
* <p>The ID of the folder.</p>
|
|
2538
|
+
* @public
|
|
2539
2539
|
*/
|
|
2540
2540
|
FolderId: string | undefined;
|
|
2541
2541
|
/**
|
|
2542
|
-
* @public
|
|
2543
2542
|
* <p>The maximum number of levels in the hierarchy to return.</p>
|
|
2543
|
+
* @public
|
|
2544
2544
|
*/
|
|
2545
2545
|
Limit?: number;
|
|
2546
2546
|
/**
|
|
2547
|
-
* @public
|
|
2548
2547
|
* <p>A comma-separated list of values. Specify "NAME" to include the names of the parent
|
|
2549
2548
|
* folders.</p>
|
|
2549
|
+
* @public
|
|
2550
2550
|
*/
|
|
2551
2551
|
Fields?: string;
|
|
2552
2552
|
/**
|
|
2553
|
-
* @public
|
|
2554
2553
|
* <p>This value is not supported.</p>
|
|
2554
|
+
* @public
|
|
2555
2555
|
*/
|
|
2556
2556
|
Marker?: string;
|
|
2557
2557
|
}
|
|
@@ -2560,8 +2560,8 @@ export interface GetFolderPathRequest {
|
|
|
2560
2560
|
*/
|
|
2561
2561
|
export interface GetFolderPathResponse {
|
|
2562
2562
|
/**
|
|
2563
|
-
* @public
|
|
2564
2563
|
* <p>The path information.</p>
|
|
2564
|
+
* @public
|
|
2565
2565
|
*/
|
|
2566
2566
|
Path?: ResourcePath;
|
|
2567
2567
|
}
|
|
@@ -2581,29 +2581,29 @@ export type ResourceCollectionType = (typeof ResourceCollectionType)[keyof typeo
|
|
|
2581
2581
|
*/
|
|
2582
2582
|
export interface GetResourcesRequest {
|
|
2583
2583
|
/**
|
|
2584
|
-
* @public
|
|
2585
2584
|
* <p>The Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2585
|
+
* @public
|
|
2586
2586
|
*/
|
|
2587
2587
|
AuthenticationToken?: string;
|
|
2588
2588
|
/**
|
|
2589
|
-
* @public
|
|
2590
2589
|
* <p>The user ID for the resource collection. This is a required field for accessing the
|
|
2591
2590
|
* API operation using IAM credentials.</p>
|
|
2591
|
+
* @public
|
|
2592
2592
|
*/
|
|
2593
2593
|
UserId?: string;
|
|
2594
2594
|
/**
|
|
2595
|
-
* @public
|
|
2596
2595
|
* <p>The collection type.</p>
|
|
2596
|
+
* @public
|
|
2597
2597
|
*/
|
|
2598
2598
|
CollectionType?: ResourceCollectionType;
|
|
2599
2599
|
/**
|
|
2600
|
-
* @public
|
|
2601
2600
|
* <p>The maximum number of resources to return.</p>
|
|
2601
|
+
* @public
|
|
2602
2602
|
*/
|
|
2603
2603
|
Limit?: number;
|
|
2604
2604
|
/**
|
|
2605
|
-
* @public
|
|
2606
2605
|
* <p>The marker for the next set of results. This marker was received from a previous call.</p>
|
|
2606
|
+
* @public
|
|
2607
2607
|
*/
|
|
2608
2608
|
Marker?: string;
|
|
2609
2609
|
}
|
|
@@ -2612,25 +2612,25 @@ export interface GetResourcesRequest {
|
|
|
2612
2612
|
*/
|
|
2613
2613
|
export interface GetResourcesResponse {
|
|
2614
2614
|
/**
|
|
2615
|
-
* @public
|
|
2616
2615
|
* <p>The folders in the specified folder.</p>
|
|
2616
|
+
* @public
|
|
2617
2617
|
*/
|
|
2618
2618
|
Folders?: FolderMetadata[];
|
|
2619
2619
|
/**
|
|
2620
|
-
* @public
|
|
2621
2620
|
* <p>The documents in the specified collection.</p>
|
|
2621
|
+
* @public
|
|
2622
2622
|
*/
|
|
2623
2623
|
Documents?: DocumentMetadata[];
|
|
2624
2624
|
/**
|
|
2625
|
-
* @public
|
|
2626
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
|
+
* @public
|
|
2627
2627
|
*/
|
|
2628
2628
|
Marker?: string;
|
|
2629
2629
|
}
|
|
2630
2630
|
/**
|
|
2631
|
-
* @public
|
|
2632
2631
|
* <p>This exception is thrown when a valid checkout ID is not presented on document
|
|
2633
2632
|
* version upload calls for a document that has been checked out from Web client.</p>
|
|
2633
|
+
* @public
|
|
2634
2634
|
*/
|
|
2635
2635
|
export declare class DraftUploadOutOfSyncException extends __BaseException {
|
|
2636
2636
|
readonly name: "DraftUploadOutOfSyncException";
|
|
@@ -2646,59 +2646,59 @@ export declare class DraftUploadOutOfSyncException extends __BaseException {
|
|
|
2646
2646
|
*/
|
|
2647
2647
|
export interface InitiateDocumentVersionUploadRequest {
|
|
2648
2648
|
/**
|
|
2649
|
-
* @public
|
|
2650
2649
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2650
|
+
* @public
|
|
2651
2651
|
*/
|
|
2652
2652
|
AuthenticationToken?: string;
|
|
2653
2653
|
/**
|
|
2654
|
-
* @public
|
|
2655
2654
|
* <p>The ID of the document.</p>
|
|
2655
|
+
* @public
|
|
2656
2656
|
*/
|
|
2657
2657
|
Id?: string;
|
|
2658
2658
|
/**
|
|
2659
|
-
* @public
|
|
2660
2659
|
* <p>The name of the document.</p>
|
|
2660
|
+
* @public
|
|
2661
2661
|
*/
|
|
2662
2662
|
Name?: string;
|
|
2663
2663
|
/**
|
|
2664
|
-
* @public
|
|
2665
2664
|
* <p>The timestamp when the content of the document was originally created.</p>
|
|
2665
|
+
* @public
|
|
2666
2666
|
*/
|
|
2667
2667
|
ContentCreatedTimestamp?: Date;
|
|
2668
2668
|
/**
|
|
2669
|
-
* @public
|
|
2670
2669
|
* <p>The timestamp when the content of the document was modified.</p>
|
|
2670
|
+
* @public
|
|
2671
2671
|
*/
|
|
2672
2672
|
ContentModifiedTimestamp?: Date;
|
|
2673
2673
|
/**
|
|
2674
|
-
* @public
|
|
2675
2674
|
* <p>The content type of the document.</p>
|
|
2675
|
+
* @public
|
|
2676
2676
|
*/
|
|
2677
2677
|
ContentType?: string;
|
|
2678
2678
|
/**
|
|
2679
|
-
* @public
|
|
2680
2679
|
* <p>The size of the document, in bytes.</p>
|
|
2680
|
+
* @public
|
|
2681
2681
|
*/
|
|
2682
2682
|
DocumentSizeInBytes?: number;
|
|
2683
2683
|
/**
|
|
2684
|
-
* @public
|
|
2685
2684
|
* <p>The ID of the parent folder.</p>
|
|
2685
|
+
* @public
|
|
2686
2686
|
*/
|
|
2687
2687
|
ParentFolderId?: string;
|
|
2688
2688
|
}
|
|
2689
2689
|
/**
|
|
2690
|
-
* @public
|
|
2691
2690
|
* <p>Describes the upload.</p>
|
|
2691
|
+
* @public
|
|
2692
2692
|
*/
|
|
2693
2693
|
export interface UploadMetadata {
|
|
2694
2694
|
/**
|
|
2695
|
-
* @public
|
|
2696
2695
|
* <p>The URL of the upload.</p>
|
|
2696
|
+
* @public
|
|
2697
2697
|
*/
|
|
2698
2698
|
UploadUrl?: string;
|
|
2699
2699
|
/**
|
|
2700
|
-
* @public
|
|
2701
2700
|
* <p>The signed headers.</p>
|
|
2701
|
+
* @public
|
|
2702
2702
|
*/
|
|
2703
2703
|
SignedHeaders?: Record<string, string>;
|
|
2704
2704
|
}
|
|
@@ -2707,19 +2707,19 @@ export interface UploadMetadata {
|
|
|
2707
2707
|
*/
|
|
2708
2708
|
export interface InitiateDocumentVersionUploadResponse {
|
|
2709
2709
|
/**
|
|
2710
|
-
* @public
|
|
2711
2710
|
* <p>The document metadata.</p>
|
|
2711
|
+
* @public
|
|
2712
2712
|
*/
|
|
2713
2713
|
Metadata?: DocumentMetadata;
|
|
2714
2714
|
/**
|
|
2715
|
-
* @public
|
|
2716
2715
|
* <p>The upload metadata.</p>
|
|
2716
|
+
* @public
|
|
2717
2717
|
*/
|
|
2718
2718
|
UploadMetadata?: UploadMetadata;
|
|
2719
2719
|
}
|
|
2720
2720
|
/**
|
|
2721
|
-
* @public
|
|
2722
2721
|
* <p>The resource is already checked out.</p>
|
|
2722
|
+
* @public
|
|
2723
2723
|
*/
|
|
2724
2724
|
export declare class ResourceAlreadyCheckedOutException extends __BaseException {
|
|
2725
2725
|
readonly name: "ResourceAlreadyCheckedOutException";
|
|
@@ -2731,8 +2731,8 @@ export declare class ResourceAlreadyCheckedOutException extends __BaseException
|
|
|
2731
2731
|
constructor(opts: __ExceptionOptionType<ResourceAlreadyCheckedOutException, __BaseException>);
|
|
2732
2732
|
}
|
|
2733
2733
|
/**
|
|
2734
|
-
* @public
|
|
2735
2734
|
* <p>The storage limit has been exceeded.</p>
|
|
2735
|
+
* @public
|
|
2736
2736
|
*/
|
|
2737
2737
|
export declare class StorageLimitExceededException extends __BaseException {
|
|
2738
2738
|
readonly name: "StorageLimitExceededException";
|
|
@@ -2744,8 +2744,8 @@ export declare class StorageLimitExceededException extends __BaseException {
|
|
|
2744
2744
|
constructor(opts: __ExceptionOptionType<StorageLimitExceededException, __BaseException>);
|
|
2745
2745
|
}
|
|
2746
2746
|
/**
|
|
2747
|
-
* @public
|
|
2748
2747
|
* <p>The storage limit will be exceeded.</p>
|
|
2748
|
+
* @public
|
|
2749
2749
|
*/
|
|
2750
2750
|
export declare class StorageLimitWillExceedException extends __BaseException {
|
|
2751
2751
|
readonly name: "StorageLimitWillExceedException";
|
|
@@ -2761,13 +2761,13 @@ export declare class StorageLimitWillExceedException extends __BaseException {
|
|
|
2761
2761
|
*/
|
|
2762
2762
|
export interface RemoveAllResourcePermissionsRequest {
|
|
2763
2763
|
/**
|
|
2764
|
-
* @public
|
|
2765
2764
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2765
|
+
* @public
|
|
2766
2766
|
*/
|
|
2767
2767
|
AuthenticationToken?: string;
|
|
2768
2768
|
/**
|
|
2769
|
-
* @public
|
|
2770
2769
|
* <p>The ID of the resource.</p>
|
|
2770
|
+
* @public
|
|
2771
2771
|
*/
|
|
2772
2772
|
ResourceId: string | undefined;
|
|
2773
2773
|
}
|
|
@@ -2776,23 +2776,23 @@ export interface RemoveAllResourcePermissionsRequest {
|
|
|
2776
2776
|
*/
|
|
2777
2777
|
export interface RemoveResourcePermissionRequest {
|
|
2778
2778
|
/**
|
|
2779
|
-
* @public
|
|
2780
2779
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2780
|
+
* @public
|
|
2781
2781
|
*/
|
|
2782
2782
|
AuthenticationToken?: string;
|
|
2783
2783
|
/**
|
|
2784
|
-
* @public
|
|
2785
2784
|
* <p>The ID of the resource.</p>
|
|
2785
|
+
* @public
|
|
2786
2786
|
*/
|
|
2787
2787
|
ResourceId: string | undefined;
|
|
2788
2788
|
/**
|
|
2789
|
-
* @public
|
|
2790
2789
|
* <p>The principal ID of the resource.</p>
|
|
2790
|
+
* @public
|
|
2791
2791
|
*/
|
|
2792
2792
|
PrincipalId: string | undefined;
|
|
2793
2793
|
/**
|
|
2794
|
-
* @public
|
|
2795
2794
|
* <p>The principal type of the resource.</p>
|
|
2795
|
+
* @public
|
|
2796
2796
|
*/
|
|
2797
2797
|
PrincipalType?: PrincipalType;
|
|
2798
2798
|
}
|
|
@@ -2801,13 +2801,13 @@ export interface RemoveResourcePermissionRequest {
|
|
|
2801
2801
|
*/
|
|
2802
2802
|
export interface RestoreDocumentVersionsRequest {
|
|
2803
2803
|
/**
|
|
2804
|
-
* @public
|
|
2805
2804
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
2805
|
+
* @public
|
|
2806
2806
|
*/
|
|
2807
2807
|
AuthenticationToken?: string;
|
|
2808
2808
|
/**
|
|
2809
|
-
* @public
|
|
2810
2809
|
* <p>The ID of the document.</p>
|
|
2810
|
+
* @public
|
|
2811
2811
|
*/
|
|
2812
2812
|
DocumentId: string | undefined;
|
|
2813
2813
|
}
|
|
@@ -2831,18 +2831,18 @@ export declare const ContentCategoryType: {
|
|
|
2831
2831
|
*/
|
|
2832
2832
|
export type ContentCategoryType = (typeof ContentCategoryType)[keyof typeof ContentCategoryType];
|
|
2833
2833
|
/**
|
|
2834
|
-
* @public
|
|
2835
2834
|
* <p>Filters results based on timestamp range (in epochs).</p>
|
|
2835
|
+
* @public
|
|
2836
2836
|
*/
|
|
2837
2837
|
export interface DateRangeType {
|
|
2838
2838
|
/**
|
|
2839
|
-
* @public
|
|
2840
2839
|
* <p>Timestamp range start value (in epochs)</p>
|
|
2840
|
+
* @public
|
|
2841
2841
|
*/
|
|
2842
2842
|
StartValue?: Date;
|
|
2843
2843
|
/**
|
|
2844
|
-
* @public
|
|
2845
2844
|
* <p>Timestamp range end value (in epochs).</p>
|
|
2845
|
+
* @public
|
|
2846
2846
|
*/
|
|
2847
2847
|
EndValue?: Date;
|
|
2848
2848
|
}
|
|
@@ -2861,18 +2861,18 @@ export declare const PrincipalRoleType: {
|
|
|
2861
2861
|
*/
|
|
2862
2862
|
export type PrincipalRoleType = (typeof PrincipalRoleType)[keyof typeof PrincipalRoleType];
|
|
2863
2863
|
/**
|
|
2864
|
-
* @public
|
|
2865
2864
|
* <p>Filter based on UserIds or GroupIds.</p>
|
|
2865
|
+
* @public
|
|
2866
2866
|
*/
|
|
2867
2867
|
export interface SearchPrincipalType {
|
|
2868
2868
|
/**
|
|
2869
|
-
* @public
|
|
2870
2869
|
* <p>UserIds or GroupIds.</p>
|
|
2870
|
+
* @public
|
|
2871
2871
|
*/
|
|
2872
2872
|
Id: string | undefined;
|
|
2873
2873
|
/**
|
|
2874
|
-
* @public
|
|
2875
2874
|
* <p>The Role of a User or Group.</p>
|
|
2875
|
+
* @public
|
|
2876
2876
|
*/
|
|
2877
2877
|
Roles?: PrincipalRoleType[];
|
|
2878
2878
|
}
|
|
@@ -2903,18 +2903,18 @@ export declare const SearchCollectionType: {
|
|
|
2903
2903
|
*/
|
|
2904
2904
|
export type SearchCollectionType = (typeof SearchCollectionType)[keyof typeof SearchCollectionType];
|
|
2905
2905
|
/**
|
|
2906
|
-
* @public
|
|
2907
2906
|
* <p>Filter based on size (in bytes).</p>
|
|
2907
|
+
* @public
|
|
2908
2908
|
*/
|
|
2909
2909
|
export interface LongRangeType {
|
|
2910
2910
|
/**
|
|
2911
|
-
* @public
|
|
2912
2911
|
* <p>The size start range (in bytes).</p>
|
|
2912
|
+
* @public
|
|
2913
2913
|
*/
|
|
2914
2914
|
StartValue?: number;
|
|
2915
2915
|
/**
|
|
2916
|
-
* @public
|
|
2917
2916
|
* <p>The size end range (in bytes).</p>
|
|
2917
|
+
* @public
|
|
2918
2918
|
*/
|
|
2919
2919
|
EndValue?: number;
|
|
2920
2920
|
}
|
|
@@ -2960,58 +2960,58 @@ export declare const LanguageCodeType: {
|
|
|
2960
2960
|
*/
|
|
2961
2961
|
export type LanguageCodeType = (typeof LanguageCodeType)[keyof typeof LanguageCodeType];
|
|
2962
2962
|
/**
|
|
2963
|
-
* @public
|
|
2964
2963
|
* <p>Filters results based on entity metadata.</p>
|
|
2964
|
+
* @public
|
|
2965
2965
|
*/
|
|
2966
2966
|
export interface Filters {
|
|
2967
2967
|
/**
|
|
2968
|
-
* @public
|
|
2969
2968
|
* <p>Filters by the locale of the content or comment.</p>
|
|
2969
|
+
* @public
|
|
2970
2970
|
*/
|
|
2971
2971
|
TextLocales?: LanguageCodeType[];
|
|
2972
2972
|
/**
|
|
2973
|
-
* @public
|
|
2974
2973
|
* <p>Filters by content category.</p>
|
|
2974
|
+
* @public
|
|
2975
2975
|
*/
|
|
2976
2976
|
ContentCategories?: ContentCategoryType[];
|
|
2977
2977
|
/**
|
|
2978
|
-
* @public
|
|
2979
2978
|
* <p>Filters based on entity type.</p>
|
|
2979
|
+
* @public
|
|
2980
2980
|
*/
|
|
2981
2981
|
ResourceTypes?: SearchResourceType[];
|
|
2982
2982
|
/**
|
|
2983
|
-
* @public
|
|
2984
2983
|
* <p>Filter by labels using exact match.</p>
|
|
2984
|
+
* @public
|
|
2985
2985
|
*/
|
|
2986
2986
|
Labels?: string[];
|
|
2987
2987
|
/**
|
|
2988
|
-
* @public
|
|
2989
2988
|
* <p>Filter based on UserIds or GroupIds.</p>
|
|
2989
|
+
* @public
|
|
2990
2990
|
*/
|
|
2991
2991
|
Principals?: SearchPrincipalType[];
|
|
2992
2992
|
/**
|
|
2993
|
-
* @public
|
|
2994
2993
|
* <p>Filter based on resource’s path.</p>
|
|
2994
|
+
* @public
|
|
2995
2995
|
*/
|
|
2996
2996
|
AncestorIds?: string[];
|
|
2997
2997
|
/**
|
|
2998
|
-
* @public
|
|
2999
2998
|
* <p>Filter based on file groupings.</p>
|
|
2999
|
+
* @public
|
|
3000
3000
|
*/
|
|
3001
3001
|
SearchCollectionTypes?: SearchCollectionType[];
|
|
3002
3002
|
/**
|
|
3003
|
-
* @public
|
|
3004
3003
|
* <p>Filter based on size (in bytes).</p>
|
|
3004
|
+
* @public
|
|
3005
3005
|
*/
|
|
3006
3006
|
SizeRange?: LongRangeType;
|
|
3007
3007
|
/**
|
|
3008
|
-
* @public
|
|
3009
3008
|
* <p>Filter based on resource’s creation timestamp.</p>
|
|
3009
|
+
* @public
|
|
3010
3010
|
*/
|
|
3011
3011
|
CreatedRange?: DateRangeType;
|
|
3012
3012
|
/**
|
|
3013
|
-
* @public
|
|
3014
3013
|
* <p>Filter based on resource’s modified timestamp.</p>
|
|
3014
|
+
* @public
|
|
3015
3015
|
*/
|
|
3016
3016
|
ModifiedRange?: DateRangeType;
|
|
3017
3017
|
}
|
|
@@ -3043,18 +3043,18 @@ export declare const SortOrder: {
|
|
|
3043
3043
|
*/
|
|
3044
3044
|
export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
3045
3045
|
/**
|
|
3046
|
-
* @public
|
|
3047
3046
|
* <p>The result of the sort operation.</p>
|
|
3047
|
+
* @public
|
|
3048
3048
|
*/
|
|
3049
3049
|
export interface SearchSortResult {
|
|
3050
3050
|
/**
|
|
3051
|
-
* @public
|
|
3052
3051
|
* <p>Sort search results based on this field name.</p>
|
|
3052
|
+
* @public
|
|
3053
3053
|
*/
|
|
3054
3054
|
Field?: OrderByFieldType;
|
|
3055
3055
|
/**
|
|
3056
|
-
* @public
|
|
3057
3056
|
* <p>Sort direction.</p>
|
|
3057
|
+
* @public
|
|
3058
3058
|
*/
|
|
3059
3059
|
Order?: SortOrder;
|
|
3060
3060
|
}
|
|
@@ -3075,49 +3075,49 @@ export type SearchQueryScopeType = (typeof SearchQueryScopeType)[keyof typeof Se
|
|
|
3075
3075
|
*/
|
|
3076
3076
|
export interface SearchResourcesRequest {
|
|
3077
3077
|
/**
|
|
3078
|
-
* @public
|
|
3079
3078
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
3079
|
+
* @public
|
|
3080
3080
|
*/
|
|
3081
3081
|
AuthenticationToken?: string;
|
|
3082
3082
|
/**
|
|
3083
|
-
* @public
|
|
3084
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
|
+
* @public
|
|
3085
3085
|
*/
|
|
3086
3086
|
QueryText?: string;
|
|
3087
3087
|
/**
|
|
3088
|
-
* @public
|
|
3089
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
|
+
* @public
|
|
3090
3090
|
*/
|
|
3091
3091
|
QueryScopes?: SearchQueryScopeType[];
|
|
3092
3092
|
/**
|
|
3093
|
-
* @public
|
|
3094
3093
|
* <p>Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.</p>
|
|
3094
|
+
* @public
|
|
3095
3095
|
*/
|
|
3096
3096
|
OrganizationId?: string;
|
|
3097
3097
|
/**
|
|
3098
|
-
* @public
|
|
3099
3098
|
* <p>A list of attributes to include in the response. Used to request fields that are not normally
|
|
3100
3099
|
* returned in a standard response.</p>
|
|
3100
|
+
* @public
|
|
3101
3101
|
*/
|
|
3102
3102
|
AdditionalResponseFields?: AdditionalResponseFieldType[];
|
|
3103
3103
|
/**
|
|
3104
|
-
* @public
|
|
3105
3104
|
* <p>Filters results based on entity metadata.</p>
|
|
3105
|
+
* @public
|
|
3106
3106
|
*/
|
|
3107
3107
|
Filters?: Filters;
|
|
3108
3108
|
/**
|
|
3109
|
-
* @public
|
|
3110
3109
|
* <p>Order by results in one or more categories.</p>
|
|
3110
|
+
* @public
|
|
3111
3111
|
*/
|
|
3112
3112
|
OrderBy?: SearchSortResult[];
|
|
3113
3113
|
/**
|
|
3114
|
-
* @public
|
|
3115
3114
|
* <p>Max results count per page.</p>
|
|
3115
|
+
* @public
|
|
3116
3116
|
*/
|
|
3117
3117
|
Limit?: number;
|
|
3118
3118
|
/**
|
|
3119
|
-
* @public
|
|
3120
3119
|
* <p>The marker for the next set of results.</p>
|
|
3120
|
+
* @public
|
|
3121
3121
|
*/
|
|
3122
3122
|
Marker?: string;
|
|
3123
3123
|
}
|
|
@@ -3136,38 +3136,38 @@ export declare const ResponseItemType: {
|
|
|
3136
3136
|
*/
|
|
3137
3137
|
export type ResponseItemType = (typeof ResponseItemType)[keyof typeof ResponseItemType];
|
|
3138
3138
|
/**
|
|
3139
|
-
* @public
|
|
3140
3139
|
* <p>List of Documents, Folders, Comments, and Document Versions matching the query.</p>
|
|
3140
|
+
* @public
|
|
3141
3141
|
*/
|
|
3142
3142
|
export interface ResponseItem {
|
|
3143
3143
|
/**
|
|
3144
|
-
* @public
|
|
3145
3144
|
* <p>The type of item being returned.</p>
|
|
3145
|
+
* @public
|
|
3146
3146
|
*/
|
|
3147
3147
|
ResourceType?: ResponseItemType;
|
|
3148
3148
|
/**
|
|
3149
|
-
* @public
|
|
3150
3149
|
* <p>The webUrl of the item being returned.</p>
|
|
3150
|
+
* @public
|
|
3151
3151
|
*/
|
|
3152
3152
|
WebUrl?: string;
|
|
3153
3153
|
/**
|
|
3154
|
-
* @public
|
|
3155
3154
|
* <p>The document that matches the query.</p>
|
|
3155
|
+
* @public
|
|
3156
3156
|
*/
|
|
3157
3157
|
DocumentMetadata?: DocumentMetadata;
|
|
3158
3158
|
/**
|
|
3159
|
-
* @public
|
|
3160
3159
|
* <p>The folder that matches the query.</p>
|
|
3160
|
+
* @public
|
|
3161
3161
|
*/
|
|
3162
3162
|
FolderMetadata?: FolderMetadata;
|
|
3163
3163
|
/**
|
|
3164
|
-
* @public
|
|
3165
3164
|
* <p>The comment that matches the query.</p>
|
|
3165
|
+
* @public
|
|
3166
3166
|
*/
|
|
3167
3167
|
CommentMetadata?: CommentMetadata;
|
|
3168
3168
|
/**
|
|
3169
|
-
* @public
|
|
3170
3169
|
* <p>The document version that matches the metadata.</p>
|
|
3170
|
+
* @public
|
|
3171
3171
|
*/
|
|
3172
3172
|
DocumentVersionMetadata?: DocumentVersionMetadata;
|
|
3173
3173
|
}
|
|
@@ -3176,13 +3176,13 @@ export interface ResponseItem {
|
|
|
3176
3176
|
*/
|
|
3177
3177
|
export interface SearchResourcesResponse {
|
|
3178
3178
|
/**
|
|
3179
|
-
* @public
|
|
3180
3179
|
* <p>List of Documents, Folders, Comments, and Document Versions matching the query.</p>
|
|
3180
|
+
* @public
|
|
3181
3181
|
*/
|
|
3182
3182
|
Items?: ResponseItem[];
|
|
3183
3183
|
/**
|
|
3184
|
-
* @public
|
|
3185
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
|
+
* @public
|
|
3186
3186
|
*/
|
|
3187
3187
|
Marker?: string;
|
|
3188
3188
|
}
|
|
@@ -3191,29 +3191,29 @@ export interface SearchResourcesResponse {
|
|
|
3191
3191
|
*/
|
|
3192
3192
|
export interface UpdateDocumentRequest {
|
|
3193
3193
|
/**
|
|
3194
|
-
* @public
|
|
3195
3194
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
3195
|
+
* @public
|
|
3196
3196
|
*/
|
|
3197
3197
|
AuthenticationToken?: string;
|
|
3198
3198
|
/**
|
|
3199
|
-
* @public
|
|
3200
3199
|
* <p>The ID of the document.</p>
|
|
3200
|
+
* @public
|
|
3201
3201
|
*/
|
|
3202
3202
|
DocumentId: string | undefined;
|
|
3203
3203
|
/**
|
|
3204
|
-
* @public
|
|
3205
3204
|
* <p>The name of the document.</p>
|
|
3205
|
+
* @public
|
|
3206
3206
|
*/
|
|
3207
3207
|
Name?: string;
|
|
3208
3208
|
/**
|
|
3209
|
-
* @public
|
|
3210
3209
|
* <p>The ID of the parent folder.</p>
|
|
3210
|
+
* @public
|
|
3211
3211
|
*/
|
|
3212
3212
|
ParentFolderId?: string;
|
|
3213
3213
|
/**
|
|
3214
|
-
* @public
|
|
3215
3214
|
* <p>The resource state of the document. Only ACTIVE and RECYCLED are
|
|
3216
3215
|
* supported.</p>
|
|
3216
|
+
* @public
|
|
3217
3217
|
*/
|
|
3218
3218
|
ResourceState?: ResourceStateType;
|
|
3219
3219
|
}
|
|
@@ -3233,23 +3233,23 @@ export type DocumentVersionStatus = (typeof DocumentVersionStatus)[keyof typeof
|
|
|
3233
3233
|
*/
|
|
3234
3234
|
export interface UpdateDocumentVersionRequest {
|
|
3235
3235
|
/**
|
|
3236
|
-
* @public
|
|
3237
3236
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
3237
|
+
* @public
|
|
3238
3238
|
*/
|
|
3239
3239
|
AuthenticationToken?: string;
|
|
3240
3240
|
/**
|
|
3241
|
-
* @public
|
|
3242
3241
|
* <p>The ID of the document.</p>
|
|
3242
|
+
* @public
|
|
3243
3243
|
*/
|
|
3244
3244
|
DocumentId: string | undefined;
|
|
3245
3245
|
/**
|
|
3246
|
-
* @public
|
|
3247
3246
|
* <p>The version ID of the document.</p>
|
|
3247
|
+
* @public
|
|
3248
3248
|
*/
|
|
3249
3249
|
VersionId: string | undefined;
|
|
3250
3250
|
/**
|
|
3251
|
-
* @public
|
|
3252
3251
|
* <p>The status of the version.</p>
|
|
3252
|
+
* @public
|
|
3253
3253
|
*/
|
|
3254
3254
|
VersionStatus?: DocumentVersionStatus;
|
|
3255
3255
|
}
|
|
@@ -3258,35 +3258,35 @@ export interface UpdateDocumentVersionRequest {
|
|
|
3258
3258
|
*/
|
|
3259
3259
|
export interface UpdateFolderRequest {
|
|
3260
3260
|
/**
|
|
3261
|
-
* @public
|
|
3262
3261
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
3262
|
+
* @public
|
|
3263
3263
|
*/
|
|
3264
3264
|
AuthenticationToken?: string;
|
|
3265
3265
|
/**
|
|
3266
|
-
* @public
|
|
3267
3266
|
* <p>The ID of the folder.</p>
|
|
3267
|
+
* @public
|
|
3268
3268
|
*/
|
|
3269
3269
|
FolderId: string | undefined;
|
|
3270
3270
|
/**
|
|
3271
|
-
* @public
|
|
3272
3271
|
* <p>The name of the folder.</p>
|
|
3272
|
+
* @public
|
|
3273
3273
|
*/
|
|
3274
3274
|
Name?: string;
|
|
3275
3275
|
/**
|
|
3276
|
-
* @public
|
|
3277
3276
|
* <p>The ID of the parent folder.</p>
|
|
3277
|
+
* @public
|
|
3278
3278
|
*/
|
|
3279
3279
|
ParentFolderId?: string;
|
|
3280
3280
|
/**
|
|
3281
|
-
* @public
|
|
3282
3281
|
* <p>The resource state of the folder. Only ACTIVE and RECYCLED are accepted values from
|
|
3283
3282
|
* the API.</p>
|
|
3283
|
+
* @public
|
|
3284
3284
|
*/
|
|
3285
3285
|
ResourceState?: ResourceStateType;
|
|
3286
3286
|
}
|
|
3287
3287
|
/**
|
|
3288
|
-
* @public
|
|
3289
3288
|
* <p>The last user in the organization is being deactivated.</p>
|
|
3289
|
+
* @public
|
|
3290
3290
|
*/
|
|
3291
3291
|
export declare class DeactivatingLastSystemUserException extends __BaseException {
|
|
3292
3292
|
readonly name: "DeactivatingLastSystemUserException";
|
|
@@ -3299,8 +3299,8 @@ export declare class DeactivatingLastSystemUserException extends __BaseException
|
|
|
3299
3299
|
constructor(opts: __ExceptionOptionType<DeactivatingLastSystemUserException, __BaseException>);
|
|
3300
3300
|
}
|
|
3301
3301
|
/**
|
|
3302
|
-
* @public
|
|
3303
3302
|
* <p>The user is undergoing transfer of ownership.</p>
|
|
3303
|
+
* @public
|
|
3304
3304
|
*/
|
|
3305
3305
|
export declare class IllegalUserStateException extends __BaseException {
|
|
3306
3306
|
readonly name: "IllegalUserStateException";
|
|
@@ -3328,48 +3328,48 @@ export type BooleanEnumType = (typeof BooleanEnumType)[keyof typeof BooleanEnumT
|
|
|
3328
3328
|
*/
|
|
3329
3329
|
export interface UpdateUserRequest {
|
|
3330
3330
|
/**
|
|
3331
|
-
* @public
|
|
3332
3331
|
* <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
|
|
3332
|
+
* @public
|
|
3333
3333
|
*/
|
|
3334
3334
|
AuthenticationToken?: string;
|
|
3335
3335
|
/**
|
|
3336
|
-
* @public
|
|
3337
3336
|
* <p>The ID of the user.</p>
|
|
3337
|
+
* @public
|
|
3338
3338
|
*/
|
|
3339
3339
|
UserId: string | undefined;
|
|
3340
3340
|
/**
|
|
3341
|
-
* @public
|
|
3342
3341
|
* <p>The given name of the user.</p>
|
|
3342
|
+
* @public
|
|
3343
3343
|
*/
|
|
3344
3344
|
GivenName?: string;
|
|
3345
3345
|
/**
|
|
3346
|
-
* @public
|
|
3347
3346
|
* <p>The surname of the user.</p>
|
|
3347
|
+
* @public
|
|
3348
3348
|
*/
|
|
3349
3349
|
Surname?: string;
|
|
3350
3350
|
/**
|
|
3351
|
-
* @public
|
|
3352
3351
|
* <p>The type of the user.</p>
|
|
3352
|
+
* @public
|
|
3353
3353
|
*/
|
|
3354
3354
|
Type?: UserType;
|
|
3355
3355
|
/**
|
|
3356
|
-
* @public
|
|
3357
3356
|
* <p>The amount of storage for the user.</p>
|
|
3357
|
+
* @public
|
|
3358
3358
|
*/
|
|
3359
3359
|
StorageRule?: StorageRuleType;
|
|
3360
3360
|
/**
|
|
3361
|
-
* @public
|
|
3362
3361
|
* <p>The time zone ID of the user.</p>
|
|
3362
|
+
* @public
|
|
3363
3363
|
*/
|
|
3364
3364
|
TimeZoneId?: string;
|
|
3365
3365
|
/**
|
|
3366
|
-
* @public
|
|
3367
3366
|
* <p>The locale of the user.</p>
|
|
3367
|
+
* @public
|
|
3368
3368
|
*/
|
|
3369
3369
|
Locale?: LocaleType;
|
|
3370
3370
|
/**
|
|
3371
|
-
* @public
|
|
3372
3371
|
* <p>Boolean value to determine whether the user is granted Power user privileges.</p>
|
|
3372
|
+
* @public
|
|
3373
3373
|
*/
|
|
3374
3374
|
GrantPoweruserPrivileges?: BooleanEnumType;
|
|
3375
3375
|
}
|
|
@@ -3378,8 +3378,8 @@ export interface UpdateUserRequest {
|
|
|
3378
3378
|
*/
|
|
3379
3379
|
export interface UpdateUserResponse {
|
|
3380
3380
|
/**
|
|
3381
|
-
* @public
|
|
3382
3381
|
* <p>The user information.</p>
|
|
3382
|
+
* @public
|
|
3383
3383
|
*/
|
|
3384
3384
|
User?: User;
|
|
3385
3385
|
}
|