@aws-sdk/client-workdocs 3.321.1 → 3.326.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/dist-types/commands/AbortDocumentVersionUploadCommand.d.ts +4 -0
  2. package/dist-types/commands/ActivateUserCommand.d.ts +28 -0
  3. package/dist-types/commands/AddResourcePermissionsCommand.d.ts +15 -0
  4. package/dist-types/commands/CreateCommentCommand.d.ts +38 -0
  5. package/dist-types/commands/CreateCustomMetadataCommand.d.ts +4 -0
  6. package/dist-types/commands/CreateFolderCommand.d.ts +20 -0
  7. package/dist-types/commands/CreateLabelsCommand.d.ts +4 -0
  8. package/dist-types/commands/CreateNotificationSubscriptionCommand.d.ts +10 -0
  9. package/dist-types/commands/CreateUserCommand.d.ts +28 -0
  10. package/dist-types/commands/DeactivateUserCommand.d.ts +4 -0
  11. package/dist-types/commands/DeleteCommentCommand.d.ts +4 -0
  12. package/dist-types/commands/DeleteCustomMetadataCommand.d.ts +4 -0
  13. package/dist-types/commands/DeleteDocumentCommand.d.ts +4 -0
  14. package/dist-types/commands/DeleteDocumentVersionCommand.d.ts +4 -0
  15. package/dist-types/commands/DeleteFolderCommand.d.ts +4 -0
  16. package/dist-types/commands/DeleteFolderContentsCommand.d.ts +4 -0
  17. package/dist-types/commands/DeleteLabelsCommand.d.ts +4 -0
  18. package/dist-types/commands/DeleteNotificationSubscriptionCommand.d.ts +4 -0
  19. package/dist-types/commands/DeleteUserCommand.d.ts +4 -0
  20. package/dist-types/commands/DescribeActivitiesCommand.d.ts +86 -0
  21. package/dist-types/commands/DescribeCommentsCommand.d.ts +41 -0
  22. package/dist-types/commands/DescribeDocumentVersionsCommand.d.ts +27 -0
  23. package/dist-types/commands/DescribeFolderContentsCommand.d.ts +55 -0
  24. package/dist-types/commands/DescribeGroupsCommand.d.ts +12 -0
  25. package/dist-types/commands/DescribeNotificationSubscriptionsCommand.d.ts +13 -0
  26. package/dist-types/commands/DescribeResourcePermissionsCommand.d.ts +18 -0
  27. package/dist-types/commands/DescribeRootFoldersCommand.d.ts +23 -0
  28. package/dist-types/commands/DescribeUsersCommand.d.ts +32 -0
  29. package/dist-types/commands/GetCurrentUserCommand.d.ts +28 -0
  30. package/dist-types/commands/GetDocumentCommand.d.ts +38 -0
  31. package/dist-types/commands/GetDocumentPathCommand.d.ts +13 -0
  32. package/dist-types/commands/GetDocumentVersionCommand.d.ts +27 -0
  33. package/dist-types/commands/GetFolderCommand.d.ts +23 -0
  34. package/dist-types/commands/GetFolderPathCommand.d.ts +13 -0
  35. package/dist-types/commands/GetResourcesCommand.d.ts +55 -0
  36. package/dist-types/commands/InitiateDocumentVersionUploadCommand.d.ts +41 -0
  37. package/dist-types/commands/RemoveAllResourcePermissionsCommand.d.ts +4 -0
  38. package/dist-types/commands/RemoveResourcePermissionCommand.d.ts +4 -0
  39. package/dist-types/commands/RestoreDocumentVersionsCommand.d.ts +4 -0
  40. package/dist-types/commands/SearchResourcesCommand.d.ts +106 -0
  41. package/dist-types/commands/UpdateDocumentCommand.d.ts +4 -0
  42. package/dist-types/commands/UpdateDocumentVersionCommand.d.ts +4 -0
  43. package/dist-types/commands/UpdateFolderCommand.d.ts +4 -0
  44. package/dist-types/commands/UpdateUserCommand.d.ts +28 -0
  45. package/package.json +16 -16
package/dist-types/commands/DescribeDocumentVersionsCommand.d.ts CHANGED
@@ -37,6 +37,31 @@ export interface DescribeDocumentVersionsCommandOutput extends DescribeDocumentV
37
37
  * };
38
38
  * const command = new DescribeDocumentVersionsCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // DescribeDocumentVersionsResponse
