@aws-sdk/client-workdocs 3.325.0 → 3.327.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/commands/AbortDocumentVersionUploadCommand.d.ts +4 -0
- package/dist-types/commands/ActivateUserCommand.d.ts +28 -0
- package/dist-types/commands/AddResourcePermissionsCommand.d.ts +15 -0
- package/dist-types/commands/CreateCommentCommand.d.ts +38 -0
- package/dist-types/commands/CreateCustomMetadataCommand.d.ts +4 -0
- package/dist-types/commands/CreateFolderCommand.d.ts +20 -0
- package/dist-types/commands/CreateLabelsCommand.d.ts +4 -0
- package/dist-types/commands/CreateNotificationSubscriptionCommand.d.ts +10 -0
- package/dist-types/commands/CreateUserCommand.d.ts +28 -0
- package/dist-types/commands/DeactivateUserCommand.d.ts +4 -0
- package/dist-types/commands/DeleteCommentCommand.d.ts +4 -0
- package/dist-types/commands/DeleteCustomMetadataCommand.d.ts +4 -0
- package/dist-types/commands/DeleteDocumentCommand.d.ts +4 -0
- package/dist-types/commands/DeleteDocumentVersionCommand.d.ts +4 -0
- package/dist-types/commands/DeleteFolderCommand.d.ts +4 -0
- package/dist-types/commands/DeleteFolderContentsCommand.d.ts +4 -0
- package/dist-types/commands/DeleteLabelsCommand.d.ts +4 -0
- package/dist-types/commands/DeleteNotificationSubscriptionCommand.d.ts +4 -0
- package/dist-types/commands/DeleteUserCommand.d.ts +4 -0
- package/dist-types/commands/DescribeActivitiesCommand.d.ts +86 -0
- package/dist-types/commands/DescribeCommentsCommand.d.ts +41 -0
- package/dist-types/commands/DescribeDocumentVersionsCommand.d.ts +27 -0
- package/dist-types/commands/DescribeFolderContentsCommand.d.ts +55 -0
- package/dist-types/commands/DescribeGroupsCommand.d.ts +12 -0
- package/dist-types/commands/DescribeNotificationSubscriptionsCommand.d.ts +13 -0
- package/dist-types/commands/DescribeResourcePermissionsCommand.d.ts +18 -0
- package/dist-types/commands/DescribeRootFoldersCommand.d.ts +23 -0
- package/dist-types/commands/DescribeUsersCommand.d.ts +32 -0
- package/dist-types/commands/GetCurrentUserCommand.d.ts +28 -0
- package/dist-types/commands/GetDocumentCommand.d.ts +38 -0
- package/dist-types/commands/GetDocumentPathCommand.d.ts +13 -0
- package/dist-types/commands/GetDocumentVersionCommand.d.ts +27 -0
- package/dist-types/commands/GetFolderCommand.d.ts +23 -0
- package/dist-types/commands/GetFolderPathCommand.d.ts +13 -0
- package/dist-types/commands/GetResourcesCommand.d.ts +55 -0
- package/dist-types/commands/InitiateDocumentVersionUploadCommand.d.ts +41 -0
- package/dist-types/commands/RemoveAllResourcePermissionsCommand.d.ts +4 -0
- package/dist-types/commands/RemoveResourcePermissionCommand.d.ts +4 -0
- package/dist-types/commands/RestoreDocumentVersionsCommand.d.ts +4 -0
- package/dist-types/commands/SearchResourcesCommand.d.ts +106 -0
- package/dist-types/commands/UpdateDocumentCommand.d.ts +4 -0
- package/dist-types/commands/UpdateDocumentVersionCommand.d.ts +4 -0
- package/dist-types/commands/UpdateFolderCommand.d.ts +4 -0
- package/dist-types/commands/UpdateUserCommand.d.ts +28 -0
- package/package.json +7 -7
|
@@ -36,6 +36,8 @@ export interface AbortDocumentVersionUploadCommandOutput extends __MetadataBeare
|
|
|
36
36
|
* };
|
|
37
37
|
* const command = new AbortDocumentVersionUploadCommand(input);
|
|
38
38
|
* const response = await client.send(command);
|
|
39
|
+
* // {};
|
|
40
|
+
*
|
|
39
41
|
* ```
|
|
40
42
|
*
|
|
41
43
|
* @param AbortDocumentVersionUploadCommandInput - {@link AbortDocumentVersionUploadCommandInput}
|
|
@@ -67,6 +69,8 @@ export interface AbortDocumentVersionUploadCommandOutput extends __MetadataBeare
|
|
|
67
69
|
* @throws {@link UnauthorizedResourceAccessException} (client fault)
|
|
68
70
|
* <p>The caller does not have access to perform the action on the resource.</p>
|
|
69
71
|
*
|
|
72
|
+
* @throws {@link WorkDocsServiceException}
|
|
73
|
+
* <p>Base exception class for all service exceptions from WorkDocs service.</p>
|
|
70
74
|
*
|
|
71
75
|
*/
|
|
72
76
|
export declare class AbortDocumentVersionUploadCommand extends $Command<AbortDocumentVersionUploadCommandInput, AbortDocumentVersionUploadCommandOutput, WorkDocsClientResolvedConfig> {
|
|
@@ -33,6 +33,32 @@ export interface ActivateUserCommandOutput extends ActivateUserResponse, __Metad
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new ActivateUserCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // { // ActivateUserResponse
|
|
37
|
+
* // User: { // User
|
|
38
|
+
* // Id: "STRING_VALUE",
|
|
39
|
+
* // Username: "STRING_VALUE",
|
|
40
|
+
* // EmailAddress: "STRING_VALUE",
|
|
41
|
+
* // GivenName: "STRING_VALUE",
|
|
42
|
+
* // Surname: "STRING_VALUE",
|
|
43
|
+
* // OrganizationId: "STRING_VALUE",
|
|
44
|
+
* // RootFolderId: "STRING_VALUE",
|
|
45
|
+
* // RecycleBinFolderId: "STRING_VALUE",
|
|
46
|
+
* // Status: "ACTIVE" || "INACTIVE" || "PENDING",
|
|
47
|
+
* // Type: "USER" || "ADMIN" || "POWERUSER" || "MINIMALUSER" || "WORKSPACESUSER",
|
|
48
|
+
* // CreatedTimestamp: new Date("TIMESTAMP"),
|
|
49
|
+
* // ModifiedTimestamp: new Date("TIMESTAMP"),
|
|
50
|
+
* // TimeZoneId: "STRING_VALUE",
|
|
51
|
+
* // Locale: "en" || "fr" || "ko" || "de" || "es" || "ja" || "ru" || "zh_CN" || "zh_TW" || "pt_BR" || "default",
|
|
52
|
+
* // Storage: { // UserStorageMetadata
|
|
53
|
+
* // StorageUtilizedInBytes: Number("long"),
|
|
54
|
+
* // StorageRule: { // StorageRuleType
|
|
55
|
+
* // StorageAllocatedInBytes: Number("long"),
|
|
56
|
+
* // StorageType: "UNLIMITED" || "QUOTA",
|
|
57
|
+
* // },
|
|
58
|
+
* // },
|
|
59
|
+
* // },
|
|
60
|
+
* // };
|
|
61
|
+
*
|
|
36
62
|
* ```
|
|
37
63
|
*
|
|
38
64
|
* @param ActivateUserCommandInput - {@link ActivateUserCommandInput}
|
|
@@ -58,6 +84,8 @@ export interface ActivateUserCommandOutput extends ActivateUserResponse, __Metad
|
|
|
58
84
|
* @throws {@link UnauthorizedResourceAccessException} (client fault)
|
|
59
85
|
* <p>The caller does not have access to perform the action on the resource.</p>
|
|
60
86
|
*
|
|
87
|
+
* @throws {@link WorkDocsServiceException}
|
|
88
|
+
* <p>Base exception class for all service exceptions from WorkDocs service.</p>
|
|
61
89
|
*
|
|
62
90
|
*/
|
|
63
91
|
export declare class ActivateUserCommand extends $Command<ActivateUserCommandInput, ActivateUserCommandOutput, WorkDocsClientResolvedConfig> {
|
|
@@ -45,6 +45,19 @@ export interface AddResourcePermissionsCommandOutput extends AddResourcePermissi
|
|
|
45
45
|
* };
|
|
46
46
|
* const command = new AddResourcePermissionsCommand(input);
|
|
47
47
|
* const response = await client.send(command);
|
|
48
|
+
* // { // AddResourcePermissionsResponse
|
|
49
|
+
* // ShareResults: [ // ShareResultsList
|
|
50
|
+
* // { // ShareResult
|
|
51
|
+
* // PrincipalId: "STRING_VALUE",
|
|
52
|
+
* // InviteePrincipalId: "STRING_VALUE",
|
|
53
|
+
* // Role: "VIEWER" || "CONTRIBUTOR" || "OWNER" || "COOWNER",
|
|
54
|
+
* // Status: "SUCCESS" || "FAILURE",
|
|
55
|
+
* // ShareId: "STRING_VALUE",
|
|
56
|
+
* // StatusMessage: "STRING_VALUE",
|
|
57
|
+
* // },
|
|
58
|
+
* // ],
|
|
59
|
+
* // };
|
|
60
|
+
*
|
|
48
61
|
* ```
|
|
49
62
|
*
|
|
50
63
|
* @param AddResourcePermissionsCommandInput - {@link AddResourcePermissionsCommandInput}
|
|
@@ -70,6 +83,8 @@ export interface AddResourcePermissionsCommandOutput extends AddResourcePermissi
|
|
|
70
83
|
* @throws {@link UnauthorizedResourceAccessException} (client fault)
|
|
71
84
|
* <p>The caller does not have access to perform the action on the resource.</p>
|
|
72
85
|
*
|
|
86
|
+
* @throws {@link WorkDocsServiceException}
|
|
87
|
+
* <p>Base exception class for all service exceptions from WorkDocs service.</p>
|
|
73
88
|
*
|
|
74
89
|
*/
|
|
75
90
|
export declare class AddResourcePermissionsCommand extends $Command<AddResourcePermissionsCommandInput, AddResourcePermissionsCommandOutput, WorkDocsClientResolvedConfig> {
|
|
@@ -38,6 +38,42 @@ export interface CreateCommentCommandOutput extends CreateCommentResponse, __Met
|
|
|
38
38
|
* };
|
|
39
39
|
* const command = new CreateCommentCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
|
+
* // { // CreateCommentResponse
|
|
42
|
+
* // Comment: { // Comment
|
|
43
|
+
* // CommentId: "STRING_VALUE", // required
|
|
44
|
+
* // ParentId: "STRING_VALUE",
|
|
45
|
+
* // ThreadId: "STRING_VALUE",
|
|
46
|
+
* // Text: "STRING_VALUE",
|
|
47
|
+
* // Contributor: { // User
|
|
48
|
+
* // Id: "STRING_VALUE",
|
|
49
|
+
* // Username: "STRING_VALUE",
|
|
50
|
+
* // EmailAddress: "STRING_VALUE",
|
|
51
|
+
* // GivenName: "STRING_VALUE",
|
|
52
|
+
* // Surname: "STRING_VALUE",
|
|
53
|
+
* // OrganizationId: "STRING_VALUE",
|
|
54
|
+
* // RootFolderId: "STRING_VALUE",
|
|
55
|
+
* // RecycleBinFolderId: "STRING_VALUE",
|
|
56
|
+
* // Status: "ACTIVE" || "INACTIVE" || "PENDING",
|
|
57
|
+
* // Type: "USER" || "ADMIN" || "POWERUSER" || "MINIMALUSER" || "WORKSPACESUSER",
|
|
58
|
+
* // CreatedTimestamp: new Date("TIMESTAMP"),
|
|
59
|
+
* // ModifiedTimestamp: new Date("TIMESTAMP"),
|
|
60
|
+
* // TimeZoneId: "STRING_VALUE",
|
|
61
|
+
* // Locale: "en" || "fr" || "ko" || "de" || "es" || "ja" || "ru" || "zh_CN" || "zh_TW" || "pt_BR" || "default",
|
|
62
|
+
* // Storage: { // UserStorageMetadata
|
|
63
|
+
* // StorageUtilizedInBytes: Number("long"),
|
|
64
|
+
* // StorageRule: { // StorageRuleType
|
|
65
|
+
* // StorageAllocatedInBytes: Number("long"),
|
|
66
|
+
* // StorageType: "UNLIMITED" || "QUOTA",
|
|
67
|
+
* // },
|
|
68
|
+
* // },
|
|
69
|
+
* // },
|
|
70
|
+
* // CreatedTimestamp: new Date("TIMESTAMP"),
|
|
71
|
+
* // Status: "DRAFT" || "PUBLISHED" || "DELETED",
|
|
72
|
+
* // Visibility: "PUBLIC" || "PRIVATE",
|
|
73
|
+
* // RecipientId: "STRING_VALUE",
|
|
74
|
+
* // },
|
|
75
|
+
* // };
|
|
76
|
+
*
|
|
41
77
|
* ```
|
|
42
78
|
*
|
|
43
79
|
* @param CreateCommentCommandInput - {@link CreateCommentCommandInput}
|
|
@@ -73,6 +109,8 @@ export interface CreateCommentCommandOutput extends CreateCommentResponse, __Met
|
|
|
73
109
|
* @throws {@link UnauthorizedResourceAccessException} (client fault)
|
|
74
110
|
* <p>The caller does not have access to perform the action on the resource.</p>
|
|
75
111
|
*
|
|
112
|
+
* @throws {@link WorkDocsServiceException}
|
|
113
|
+
* <p>Base exception class for all service exceptions from WorkDocs service.</p>
|
|
76
114
|
*
|
|
77
115
|
*/
|
|
78
116
|
export declare class CreateCommentCommand extends $Command<CreateCommentCommandInput, CreateCommentCommandOutput, WorkDocsClientResolvedConfig> {
|
|
@@ -37,6 +37,8 @@ export interface CreateCustomMetadataCommandOutput extends CreateCustomMetadataR
|
|
|
37
37
|
* };
|
|
38
38
|
* const command = new CreateCustomMetadataCommand(input);
|
|
39
39
|
* const response = await client.send(command);
|
|
40
|
+
* // {};
|
|
41
|
+
*
|
|
40
42
|
* ```
|
|
41
43
|
*
|
|
42
44
|
* @param CreateCustomMetadataCommandInput - {@link CreateCustomMetadataCommandInput}
|
|
@@ -69,6 +71,8 @@ export interface CreateCustomMetadataCommandOutput extends CreateCustomMetadataR
|
|
|
69
71
|
* @throws {@link UnauthorizedResourceAccessException} (client fault)
|
|
70
72
|
* <p>The caller does not have access to perform the action on the resource.</p>
|
|
71
73
|
*
|
|
74
|
+
* @throws {@link WorkDocsServiceException}
|
|
75
|
+
* <p>Base exception class for all service exceptions from WorkDocs service.</p>
|
|
72
76
|
*
|
|
73
77
|
*/
|
|
74
78
|
export declare class CreateCustomMetadataCommand extends $Command<CreateCustomMetadataCommandInput, CreateCustomMetadataCommandOutput, WorkDocsClientResolvedConfig> {
|
|
@@ -33,6 +33,24 @@ export interface CreateFolderCommandOutput extends CreateFolderResponse, __Metad
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new CreateFolderCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // { // CreateFolderResponse
|
|
37
|
+
* // Metadata: { // FolderMetadata
|
|
38
|
+
* // Id: "STRING_VALUE",
|
|
39
|
+
* // Name: "STRING_VALUE",
|
|
40
|
+
* // CreatorId: "STRING_VALUE",
|
|
41
|
+
* // ParentFolderId: "STRING_VALUE",
|
|
42
|
+
* // CreatedTimestamp: new Date("TIMESTAMP"),
|
|
43
|
+
* // ModifiedTimestamp: new Date("TIMESTAMP"),
|
|
44
|
+
* // ResourceState: "ACTIVE" || "RESTORING" || "RECYCLING" || "RECYCLED",
|
|
45
|
+
* // Signature: "STRING_VALUE",
|
|
46
|
+
* // Labels: [ // SharedLabels
|
|
47
|
+
* // "STRING_VALUE",
|
|
48
|
+
* // ],
|
|
49
|
+
* // Size: Number("long"),
|
|
50
|
+
* // LatestVersionSize: Number("long"),
|
|
51
|
+
* // },
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
36
54
|
* ```
|
|
37
55
|
*
|
|
38
56
|
* @param CreateFolderCommandInput - {@link CreateFolderCommandInput}
|
|
@@ -73,6 +91,8 @@ export interface CreateFolderCommandOutput extends CreateFolderResponse, __Metad
|
|
|
73
91
|
* @throws {@link UnauthorizedResourceAccessException} (client fault)
|
|
74
92
|
* <p>The caller does not have access to perform the action on the resource.</p>
|
|
75
93
|
*
|
|
94
|
+
* @throws {@link WorkDocsServiceException}
|
|
95
|
+
* <p>Base exception class for all service exceptions from WorkDocs service.</p>
|
|
76
96
|
*
|
|
77
97
|
*/
|
|
78
98
|
export declare class CreateFolderCommand extends $Command<CreateFolderCommandInput, CreateFolderCommandOutput, WorkDocsClientResolvedConfig> {
|
|
@@ -36,6 +36,8 @@ export interface CreateLabelsCommandOutput extends CreateLabelsResponse, __Metad
|
|
|
36
36
|
* };
|
|
37
37
|
* const command = new CreateLabelsCommand(input);
|
|
38
38
|
* const response = await client.send(command);
|
|
39
|
+
* // {};
|
|
40
|
+
*
|
|
39
41
|
* ```
|
|
40
42
|
*
|
|
41
43
|
* @param CreateLabelsCommandInput - {@link CreateLabelsCommandInput}
|
|
@@ -65,6 +67,8 @@ export interface CreateLabelsCommandOutput extends CreateLabelsResponse, __Metad
|
|
|
65
67
|
* @throws {@link UnauthorizedResourceAccessException} (client fault)
|
|
66
68
|
* <p>The caller does not have access to perform the action on the resource.</p>
|
|
67
69
|
*
|
|
70
|
+
* @throws {@link WorkDocsServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from WorkDocs service.</p>
|
|
68
72
|
*
|
|
69
73
|
*/
|
|
70
74
|
export declare class CreateLabelsCommand extends $Command<CreateLabelsCommandInput, CreateLabelsCommandOutput, WorkDocsClientResolvedConfig> {
|
|
@@ -37,6 +37,14 @@ export interface CreateNotificationSubscriptionCommandOutput extends CreateNotif
|
|
|
37
37
|
* };
|
|
38
38
|
* const command = new CreateNotificationSubscriptionCommand(input);
|
|
39
39
|
* const response = await client.send(command);
|
|
40
|
+
* // { // CreateNotificationSubscriptionResponse
|
|
41
|
+
* // Subscription: { // Subscription
|
|
42
|
+
* // SubscriptionId: "STRING_VALUE",
|
|
43
|
+
* // EndPoint: "STRING_VALUE",
|
|
44
|
+
* // Protocol: "HTTPS" || "SQS",
|
|
45
|
+
* // },
|
|
46
|
+
* // };
|
|
47
|
+
*
|
|
40
48
|
* ```
|
|
41
49
|
*
|
|
42
50
|
* @param CreateNotificationSubscriptionCommandInput - {@link CreateNotificationSubscriptionCommandInput}
|
|
@@ -58,6 +66,8 @@ export interface CreateNotificationSubscriptionCommandOutput extends CreateNotif
|
|
|
58
66
|
* @throws {@link UnauthorizedResourceAccessException} (client fault)
|
|
59
67
|
* <p>The caller does not have access to perform the action on the resource.</p>
|
|
60
68
|
*
|
|
69
|
+
* @throws {@link WorkDocsServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from WorkDocs service.</p>
|
|
61
71
|
*
|
|
62
72
|
*/
|
|
63
73
|
export declare class CreateNotificationSubscriptionCommand extends $Command<CreateNotificationSubscriptionCommandInput, CreateNotificationSubscriptionCommandOutput, WorkDocsClientResolvedConfig> {
|
|
@@ -43,6 +43,32 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
|
|
|
43
43
|
* };
|
|
44
44
|
* const command = new CreateUserCommand(input);
|
|
45
45
|
* const response = await client.send(command);
|
|
46
|
+
* // { // CreateUserResponse
|
|
47
|
+
* // User: { // User
|
|
48
|
+
* // Id: "STRING_VALUE",
|
|
49
|
+
* // Username: "STRING_VALUE",
|
|
50
|
+
* // EmailAddress: "STRING_VALUE",
|
|
51
|
+
* // GivenName: "STRING_VALUE",
|
|
52
|
+
* // Surname: "STRING_VALUE",
|
|
53
|
+
* // OrganizationId: "STRING_VALUE",
|
|
54
|
+
* // RootFolderId: "STRING_VALUE",
|
|
55
|
+
* // RecycleBinFolderId: "STRING_VALUE",
|
|
56
|
+
* // Status: "ACTIVE" || "INACTIVE" || "PENDING",
|
|
57
|
+
* // Type: "USER" || "ADMIN" || "POWERUSER" || "MINIMALUSER" || "WORKSPACESUSER",
|
|
58
|
+
* // CreatedTimestamp: new Date("TIMESTAMP"),
|
|
59
|
+
* // ModifiedTimestamp: new Date("TIMESTAMP"),
|
|
60
|
+
* // TimeZoneId: "STRING_VALUE",
|
|
61
|
+
* // Locale: "en" || "fr" || "ko" || "de" || "es" || "ja" || "ru" || "zh_CN" || "zh_TW" || "pt_BR" || "default",
|
|
62
|
+
* // Storage: { // UserStorageMetadata
|
|
63
|
+
* // StorageUtilizedInBytes: Number("long"),
|
|
64
|
+
* // StorageRule: { // StorageRuleType
|
|
65
|
+
* // StorageAllocatedInBytes: Number("long"),
|
|
66
|
+
* // StorageType: "UNLIMITED" || "QUOTA",
|
|
67
|
+
* // },
|
|
68
|
+
* // },
|
|
69
|
+
* // },
|
|
70
|
+
* // };
|
|
71
|
+
*
|
|
46
72
|
* ```
|
|
47
73
|
*
|
|
48
74
|
* @param CreateUserCommandInput - {@link CreateUserCommandInput}
|
|
@@ -68,6 +94,8 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
|
|
|
68
94
|
* @throws {@link UnauthorizedResourceAccessException} (client fault)
|
|
69
95
|
* <p>The caller does not have access to perform the action on the resource.</p>
|
|
70
96
|
*
|
|
97
|
+
* @throws {@link WorkDocsServiceException}
|
|
98
|
+
* <p>Base exception class for all service exceptions from WorkDocs service.</p>
|
|
71
99
|
*
|
|
72
100
|
*/
|
|
73
101
|
export declare class CreateUserCommand extends $Command<CreateUserCommandInput, CreateUserCommandOutput, WorkDocsClientResolvedConfig> {
|
|
@@ -33,6 +33,8 @@ export interface DeactivateUserCommandOutput extends __MetadataBearer {
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new DeactivateUserCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // {};
|
|
37
|
+
*
|
|
36
38
|
* ```
|
|
37
39
|
*
|
|
38
40
|
* @param DeactivateUserCommandInput - {@link DeactivateUserCommandInput}
|
|
@@ -58,6 +60,8 @@ export interface DeactivateUserCommandOutput extends __MetadataBearer {
|
|
|
58
60
|
* @throws {@link UnauthorizedResourceAccessException} (client fault)
|
|
59
61
|
* <p>The caller does not have access to perform the action on the resource.</p>
|
|
60
62
|
*
|
|
63
|
+
* @throws {@link WorkDocsServiceException}
|
|
64
|
+
* <p>Base exception class for all service exceptions from WorkDocs service.</p>
|
|
61
65
|
*
|
|
62
66
|
*/
|
|
63
67
|
export declare class DeactivateUserCommand extends $Command<DeactivateUserCommandInput, DeactivateUserCommandOutput, WorkDocsClientResolvedConfig> {
|
|
@@ -34,6 +34,8 @@ export interface DeleteCommentCommandOutput extends __MetadataBearer {
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new DeleteCommentCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // {};
|
|
38
|
+
*
|
|
37
39
|
* ```
|
|
38
40
|
*
|
|
39
41
|
* @param DeleteCommentCommandInput - {@link DeleteCommentCommandInput}
|
|
@@ -66,6 +68,8 @@ export interface DeleteCommentCommandOutput extends __MetadataBearer {
|
|
|
66
68
|
* @throws {@link UnauthorizedResourceAccessException} (client fault)
|
|
67
69
|
* <p>The caller does not have access to perform the action on the resource.</p>
|
|
68
70
|
*
|
|
71
|
+
* @throws {@link WorkDocsServiceException}
|
|
72
|
+
* <p>Base exception class for all service exceptions from WorkDocs service.</p>
|
|
69
73
|
*
|
|
70
74
|
*/
|
|
71
75
|
export declare class DeleteCommentCommand extends $Command<DeleteCommentCommandInput, DeleteCommentCommandOutput, WorkDocsClientResolvedConfig> {
|
|
@@ -37,6 +37,8 @@ export interface DeleteCustomMetadataCommandOutput extends DeleteCustomMetadataR
|
|
|
37
37
|
* };
|
|
38
38
|
* const command = new DeleteCustomMetadataCommand(input);
|
|
39
39
|
* const response = await client.send(command);
|
|
40
|
+
* // {};
|
|
41
|
+
*
|
|
40
42
|
* ```
|
|
41
43
|
*
|
|
42
44
|
* @param DeleteCustomMetadataCommandInput - {@link DeleteCustomMetadataCommandInput}
|
|
@@ -65,6 +67,8 @@ export interface DeleteCustomMetadataCommandOutput extends DeleteCustomMetadataR
|
|
|
65
67
|
* @throws {@link UnauthorizedResourceAccessException} (client fault)
|
|
66
68
|
* <p>The caller does not have access to perform the action on the resource.</p>
|
|
67
69
|
*
|
|
70
|
+
* @throws {@link WorkDocsServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from WorkDocs service.</p>
|
|
68
72
|
*
|
|
69
73
|
*/
|
|
70
74
|
export declare class DeleteCustomMetadataCommand extends $Command<DeleteCustomMetadataCommandInput, DeleteCustomMetadataCommandOutput, WorkDocsClientResolvedConfig> {
|
|
@@ -32,6 +32,8 @@ export interface DeleteDocumentCommandOutput extends __MetadataBearer {
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new DeleteDocumentCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // {};
|
|
36
|
+
*
|
|
35
37
|
* ```
|
|
36
38
|
*
|
|
37
39
|
* @param DeleteDocumentCommandInput - {@link DeleteDocumentCommandInput}
|
|
@@ -69,6 +71,8 @@ export interface DeleteDocumentCommandOutput extends __MetadataBearer {
|
|
|
69
71
|
* @throws {@link UnauthorizedResourceAccessException} (client fault)
|
|
70
72
|
* <p>The caller does not have access to perform the action on the resource.</p>
|
|
71
73
|
*
|
|
74
|
+
* @throws {@link WorkDocsServiceException}
|
|
75
|
+
* <p>Base exception class for all service exceptions from WorkDocs service.</p>
|
|
72
76
|
*
|
|
73
77
|
*/
|
|
74
78
|
export declare class DeleteDocumentCommand extends $Command<DeleteDocumentCommandInput, DeleteDocumentCommandOutput, WorkDocsClientResolvedConfig> {
|
|
@@ -34,6 +34,8 @@ export interface DeleteDocumentVersionCommandOutput extends __MetadataBearer {
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new DeleteDocumentVersionCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // {};
|
|
38
|
+
*
|
|
37
39
|
* ```
|
|
38
40
|
*
|
|
39
41
|
* @param DeleteDocumentVersionCommandInput - {@link DeleteDocumentVersionCommandInput}
|
|
@@ -68,6 +70,8 @@ export interface DeleteDocumentVersionCommandOutput extends __MetadataBearer {
|
|
|
68
70
|
* @throws {@link UnauthorizedResourceAccessException} (client fault)
|
|
69
71
|
* <p>The caller does not have access to perform the action on the resource.</p>
|
|
70
72
|
*
|
|
73
|
+
* @throws {@link WorkDocsServiceException}
|
|
74
|
+
* <p>Base exception class for all service exceptions from WorkDocs service.</p>
|
|
71
75
|
*
|
|
72
76
|
*/
|
|
73
77
|
export declare class DeleteDocumentVersionCommand extends $Command<DeleteDocumentVersionCommandInput, DeleteDocumentVersionCommandOutput, WorkDocsClientResolvedConfig> {
|
|
@@ -32,6 +32,8 @@ export interface DeleteFolderCommandOutput extends __MetadataBearer {
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new DeleteFolderCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // {};
|
|
36
|
+
*
|
|
35
37
|
* ```
|
|
36
38
|
*
|
|
37
39
|
* @param DeleteFolderCommandInput - {@link DeleteFolderCommandInput}
|
|
@@ -69,6 +71,8 @@ export interface DeleteFolderCommandOutput extends __MetadataBearer {
|
|
|
69
71
|
* @throws {@link UnauthorizedResourceAccessException} (client fault)
|
|
70
72
|
* <p>The caller does not have access to perform the action on the resource.</p>
|
|
71
73
|
*
|
|
74
|
+
* @throws {@link WorkDocsServiceException}
|
|
75
|
+
* <p>Base exception class for all service exceptions from WorkDocs service.</p>
|
|
72
76
|
*
|
|
73
77
|
*/
|
|
74
78
|
export declare class DeleteFolderCommand extends $Command<DeleteFolderCommandInput, DeleteFolderCommandOutput, WorkDocsClientResolvedConfig> {
|
|
@@ -32,6 +32,8 @@ export interface DeleteFolderContentsCommandOutput extends __MetadataBearer {
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new DeleteFolderContentsCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // {};
|
|
36
|
+
*
|
|
35
37
|
* ```
|
|
36
38
|
*
|
|
37
39
|
* @param DeleteFolderContentsCommandInput - {@link DeleteFolderContentsCommandInput}
|
|
@@ -63,6 +65,8 @@ export interface DeleteFolderContentsCommandOutput extends __MetadataBearer {
|
|
|
63
65
|
* @throws {@link UnauthorizedResourceAccessException} (client fault)
|
|
64
66
|
* <p>The caller does not have access to perform the action on the resource.</p>
|
|
65
67
|
*
|
|
68
|
+
* @throws {@link WorkDocsServiceException}
|
|
69
|
+
* <p>Base exception class for all service exceptions from WorkDocs service.</p>
|
|
66
70
|
*
|
|
67
71
|
*/
|
|
68
72
|
export declare class DeleteFolderContentsCommand extends $Command<DeleteFolderContentsCommandInput, DeleteFolderContentsCommandOutput, WorkDocsClientResolvedConfig> {
|
|
@@ -36,6 +36,8 @@ export interface DeleteLabelsCommandOutput extends DeleteLabelsResponse, __Metad
|
|
|
36
36
|
* };
|
|
37
37
|
* const command = new DeleteLabelsCommand(input);
|
|
38
38
|
* const response = await client.send(command);
|
|
39
|
+
* // {};
|
|
40
|
+
*
|
|
39
41
|
* ```
|
|
40
42
|
*
|
|
41
43
|
* @param DeleteLabelsCommandInput - {@link DeleteLabelsCommandInput}
|
|
@@ -64,6 +66,8 @@ export interface DeleteLabelsCommandOutput extends DeleteLabelsResponse, __Metad
|
|
|
64
66
|
* @throws {@link UnauthorizedResourceAccessException} (client fault)
|
|
65
67
|
* <p>The caller does not have access to perform the action on the resource.</p>
|
|
66
68
|
*
|
|
69
|
+
* @throws {@link WorkDocsServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from WorkDocs service.</p>
|
|
67
71
|
*
|
|
68
72
|
*/
|
|
69
73
|
export declare class DeleteLabelsCommand extends $Command<DeleteLabelsCommandInput, DeleteLabelsCommandOutput, WorkDocsClientResolvedConfig> {
|
|
@@ -32,6 +32,8 @@ export interface DeleteNotificationSubscriptionCommandOutput extends __MetadataB
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new DeleteNotificationSubscriptionCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // {};
|
|
36
|
+
*
|
|
35
37
|
* ```
|
|
36
38
|
*
|
|
37
39
|
* @param DeleteNotificationSubscriptionCommandInput - {@link DeleteNotificationSubscriptionCommandInput}
|
|
@@ -52,6 +54,8 @@ export interface DeleteNotificationSubscriptionCommandOutput extends __MetadataB
|
|
|
52
54
|
* @throws {@link UnauthorizedResourceAccessException} (client fault)
|
|
53
55
|
* <p>The caller does not have access to perform the action on the resource.</p>
|
|
54
56
|
*
|
|
57
|
+
* @throws {@link WorkDocsServiceException}
|
|
58
|
+
* <p>Base exception class for all service exceptions from WorkDocs service.</p>
|
|
55
59
|
*
|
|
56
60
|
*/
|
|
57
61
|
export declare class DeleteNotificationSubscriptionCommand extends $Command<DeleteNotificationSubscriptionCommandInput, DeleteNotificationSubscriptionCommandOutput, WorkDocsClientResolvedConfig> {
|
|
@@ -35,6 +35,8 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {
|
|
|
35
35
|
* };
|
|
36
36
|
* const command = new DeleteUserCommand(input);
|
|
37
37
|
* const response = await client.send(command);
|
|
38
|
+
* // {};
|
|
39
|
+
*
|
|
38
40
|
* ```
|
|
39
41
|
*
|
|
40
42
|
* @param DeleteUserCommandInput - {@link DeleteUserCommandInput}
|
|
@@ -60,6 +62,8 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {
|
|
|
60
62
|
* @throws {@link UnauthorizedResourceAccessException} (client fault)
|
|
61
63
|
* <p>The caller does not have access to perform the action on the resource.</p>
|
|
62
64
|
*
|
|
65
|
+
* @throws {@link WorkDocsServiceException}
|
|
66
|
+
* <p>Base exception class for all service exceptions from WorkDocs service.</p>
|
|
63
67
|
*
|
|
64
68
|
*/
|
|
65
69
|
export declare class DeleteUserCommand extends $Command<DeleteUserCommandInput, DeleteUserCommandOutput, WorkDocsClientResolvedConfig> {
|
|
@@ -40,6 +40,90 @@ export interface DescribeActivitiesCommandOutput extends DescribeActivitiesRespo
|
|
|
40
40
|
* };
|
|
41
41
|
* const command = new DescribeActivitiesCommand(input);
|
|
42
42
|
* const response = await client.send(command);
|
|
43
|
+
* // { // DescribeActivitiesResponse
|
|
44
|
+
* // UserActivities: [ // UserActivities
|
|
45
|
+
* // { // Activity
|
|
46
|
+
* // Type: "DOCUMENT_CHECKED_IN" || "DOCUMENT_CHECKED_OUT" || "DOCUMENT_RENAMED" || "DOCUMENT_VERSION_UPLOADED" || "DOCUMENT_VERSION_DELETED" || "DOCUMENT_VERSION_VIEWED" || "DOCUMENT_VERSION_DOWNLOADED" || "DOCUMENT_RECYCLED" || "DOCUMENT_RESTORED" || "DOCUMENT_REVERTED" || "DOCUMENT_SHARED" || "DOCUMENT_UNSHARED" || "DOCUMENT_SHARE_PERMISSION_CHANGED" || "DOCUMENT_SHAREABLE_LINK_CREATED" || "DOCUMENT_SHAREABLE_LINK_REMOVED" || "DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED" || "DOCUMENT_MOVED" || "DOCUMENT_COMMENT_ADDED" || "DOCUMENT_COMMENT_DELETED" || "DOCUMENT_ANNOTATION_ADDED" || "DOCUMENT_ANNOTATION_DELETED" || "FOLDER_CREATED" || "FOLDER_DELETED" || "FOLDER_RENAMED" || "FOLDER_RECYCLED" || "FOLDER_RESTORED" || "FOLDER_SHARED" || "FOLDER_UNSHARED" || "FOLDER_SHARE_PERMISSION_CHANGED" || "FOLDER_SHAREABLE_LINK_CREATED" || "FOLDER_SHAREABLE_LINK_REMOVED" || "FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED" || "FOLDER_MOVED",
|
|
47
|
+
* // TimeStamp: new Date("TIMESTAMP"),
|
|
48
|
+
* // IsIndirectActivity: true || false,
|
|
49
|
+
* // OrganizationId: "STRING_VALUE",
|
|
50
|
+
* // Initiator: { // UserMetadata
|
|
51
|
+
* // Id: "STRING_VALUE",
|
|
52
|
+
* // Username: "STRING_VALUE",
|
|
53
|
+
* // GivenName: "STRING_VALUE",
|
|
54
|
+
* // Surname: "STRING_VALUE",
|
|
55
|
+
* // EmailAddress: "STRING_VALUE",
|
|
56
|
+
* // },
|
|
57
|
+
* // Participants: { // Participants
|
|
58
|
+
* // Users: [ // UserMetadataList
|
|
59
|
+
* // {
|
|
60
|
+
* // Id: "STRING_VALUE",
|
|
61
|
+
* // Username: "STRING_VALUE",
|
|
62
|
+
* // GivenName: "STRING_VALUE",
|
|
63
|
+
* // Surname: "STRING_VALUE",
|
|
64
|
+
* // EmailAddress: "STRING_VALUE",
|
|
65
|
+
* // },
|
|
66
|
+
* // ],
|
|
67
|
+
* // Groups: [ // GroupMetadataList
|
|
68
|
+
* // { // GroupMetadata
|
|
69
|
+
* // Id: "STRING_VALUE",
|
|
70
|
+
* // Name: "STRING_VALUE",
|
|
71
|
+
* // },
|
|
72
|
+
* // ],
|
|
73
|
+
* // },
|
|
74
|
+
* // ResourceMetadata: { // ResourceMetadata
|
|
75
|
+
* // Type: "FOLDER" || "DOCUMENT",
|
|
76
|
+
* // Name: "STRING_VALUE",
|
|
77
|
+
* // OriginalName: "STRING_VALUE",
|
|
78
|
+
* // Id: "STRING_VALUE",
|
|
79
|
+
* // VersionId: "STRING_VALUE",
|
|
80
|
+
* // Owner: "<UserMetadata>",
|
|
81
|
+
* // ParentId: "STRING_VALUE",
|
|
82
|
+
* // },
|
|
83
|
+
* // OriginalParent: {
|
|
84
|
+
* // Type: "FOLDER" || "DOCUMENT",
|
|
85
|
+
* // Name: "STRING_VALUE",
|
|
86
|
+
* // OriginalName: "STRING_VALUE",
|
|
87
|
+
* // Id: "STRING_VALUE",
|
|
88
|
+
* // VersionId: "STRING_VALUE",
|
|
89
|
+
* // Owner: "<UserMetadata>",
|
|
90
|
+
* // ParentId: "STRING_VALUE",
|
|
91
|
+
* // },
|
|
92
|
+
* // CommentMetadata: { // CommentMetadata
|
|
93
|
+
* // CommentId: "STRING_VALUE",
|
|
94
|
+
* // Contributor: { // User
|
|
95
|
+
* // Id: "STRING_VALUE",
|
|
96
|
+
* // Username: "STRING_VALUE",
|
|
97
|
+
* // EmailAddress: "STRING_VALUE",
|
|
98
|
+
* // GivenName: "STRING_VALUE",
|
|
99
|
+
* // Surname: "STRING_VALUE",
|
|
100
|
+
* // OrganizationId: "STRING_VALUE",
|
|
101
|
+
* // RootFolderId: "STRING_VALUE",
|
|
102
|
+
* // RecycleBinFolderId: "STRING_VALUE",
|
|
103
|
+
* // Status: "ACTIVE" || "INACTIVE" || "PENDING",
|
|
104
|
+
* // Type: "USER" || "ADMIN" || "POWERUSER" || "MINIMALUSER" || "WORKSPACESUSER",
|
|
105
|
+
* // CreatedTimestamp: new Date("TIMESTAMP"),
|
|
106
|
+
* // ModifiedTimestamp: new Date("TIMESTAMP"),
|
|
107
|
+
* // TimeZoneId: "STRING_VALUE",
|
|
108
|
+
* // Locale: "en" || "fr" || "ko" || "de" || "es" || "ja" || "ru" || "zh_CN" || "zh_TW" || "pt_BR" || "default",
|
|
109
|
+
* // Storage: { // UserStorageMetadata
|
|
110
|
+
* // StorageUtilizedInBytes: Number("long"),
|
|
111
|
+
* // StorageRule: { // StorageRuleType
|
|
112
|
+
* // StorageAllocatedInBytes: Number("long"),
|
|
113
|
+
* // StorageType: "UNLIMITED" || "QUOTA",
|
|
114
|
+
* // },
|
|
115
|
+
* // },
|
|
116
|
+
* // },
|
|
117
|
+
* // CreatedTimestamp: new Date("TIMESTAMP"),
|
|
118
|
+
* // CommentStatus: "DRAFT" || "PUBLISHED" || "DELETED",
|
|
119
|
+
* // RecipientId: "STRING_VALUE",
|
|
120
|
+
* // ContributorId: "STRING_VALUE",
|
|
121
|
+
* // },
|
|
122
|
+
* // },
|
|
123
|
+
* // ],
|
|
124
|
+
* // Marker: "STRING_VALUE",
|
|
125
|
+
* // };
|
|
126
|
+
*
|
|
43
127
|
* ```
|
|
44
128
|
*
|
|
45
129
|
* @param DescribeActivitiesCommandInput - {@link DescribeActivitiesCommandInput}
|
|
@@ -65,6 +149,8 @@ export interface DescribeActivitiesCommandOutput extends DescribeActivitiesRespo
|
|
|
65
149
|
* @throws {@link UnauthorizedResourceAccessException} (client fault)
|
|
66
150
|
* <p>The caller does not have access to perform the action on the resource.</p>
|
|
67
151
|
*
|
|
152
|
+
* @throws {@link WorkDocsServiceException}
|
|
153
|
+
* <p>Base exception class for all service exceptions from WorkDocs service.</p>
|
|
68
154
|
*
|
|
69
155
|
*/
|
|
70
156
|
export declare class DescribeActivitiesCommand extends $Command<DescribeActivitiesCommandInput, DescribeActivitiesCommandOutput, WorkDocsClientResolvedConfig> {
|
|
@@ -35,6 +35,45 @@ export interface DescribeCommentsCommandOutput extends DescribeCommentsResponse,
|
|
|
35
35
|
* };
|
|
36
36
|
* const command = new DescribeCommentsCommand(input);
|
|
37
37
|
* const response = await client.send(command);
|
|
38
|
+
* // { // DescribeCommentsResponse
|
|
39
|
+
* // Comments: [ // CommentList
|
|
40
|
+
* // { // Comment
|
|
41
|
+
* // CommentId: "STRING_VALUE", // required
|
|
42
|
+
* // ParentId: "STRING_VALUE",
|
|
43
|
+
* // ThreadId: "STRING_VALUE",
|
|
44
|
+
* // Text: "STRING_VALUE",
|
|
45
|
+
* // Contributor: { // User
|
|
46
|
+
* // Id: "STRING_VALUE",
|
|
47
|
+
* // Username: "STRING_VALUE",
|
|
48
|
+
* // EmailAddress: "STRING_VALUE",
|
|
49
|
+
* // GivenName: "STRING_VALUE",
|
|
50
|
+
* // Surname: "STRING_VALUE",
|
|
51
|
+
* // OrganizationId: "STRING_VALUE",
|
|
52
|
+
* // RootFolderId: "STRING_VALUE",
|
|
53
|
+
* // RecycleBinFolderId: "STRING_VALUE",
|
|
54
|
+
* // Status: "ACTIVE" || "INACTIVE" || "PENDING",
|
|
55
|
+
* // Type: "USER" || "ADMIN" || "POWERUSER" || "MINIMALUSER" || "WORKSPACESUSER",
|
|
56
|
+
* // CreatedTimestamp: new Date("TIMESTAMP"),
|
|
57
|
+
* // ModifiedTimestamp: new Date("TIMESTAMP"),
|
|
58
|
+
* // TimeZoneId: "STRING_VALUE",
|
|
59
|
+
* // Locale: "en" || "fr" || "ko" || "de" || "es" || "ja" || "ru" || "zh_CN" || "zh_TW" || "pt_BR" || "default",
|
|
60
|
+
* // Storage: { // UserStorageMetadata
|
|
61
|
+
* // StorageUtilizedInBytes: Number("long"),
|
|
62
|
+
* // StorageRule: { // StorageRuleType
|
|
63
|
+
* // StorageAllocatedInBytes: Number("long"),
|
|
64
|
+
* // StorageType: "UNLIMITED" || "QUOTA",
|
|
65
|
+
* // },
|
|
66
|
+
* // },
|
|
67
|
+
* // },
|
|
68
|
+
* // CreatedTimestamp: new Date("TIMESTAMP"),
|
|
69
|
+
* // Status: "DRAFT" || "PUBLISHED" || "DELETED",
|
|
70
|
+
* // Visibility: "PUBLIC" || "PRIVATE",
|
|
71
|
+
* // RecipientId: "STRING_VALUE",
|
|
72
|
+
* // },
|
|
73
|
+
* // ],
|
|
74
|
+
* // Marker: "STRING_VALUE",
|
|
75
|
+
* // };
|
|
76
|
+
*
|
|
38
77
|
* ```
|
|
39
78
|
*
|
|
40
79
|
* @param DescribeCommentsCommandInput - {@link DescribeCommentsCommandInput}
|
|
@@ -63,6 +102,8 @@ export interface DescribeCommentsCommandOutput extends DescribeCommentsResponse,
|
|
|
63
102
|
* @throws {@link UnauthorizedResourceAccessException} (client fault)
|
|
64
103
|
* <p>The caller does not have access to perform the action on the resource.</p>
|
|
65
104
|
*
|
|
105
|
+
* @throws {@link WorkDocsServiceException}
|
|
106
|
+
* <p>Base exception class for all service exceptions from WorkDocs service.</p>
|
|
66
107
|
*
|
|
67
108
|
*/
|
|
68
109
|
export declare class DescribeCommentsCommand extends $Command<DescribeCommentsCommandInput, DescribeCommentsCommandOutput, WorkDocsClientResolvedConfig> {
|