41
+ * // DocumentVersions: [ // DocumentVersionMetadataList
42
+ * // { // DocumentVersionMetadata
43
+ * // Id: "STRING_VALUE",
44
+ * // Name: "STRING_VALUE",
45
+ * // ContentType: "STRING_VALUE",
46
+ * // Size: Number("long"),
47
+ * // Signature: "STRING_VALUE",
48
+ * // Status: "INITIALIZED" || "ACTIVE",
49
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
50
+ * // ModifiedTimestamp: new Date("TIMESTAMP"),
51
+ * // ContentCreatedTimestamp: new Date("TIMESTAMP"),
52
+ * // ContentModifiedTimestamp: new Date("TIMESTAMP"),
53
+ * // CreatorId: "STRING_VALUE",
54
+ * // Thumbnail: { // DocumentThumbnailUrlMap
55
+ * // "<keys>": "STRING_VALUE",
56
+ * // },
57
+ * // Source: { // DocumentSourceUrlMap
58
+ * // "<keys>": "STRING_VALUE",
59
+ * // },
60
+ * // },
61
+ * // ],
62
+ * // Marker: "STRING_VALUE",
63
+ * // };
64
+ *
40
65
  * ```
41
66
  *
42
67
  * @param DescribeDocumentVersionsCommandInput - {@link DescribeDocumentVersionsCommandInput}
@@ -71,6 +96,8 @@ export interface DescribeDocumentVersionsCommandOutput extends DescribeDocumentV
71
96
  * @throws {@link UnauthorizedResourceAccessException} (client fault)
72
97
  * <p>The caller does not have access to perform the action on the resource.</p>
73
98
  *
99
+ * @throws {@link WorkDocsServiceException}
100
+ * <p>Base exception class for all service exceptions from WorkDocs service.</p>
74
101
  *
75
102
  */
76
103
  export declare class DescribeDocumentVersionsCommand extends $Command<DescribeDocumentVersionsCommandInput, DescribeDocumentVersionsCommandOutput, WorkDocsClientResolvedConfig> {
package/dist-types/commands/DescribeFolderContentsCommand.d.ts CHANGED
@@ -43,6 +43,59 @@ export interface DescribeFolderContentsCommandOutput extends DescribeFolderConte
43
43
  * };
44
44
  * const command = new DescribeFolderContentsCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // DescribeFolderContentsResponse
47
+ * // Folders: [ // FolderMetadataList
48
+ * // { // FolderMetadata
49
+ * // Id: "STRING_VALUE",
50
+ * // Name: "STRING_VALUE",
51
+ * // CreatorId: "STRING_VALUE",
52
+ * // ParentFolderId: "STRING_VALUE",
53
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
54
+ * // ModifiedTimestamp: new Date("TIMESTAMP"),
55
+ * // ResourceState: "ACTIVE" || "RESTORING" || "RECYCLING" || "RECYCLED",
56
+ * // Signature: "STRING_VALUE",
57
+ * // Labels: [ // SharedLabels
58
+ * // "STRING_VALUE",
59
+ * // ],
60
+ * // Size: Number("long"),
61
+ * // LatestVersionSize: Number("long"),
62
+ * // },
63
+ * // ],
64
+ * // Documents: [ // DocumentMetadataList
65
+ * // { // DocumentMetadata
66
+ * // Id: "STRING_VALUE",
67
+ * // CreatorId: "STRING_VALUE",
68
+ * // ParentFolderId: "STRING_VALUE",
69
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
70
+ * // ModifiedTimestamp: new Date("TIMESTAMP"),
71
+ * // LatestVersionMetadata: { // DocumentVersionMetadata
72
+ * // Id: "STRING_VALUE",
73
+ * // Name: "STRING_VALUE",
74
+ * // ContentType: "STRING_VALUE",
75
+ * // Size: Number("long"),
76
+ * // Signature: "STRING_VALUE",
77
+ * // Status: "INITIALIZED" || "ACTIVE",
78
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
79
+ * // ModifiedTimestamp: new Date("TIMESTAMP"),
80
+ * // ContentCreatedTimestamp: new Date("TIMESTAMP"),
81
+ * // ContentModifiedTimestamp: new Date("TIMESTAMP"),
82
+ * // CreatorId: "STRING_VALUE",
83
+ * // Thumbnail: { // DocumentThumbnailUrlMap
84
+ * // "<keys>": "STRING_VALUE",
85
+ * // },
86
+ * // Source: { // DocumentSourceUrlMap
87
+ * // "<keys>": "STRING_VALUE",
88
+ * // },
89
+ * // },
90
+ * // ResourceState: "ACTIVE" || "RESTORING" || "RECYCLING" || "RECYCLED",
91
+ * // Labels: [
92
+ * // "STRING_VALUE",
93
+ * // ],
94
+ * // },
95
+ * // ],
96
+ * // Marker: "STRING_VALUE",
97
+ * // };
98
+ *
46
99
  * ```
47
100
  *
48
101
  * @param DescribeFolderContentsCommandInput - {@link DescribeFolderContentsCommandInput}
@@ -71,6 +124,8 @@ export interface DescribeFolderContentsCommandOutput extends DescribeFolderConte
71
124
  * @throws {@link UnauthorizedResourceAccessException} (client fault)
72
125
  * <p>The caller does not have access to perform the action on the resource.</p>
73
126
  *
127
+ * @throws {@link WorkDocsServiceException}
128
+ * <p>Base exception class for all service exceptions from WorkDocs service.</p>
74
129
  *
75
130
  */
76
131
  export declare class DescribeFolderContentsCommand extends $Command<DescribeFolderContentsCommandInput, DescribeFolderContentsCommandOutput, WorkDocsClientResolvedConfig> {
package/dist-types/commands/DescribeGroupsCommand.d.ts CHANGED
@@ -36,6 +36,16 @@ export interface DescribeGroupsCommandOutput extends DescribeGroupsResponse, __M
36
36
  * };
37
37
  * const command = new DescribeGroupsCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // DescribeGroupsResponse
40
+ * // Groups: [ // GroupMetadataList
41
+ * // { // GroupMetadata
42
+ * // Id: "STRING_VALUE",
43
+ * // Name: "STRING_VALUE",
44
+ * // },
45
+ * // ],
46
+ * // Marker: "STRING_VALUE",
47
+ * // };
48
+ *
39
49
  * ```
40
50
  *
41
51
  * @param DescribeGroupsCommandInput - {@link DescribeGroupsCommandInput}
@@ -58,6 +68,8 @@ export interface DescribeGroupsCommandOutput extends DescribeGroupsResponse, __M
58
68
  * @throws {@link UnauthorizedResourceAccessException} (client fault)
59
69
  * <p>The caller does not have access to perform the action on the resource.</p>
60
70
  *
71
+ * @throws {@link WorkDocsServiceException}
72
+ * <p>Base exception class for all service exceptions from WorkDocs service.</p>
61
73
  *
62
74
  */
63
75
  export declare class DescribeGroupsCommand extends $Command<DescribeGroupsCommandInput, DescribeGroupsCommandOutput, WorkDocsClientResolvedConfig> {
package/dist-types/commands/DescribeNotificationSubscriptionsCommand.d.ts CHANGED
@@ -33,6 +33,17 @@ export interface DescribeNotificationSubscriptionsCommandOutput extends Describe
33
33
  * };
34
34
  * const command = new DescribeNotificationSubscriptionsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DescribeNotificationSubscriptionsResponse
37
+ * // Subscriptions: [ // SubscriptionList
38
+ * // { // Subscription
39
+ * // SubscriptionId: "STRING_VALUE",
40
+ * // EndPoint: "STRING_VALUE",
41
+ * // Protocol: "HTTPS" || "SQS",
42
+ * // },
43
+ * // ],
44
+ * // Marker: "STRING_VALUE",
45
+ * // };
46
+ *
36
47
  * ```
37
48
  *
38
49
  * @param DescribeNotificationSubscriptionsCommandInput - {@link DescribeNotificationSubscriptionsCommandInput}
@@ -50,6 +61,8 @@ export interface DescribeNotificationSubscriptionsCommandOutput extends Describe
50
61
  * @throws {@link UnauthorizedResourceAccessException} (client fault)
51
62
  * <p>The caller does not have access to perform the action on the resource.</p>
52
63
  *
64
+ * @throws {@link WorkDocsServiceException}
65
+ * <p>Base exception class for all service exceptions from WorkDocs service.</p>
53
66
  *
54
67
  */
55
68
  export declare class DescribeNotificationSubscriptionsCommand extends $Command<DescribeNotificationSubscriptionsCommandInput, DescribeNotificationSubscriptionsCommandOutput, WorkDocsClientResolvedConfig> {
package/dist-types/commands/DescribeResourcePermissionsCommand.d.ts CHANGED
@@ -35,6 +35,22 @@ export interface DescribeResourcePermissionsCommandOutput extends DescribeResour
35
35
  * };
36
36
  * const command = new DescribeResourcePermissionsCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // DescribeResourcePermissionsResponse
39
+ * // Principals: [ // PrincipalList
40
+ * // { // Principal
41
+ * // Id: "STRING_VALUE",
42
+ * // Type: "USER" || "GROUP" || "INVITE" || "ANONYMOUS" || "ORGANIZATION",
43
+ * // Roles: [ // PermissionInfoList
44
+ * // { // PermissionInfo
45
+ * // Role: "VIEWER" || "CONTRIBUTOR" || "OWNER" || "COOWNER",
46
+ * // Type: "DIRECT" || "INHERITED",
47
+ * // },
48
+ * // ],
49
+ * // },
50
+ * // ],
51
+ * // Marker: "STRING_VALUE",
52
+ * // };
53
+ *
38
54
  * ```
39
55
  *
40
56
  * @param DescribeResourcePermissionsCommandInput - {@link DescribeResourcePermissionsCommandInput}
@@ -60,6 +76,8 @@ export interface DescribeResourcePermissionsCommandOutput extends DescribeResour
60
76
  * @throws {@link UnauthorizedResourceAccessException} (client fault)
61
77
  * <p>The caller does not have access to perform the action on the resource.</p>
62
78
  *
79
+ * @throws {@link WorkDocsServiceException}
80
+ * <p>Base exception class for all service exceptions from WorkDocs service.</p>
63
81
  *
64
82
  */
65
83
  export declare class DescribeResourcePermissionsCommand extends $Command<DescribeResourcePermissionsCommandInput, DescribeResourcePermissionsCommandOutput, WorkDocsClientResolvedConfig> {
package/dist-types/commands/DescribeRootFoldersCommand.d.ts CHANGED
@@ -41,6 +41,27 @@ export interface DescribeRootFoldersCommandOutput extends DescribeRootFoldersRes
41
41
  * };
42
42
  * const command = new DescribeRootFoldersCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // DescribeRootFoldersResponse
45
+ * // Folders: [ // FolderMetadataList
46
+ * // { // FolderMetadata
47
+ * // Id: "STRING_VALUE",
48
+ * // Name: "STRING_VALUE",
49
+ * // CreatorId: "STRING_VALUE",
50
+ * // ParentFolderId: "STRING_VALUE",
51
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
52
+ * // ModifiedTimestamp: new Date("TIMESTAMP"),
53
+ * // ResourceState: "ACTIVE" || "RESTORING" || "RECYCLING" || "RECYCLED",
54
+ * // Signature: "STRING_VALUE",
55
+ * // Labels: [ // SharedLabels
56
+ * // "STRING_VALUE",
57
+ * // ],
58
+ * // Size: Number("long"),
59
+ * // LatestVersionSize: Number("long"),
60
+ * // },
61
+ * // ],
62
+ * // Marker: "STRING_VALUE",
63
+ * // };
64
+ *
44
65
  * ```
45
66
  *
46
67
  * @param DescribeRootFoldersCommandInput - {@link DescribeRootFoldersCommandInput}
@@ -66,6 +87,8 @@ export interface DescribeRootFoldersCommandOutput extends DescribeRootFoldersRes
66
87
  * @throws {@link UnauthorizedResourceAccessException} (client fault)
67
88
  * <p>The caller does not have access to perform the action on the resource.</p>
68
89
  *
90
+ * @throws {@link WorkDocsServiceException}
91
+ * <p>Base exception class for all service exceptions from WorkDocs service.</p>
69
92
  *
70
93
  */
71
94
  export declare class DescribeRootFoldersCommand extends $Command<DescribeRootFoldersCommandInput, DescribeRootFoldersCommandOutput, WorkDocsClientResolvedConfig> {
package/dist-types/commands/DescribeUsersCommand.d.ts CHANGED
@@ -44,6 +44,36 @@ export interface DescribeUsersCommandOutput extends DescribeUsersResponse, __Met
44
44
  * };
45
45
  * const command = new DescribeUsersCommand(input);
46
46
  * const response = await client.send(command);
47
+ * // { // DescribeUsersResponse
48
+ * // Users: [ // OrganizationUserList
49
+ * // { // User
50
+ * // Id: "STRING_VALUE",
51
+ * // Username: "STRING_VALUE",
52
+ * // EmailAddress: "STRING_VALUE",
53
+ * // GivenName: "STRING_VALUE",
54
+ * // Surname: "STRING_VALUE",
55
+ * // OrganizationId: "STRING_VALUE",
56
+ * // RootFolderId: "STRING_VALUE",
57
+ * // RecycleBinFolderId: "STRING_VALUE",
58
+ * // Status: "ACTIVE" || "INACTIVE" || "PENDING",
59
+ * // Type: "USER" || "ADMIN" || "POWERUSER" || "MINIMALUSER" || "WORKSPACESUSER",
60
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
61
+ * // ModifiedTimestamp: new Date("TIMESTAMP"),
62
+ * // TimeZoneId: "STRING_VALUE",
63
+ * // Locale: "en" || "fr" || "ko" || "de" || "es" || "ja" || "ru" || "zh_CN" || "zh_TW" || "pt_BR" || "default",
64
+ * // Storage: { // UserStorageMetadata
65
+ * // StorageUtilizedInBytes: Number("long"),
66
+ * // StorageRule: { // StorageRuleType
67
+ * // StorageAllocatedInBytes: Number("long"),
68
+ * // StorageType: "UNLIMITED" || "QUOTA",
69
+ * // },
70
+ * // },
71
+ * // },
72
+ * // ],
73
+ * // TotalNumberOfUsers: Number("long"),
74
+ * // Marker: "STRING_VALUE",
75
+ * // };
76
+ *
47
77
  * ```
48
78
  *
49
79
  * @param DescribeUsersCommandInput - {@link DescribeUsersCommandInput}
@@ -75,6 +105,8 @@ export interface DescribeUsersCommandOutput extends DescribeUsersResponse, __Met
75
105
  * @throws {@link UnauthorizedResourceAccessException} (client fault)
76
106
  * <p>The caller does not have access to perform the action on the resource.</p>
77
107
  *
108
+ * @throws {@link WorkDocsServiceException}
109
+ * <p>Base exception class for all service exceptions from WorkDocs service.</p>
78
110
  *
79
111
  */
80
112
  export declare class DescribeUsersCommand extends $Command<DescribeUsersCommandInput, DescribeUsersCommandOutput, WorkDocsClientResolvedConfig> {
package/dist-types/commands/GetCurrentUserCommand.d.ts CHANGED
@@ -37,6 +37,32 @@ export interface GetCurrentUserCommandOutput extends GetCurrentUserResponse, __M
37
37
  * };
38
38
  * const command = new GetCurrentUserCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // GetCurrentUserResponse
41
+ * // User: { // User
42
+ * // Id: "STRING_VALUE",
43
+ * // Username: "STRING_VALUE",
44
+ * // EmailAddress: "STRING_VALUE",
45
+ * // GivenName: "STRING_VALUE",
46
+ * // Surname: "STRING_VALUE",
47
+ * // OrganizationId: "STRING_VALUE",
48
+ * // RootFolderId: "STRING_VALUE",
49
+ * // RecycleBinFolderId: "STRING_VALUE",
50
+ * // Status: "ACTIVE" || "INACTIVE" || "PENDING",
51
+ * // Type: "USER" || "ADMIN" || "POWERUSER" || "MINIMALUSER" || "WORKSPACESUSER",
52
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
53
+ * // ModifiedTimestamp: new Date("TIMESTAMP"),
54
+ * // TimeZoneId: "STRING_VALUE",
55
+ * // Locale: "en" || "fr" || "ko" || "de" || "es" || "ja" || "ru" || "zh_CN" || "zh_TW" || "pt_BR" || "default",
56
+ * // Storage: { // UserStorageMetadata
57
+ * // StorageUtilizedInBytes: Number("long"),
58
+ * // StorageRule: { // StorageRuleType
59
+ * // StorageAllocatedInBytes: Number("long"),
60
+ * // StorageType: "UNLIMITED" || "QUOTA",
61
+ * // },
62
+ * // },
63
+ * // },
64
+ * // };
65
+ *
40
66
  * ```
41
67
  *
42
68
  * @param GetCurrentUserCommandInput - {@link GetCurrentUserCommandInput}
@@ -62,6 +88,8 @@ export interface GetCurrentUserCommandOutput extends GetCurrentUserResponse, __M
62
88
  * @throws {@link UnauthorizedResourceAccessException} (client fault)
63
89
  * <p>The caller does not have access to perform the action on the resource.</p>
64
90
  *
91
+ * @throws {@link WorkDocsServiceException}
92
+ * <p>Base exception class for all service exceptions from WorkDocs service.</p>
65
93
  *
66
94
  */
67
95
  export declare class GetCurrentUserCommand extends $Command<GetCurrentUserCommandInput, GetCurrentUserCommandOutput, WorkDocsClientResolvedConfig> {
package/dist-types/commands/GetDocumentCommand.d.ts CHANGED
@@ -33,6 +33,42 @@ export interface GetDocumentCommandOutput extends GetDocumentResponse, __Metadat
33
33
  * };
34
34
  * const command = new GetDocumentCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // GetDocumentResponse
37
+ * // Metadata: { // DocumentMetadata
38
+ * // Id: "STRING_VALUE",
39
+ * // CreatorId: "STRING_VALUE",
40
+ * // ParentFolderId: "STRING_VALUE",
41
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
42
+ * // ModifiedTimestamp: new Date("TIMESTAMP"),
43
+ * // LatestVersionMetadata: { // DocumentVersionMetadata
44
+ * // Id: "STRING_VALUE",
45
+ * // Name: "STRING_VALUE",
46
+ * // ContentType: "STRING_VALUE",
47
+ * // Size: Number("long"),
48
+ * // Signature: "STRING_VALUE",
49
+ * // Status: "INITIALIZED" || "ACTIVE",
50
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
51
+ * // ModifiedTimestamp: new Date("TIMESTAMP"),
52
+ * // ContentCreatedTimestamp: new Date("TIMESTAMP"),
53
+ * // ContentModifiedTimestamp: new Date("TIMESTAMP"),
54
+ * // CreatorId: "STRING_VALUE",
55
+ * // Thumbnail: { // DocumentThumbnailUrlMap
56
+ * // "<keys>": "STRING_VALUE",
57
+ * // },
58
+ * // Source: { // DocumentSourceUrlMap
59
+ * // "<keys>": "STRING_VALUE",
60
+ * // },
61
+ * // },
62
+ * // ResourceState: "ACTIVE" || "RESTORING" || "RECYCLING" || "RECYCLED",
63
+ * // Labels: [ // SharedLabels
64
+ * // "STRING_VALUE",
65
+ * // ],
66
+ * // },
67
+ * // CustomMetadata: { // CustomMetadataMap
68
+ * // "<keys>": "STRING_VALUE",
69
+ * // },
70
+ * // };
71
+ *
36
72
  * ```
37
73
  *
38
74
  * @param GetDocumentCommandInput - {@link GetDocumentCommandInput}
@@ -64,6 +100,8 @@ export interface GetDocumentCommandOutput extends GetDocumentResponse, __Metadat
64
100
  * @throws {@link UnauthorizedResourceAccessException} (client fault)
65
101
  * <p>The caller does not have access to perform the action on the resource.</p>
66
102
  *
103
+ * @throws {@link WorkDocsServiceException}
104
+ * <p>Base exception class for all service exceptions from WorkDocs service.</p>
67
105
  *
68
106
  */
69
107
  export declare class GetDocumentCommand extends $Command<GetDocumentCommandInput, GetDocumentCommandOutput, WorkDocsClientResolvedConfig> {
package/dist-types/commands/GetDocumentPathCommand.d.ts CHANGED
@@ -40,6 +40,17 @@ export interface GetDocumentPathCommandOutput extends GetDocumentPathResponse, _
40
40
  * };
41
41
  * const command = new GetDocumentPathCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // GetDocumentPathResponse
44
+ * // Path: { // ResourcePath
45
+ * // Components: [ // ResourcePathComponentList
46
+ * // { // ResourcePathComponent
47
+ * // Id: "STRING_VALUE",
48
+ * // Name: "STRING_VALUE",
49
+ * // },
50
+ * // ],
51
+ * // },
52
+ * // };
53
+ *
43
54
  * ```
44
55
  *
45
56
  * @param GetDocumentPathCommandInput - {@link GetDocumentPathCommandInput}
@@ -65,6 +76,8 @@ export interface GetDocumentPathCommandOutput extends GetDocumentPathResponse, _
65
76
  * @throws {@link UnauthorizedResourceAccessException} (client fault)
66
77
  * <p>The caller does not have access to perform the action on the resource.</p>
67
78
  *
79
+ * @throws {@link WorkDocsServiceException}
80
+ * <p>Base exception class for all service exceptions from WorkDocs service.</p>
68
81
  *
69
82
  */
70
83
  export declare class GetDocumentPathCommand extends $Command<GetDocumentPathCommandInput, GetDocumentPathCommandOutput, WorkDocsClientResolvedConfig> {
package/dist-types/commands/GetDocumentVersionCommand.d.ts CHANGED
@@ -35,6 +35,31 @@ export interface GetDocumentVersionCommandOutput extends GetDocumentVersionRespo
35
35
  * };
36
36
  * const command = new GetDocumentVersionCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // GetDocumentVersionResponse
39
+ * // Metadata: { // DocumentVersionMetadata
40
+ * // Id: "STRING_VALUE",
41
+ * // Name: "STRING_VALUE",
42
+ * // ContentType: "STRING_VALUE",
43
+ * // Size: Number("long"),
44
+ * // Signature: "STRING_VALUE",
45
+ * // Status: "INITIALIZED" || "ACTIVE",
46
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
47
+ * // ModifiedTimestamp: new Date("TIMESTAMP"),
48
+ * // ContentCreatedTimestamp: new Date("TIMESTAMP"),
49
+ * // ContentModifiedTimestamp: new Date("TIMESTAMP"),
50
+ * // CreatorId: "STRING_VALUE",
51
+ * // Thumbnail: { // DocumentThumbnailUrlMap
52
+ * // "<keys>": "STRING_VALUE",
53
+ * // },
54
+ * // Source: { // DocumentSourceUrlMap
55
+ * // "<keys>": "STRING_VALUE",
56
+ * // },
57
+ * // },
58
+ * // CustomMetadata: { // CustomMetadataMap
59
+ * // "<keys>": "STRING_VALUE",
60
+ * // },
61
+ * // };
62
+ *
38
63
  * ```
39
64
  *
40
65
  * @param GetDocumentVersionCommandInput - {@link GetDocumentVersionCommandInput}
@@ -66,6 +91,8 @@ export interface GetDocumentVersionCommandOutput extends GetDocumentVersionRespo
66
91
  * @throws {@link UnauthorizedResourceAccessException} (client fault)
67
92
  * <p>The caller does not have access to perform the action on the resource.</p>
68
93
  *
94
+ * @throws {@link WorkDocsServiceException}
95
+ * <p>Base exception class for all service exceptions from WorkDocs service.</p>
69
96
  *
70
97
  */
71
98
  export declare class GetDocumentVersionCommand extends $Command<GetDocumentVersionCommandInput, GetDocumentVersionCommandOutput, WorkDocsClientResolvedConfig> {
package/dist-types/commands/GetFolderCommand.d.ts CHANGED
@@ -33,6 +33,27 @@ export interface GetFolderCommandOutput extends GetFolderResponse, __MetadataBea
33
33
  * };
34
34
  * const command = new GetFolderCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // GetFolderResponse
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
+ * // CustomMetadata: { // CustomMetadataMap
53
+ * // "<keys>": "STRING_VALUE",
54
+ * // },
55
+ * // };
56
+ *
36
57
  * ```
37
58
  *
38
59
  * @param GetFolderCommandInput - {@link GetFolderCommandInput}
@@ -64,6 +85,8 @@ export interface GetFolderCommandOutput extends GetFolderResponse, __MetadataBea
64
85
  * @throws {@link UnauthorizedResourceAccessException} (client fault)
65
86
  * <p>The caller does not have access to perform the action on the resource.</p>
66
87
  *
88
+ * @throws {@link WorkDocsServiceException}
89
+ * <p>Base exception class for all service exceptions from WorkDocs service.</p>
67
90
  *
68
91
  */
69
92
  export declare class GetFolderCommand extends $Command<GetFolderCommandInput, GetFolderCommandOutput, WorkDocsClientResolvedConfig> {
package/dist-types/commands/GetFolderPathCommand.d.ts CHANGED
@@ -40,6 +40,17 @@ export interface GetFolderPathCommandOutput extends GetFolderPathResponse, __Met
40
40
  * };
41
41
  * const command = new GetFolderPathCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // GetFolderPathResponse
44
+ * // Path: { // ResourcePath
45
+ * // Components: [ // ResourcePathComponentList
46
+ * // { // ResourcePathComponent
47
+ * // Id: "STRING_VALUE",
48
+ * // Name: "STRING_VALUE",
49
+ * // },
50
+ * // ],
51
+ * // },
52
+ * // };
53
+ *
43
54
  * ```
44
55
  *
45
56
  * @param GetFolderPathCommandInput - {@link GetFolderPathCommandInput}
@@ -65,6 +76,8 @@ export interface GetFolderPathCommandOutput extends GetFolderPathResponse, __Met
65
76
  * @throws {@link UnauthorizedResourceAccessException} (client fault)
66
77
  * <p>The caller does not have access to perform the action on the resource.</p>
67
78
  *
79
+ * @throws {@link WorkDocsServiceException}
80
+ * <p>Base exception class for all service exceptions from WorkDocs service.</p>
68
81
  *
69
82
  */
70
83
  export declare class GetFolderPathCommand extends $Command<GetFolderPathCommandInput, GetFolderPathCommandOutput, WorkDocsClientResolvedConfig> {
package/dist-types/commands/GetResourcesCommand.d.ts CHANGED
@@ -36,6 +36,59 @@ export interface GetResourcesCommandOutput extends GetResourcesResponse, __Metad
36
36
  * };
37
37
  * const command = new GetResourcesCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // GetResourcesResponse
40
+ * // Folders: [ // FolderMetadataList
41
+ * // { // FolderMetadata
42
+ * // Id: "STRING_VALUE",
43
+ * // Name: "STRING_VALUE",
44
+ * // CreatorId: "STRING_VALUE",
45
+ * // ParentFolderId: "STRING_VALUE",
46
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
47
+ * // ModifiedTimestamp: new Date("TIMESTAMP"),
48
+ * // ResourceState: "ACTIVE" || "RESTORING" || "RECYCLING" || "RECYCLED",
49
+ * // Signature: "STRING_VALUE",
50
+ * // Labels: [ // SharedLabels
51
+ * // "STRING_VALUE",
52
+ * // ],
53
+ * // Size: Number("long"),
54
+ * // LatestVersionSize: Number("long"),
55
+ * // },
56
+ * // ],
57
+ * // Documents: [ // DocumentMetadataList
58
+ * // { // DocumentMetadata
59
+ * // Id: "STRING_VALUE",
60
+ * // CreatorId: "STRING_VALUE",
61
+ * // ParentFolderId: "STRING_VALUE",
62
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
63
+ * // ModifiedTimestamp: new Date("TIMESTAMP"),
64
+ * // LatestVersionMetadata: { // DocumentVersionMetadata
65
+ * // Id: "STRING_VALUE",
66
+ * // Name: "STRING_VALUE",
67
+ * // ContentType: "STRING_VALUE",
68
+ * // Size: Number("long"),
69
+ * // Signature: "STRING_VALUE",
70
+ * // Status: "INITIALIZED" || "ACTIVE",
71
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
72
+ * // ModifiedTimestamp: new Date("TIMESTAMP"),
73
+ * // ContentCreatedTimestamp: new Date("TIMESTAMP"),
74
+ * // ContentModifiedTimestamp: new Date("TIMESTAMP"),
75
+ * // CreatorId: "STRING_VALUE",
76
+ * // Thumbnail: { // DocumentThumbnailUrlMap
77
+ * // "<keys>": "STRING_VALUE",
78
+ * // },
79
+ * // Source: { // DocumentSourceUrlMap
80
+ * // "<keys>": "STRING_VALUE",
81
+ * // },
82
+ * // },
83
+ * // ResourceState: "ACTIVE" || "RESTORING" || "RECYCLING" || "RECYCLED",
84
+ * // Labels: [
85
+ * // "STRING_VALUE",
86
+ * // ],
87
+ * // },
88
+ * // ],
89
+ * // Marker: "STRING_VALUE",
90
+ * // };
91
+ *
39
92
  * ```
40
93
  *
41
94
  * @param GetResourcesCommandInput - {@link GetResourcesCommandInput}
@@ -61,6 +114,8 @@ export interface GetResourcesCommandOutput extends GetResourcesResponse, __Metad
61
114
  * @throws {@link UnauthorizedResourceAccessException} (client fault)
62
115
  * <p>The caller does not have access to perform the action on the resource.</p>
63
116
  *
117
+ * @throws {@link WorkDocsServiceException}
118
+ * <p>Base exception class for all service exceptions from WorkDocs service.</p>
64
119
  *
65
120
  */
66
121
  export declare class GetResourcesCommand extends $Command<GetResourcesCommandInput, GetResourcesCommandOutput, WorkDocsClientResolvedConfig> {
package/dist-types/commands/InitiateDocumentVersionUploadCommand.d.ts CHANGED
@@ -43,6 +43,45 @@ export interface InitiateDocumentVersionUploadCommandOutput extends InitiateDocu
43
43
  * };
44
44
  * const command = new InitiateDocumentVersionUploadCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // InitiateDocumentVersionUploadResponse
47
+ * // Metadata: { // DocumentMetadata
48
+ * // Id: "STRING_VALUE",
49
+ * // CreatorId: "STRING_VALUE",
50
+ * // ParentFolderId: "STRING_VALUE",
51
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
52
+ * // ModifiedTimestamp: new Date("TIMESTAMP"),
53
+ * // LatestVersionMetadata: { // DocumentVersionMetadata
54
+ * // Id: "STRING_VALUE",
55
+ * // Name: "STRING_VALUE",
56
+ * // ContentType: "STRING_VALUE",
57
+ * // Size: Number("long"),
58
+ * // Signature: "STRING_VALUE",
59
+ * // Status: "INITIALIZED" || "ACTIVE",
60
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
61
+ * // ModifiedTimestamp: new Date("TIMESTAMP"),
62
+ * // ContentCreatedTimestamp: new Date("TIMESTAMP"),
63
+ * // ContentModifiedTimestamp: new Date("TIMESTAMP"),
64
+ * // CreatorId: "STRING_VALUE",
65
+ * // Thumbnail: { // DocumentThumbnailUrlMap
66
+ * // "<keys>": "STRING_VALUE",
67
+ * // },
68
+ * // Source: { // DocumentSourceUrlMap
69
+ * // "<keys>": "STRING_VALUE",
70
+ * // },
71
+ * // },
72
+ * // ResourceState: "ACTIVE" || "RESTORING" || "RECYCLING" || "RECYCLED",
73
+ * // Labels: [ // SharedLabels
74
+ * // "STRING_VALUE",
75
+ * // ],
76
+ * // },
77
+ * // UploadMetadata: { // UploadMetadata
78
+ * // UploadUrl: "STRING_VALUE",
79
+ * // SignedHeaders: { // SignedHeaderMap
80
+ * // "<keys>": "STRING_VALUE",
81
+ * // },
82
+ * // },
83
+ * // };
84
+ *
46
85
  * ```
47
86
  *
48
87
  * @param InitiateDocumentVersionUploadCommandInput - {@link InitiateDocumentVersionUploadCommandInput}
@@ -96,6 +135,8 @@ export interface InitiateDocumentVersionUploadCommandOutput extends InitiateDocu
96
135
  * @throws {@link UnauthorizedResourceAccessException} (client fault)
97
136
  * <p>The caller does not have access to perform the action on the resource.</p>
98
137
  *
138
+ * @throws {@link WorkDocsServiceException}
139
+ * <p>Base exception class for all service exceptions from WorkDocs service.</p>
99
140
  *
100
141
  */
101
142
  export declare class InitiateDocumentVersionUploadCommand extends $Command<InitiateDocumentVersionUploadCommandInput, InitiateDocumentVersionUploadCommandOutput, WorkDocsClientResolvedConfig> {
package/dist-types/commands/RemoveAllResourcePermissionsCommand.d.ts CHANGED
@@ -32,6 +32,8 @@ export interface RemoveAllResourcePermissionsCommandOutput extends __MetadataBea
32
32
  * };
33
33
  * const command = new RemoveAllResourcePermissionsCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param RemoveAllResourcePermissionsCommandInput - {@link RemoveAllResourcePermissionsCommandInput}
@@ -54,6 +56,8 @@ export interface RemoveAllResourcePermissionsCommandOutput extends __MetadataBea
54
56
  * @throws {@link UnauthorizedResourceAccessException} (client fault)
55
57
  * <p>The caller does not have access to perform the action on the resource.</p>
56
58
  *
59
+ * @throws {@link WorkDocsServiceException}
60
+ * <p>Base exception class for all service exceptions from WorkDocs service.</p>
57
61
  *
58
62
  */
59
63
  export declare class RemoveAllResourcePermissionsCommand extends $Command<RemoveAllResourcePermissionsCommandInput, RemoveAllResourcePermissionsCommandOutput, WorkDocsClientResolvedConfig> {