@aws-sdk/client-workdocs 3.32.0 → 3.36.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 (401) hide show
  1. package/CHANGELOG.md +44 -0
  2. package/{dist/cjs → dist-cjs}/WorkDocs.js +1 -2
  3. package/{dist/cjs → dist-cjs}/WorkDocsClient.js +8 -9
  4. package/{dist/cjs → dist-cjs}/commands/AbortDocumentVersionUploadCommand.js +2 -3
  5. package/{dist/cjs → dist-cjs}/commands/ActivateUserCommand.js +2 -3
  6. package/{dist/cjs → dist-cjs}/commands/AddResourcePermissionsCommand.js +2 -3
  7. package/{dist/cjs → dist-cjs}/commands/CreateCommentCommand.js +2 -3
  8. package/{dist/cjs → dist-cjs}/commands/CreateCustomMetadataCommand.js +2 -3
  9. package/{dist/cjs → dist-cjs}/commands/CreateFolderCommand.js +2 -3
  10. package/{dist/cjs → dist-cjs}/commands/CreateLabelsCommand.js +2 -3
  11. package/{dist/cjs → dist-cjs}/commands/CreateNotificationSubscriptionCommand.js +2 -3
  12. package/{dist/cjs → dist-cjs}/commands/CreateUserCommand.js +2 -3
  13. package/{dist/cjs → dist-cjs}/commands/DeactivateUserCommand.js +2 -3
  14. package/{dist/cjs → dist-cjs}/commands/DeleteCommentCommand.js +2 -3
  15. package/{dist/cjs → dist-cjs}/commands/DeleteCustomMetadataCommand.js +2 -3
  16. package/{dist/cjs → dist-cjs}/commands/DeleteDocumentCommand.js +2 -3
  17. package/{dist/cjs → dist-cjs}/commands/DeleteFolderCommand.js +2 -3
  18. package/{dist/cjs → dist-cjs}/commands/DeleteFolderContentsCommand.js +2 -3
  19. package/{dist/cjs → dist-cjs}/commands/DeleteLabelsCommand.js +2 -3
  20. package/{dist/cjs → dist-cjs}/commands/DeleteNotificationSubscriptionCommand.js +2 -3
  21. package/{dist/cjs → dist-cjs}/commands/DeleteUserCommand.js +2 -3
  22. package/{dist/cjs → dist-cjs}/commands/DescribeActivitiesCommand.js +2 -3
  23. package/{dist/cjs → dist-cjs}/commands/DescribeCommentsCommand.js +2 -3
  24. package/{dist/cjs → dist-cjs}/commands/DescribeDocumentVersionsCommand.js +2 -3
  25. package/{dist/cjs → dist-cjs}/commands/DescribeFolderContentsCommand.js +2 -3
  26. package/{dist/cjs → dist-cjs}/commands/DescribeGroupsCommand.js +2 -3
  27. package/{dist/cjs → dist-cjs}/commands/DescribeNotificationSubscriptionsCommand.js +2 -3
  28. package/{dist/cjs → dist-cjs}/commands/DescribeResourcePermissionsCommand.js +2 -3
  29. package/{dist/cjs → dist-cjs}/commands/DescribeRootFoldersCommand.js +2 -3
  30. package/{dist/cjs → dist-cjs}/commands/DescribeUsersCommand.js +2 -3
  31. package/{dist/cjs → dist-cjs}/commands/GetCurrentUserCommand.js +2 -3
  32. package/{dist/cjs → dist-cjs}/commands/GetDocumentCommand.js +2 -3
  33. package/{dist/cjs → dist-cjs}/commands/GetDocumentPathCommand.js +2 -3
  34. package/{dist/cjs → dist-cjs}/commands/GetDocumentVersionCommand.js +2 -3
  35. package/{dist/cjs → dist-cjs}/commands/GetFolderCommand.js +2 -3
  36. package/{dist/cjs → dist-cjs}/commands/GetFolderPathCommand.js +2 -3
  37. package/{dist/cjs → dist-cjs}/commands/GetResourcesCommand.js +2 -3
  38. package/{dist/cjs → dist-cjs}/commands/InitiateDocumentVersionUploadCommand.js +2 -3
  39. package/{dist/cjs → dist-cjs}/commands/RemoveAllResourcePermissionsCommand.js +2 -3
  40. package/{dist/cjs → dist-cjs}/commands/RemoveResourcePermissionCommand.js +2 -3
  41. package/{dist/cjs → dist-cjs}/commands/UpdateDocumentCommand.js +2 -3
  42. package/{dist/cjs → dist-cjs}/commands/UpdateDocumentVersionCommand.js +2 -3
  43. package/{dist/cjs → dist-cjs}/commands/UpdateFolderCommand.js +2 -3
  44. package/{dist/cjs → dist-cjs}/commands/UpdateUserCommand.js +2 -3
  45. package/{dist/cjs → dist-cjs}/endpoints.js +0 -1
  46. package/{dist/cjs → dist-cjs}/index.js +0 -1
  47. package/{dist/cjs → dist-cjs}/models/index.js +0 -1
  48. package/{dist/cjs → dist-cjs}/models/models_0.js +0 -1
  49. package/{dist/cjs → dist-cjs}/pagination/DescribeDocumentVersionsPaginator.js +1 -2
  50. package/{dist/cjs → dist-cjs}/pagination/DescribeFolderContentsPaginator.js +1 -2
  51. package/{dist/cjs → dist-cjs}/pagination/DescribeUsersPaginator.js +1 -2
  52. package/{dist/cjs → dist-cjs}/pagination/Interfaces.js +0 -1
  53. package/{dist/cjs → dist-cjs}/protocols/Aws_restJson1.js +9 -10
  54. package/{dist/cjs → dist-cjs}/runtimeConfig.browser.js +2 -2
  55. package/{dist/cjs → dist-cjs}/runtimeConfig.js +2 -2
  56. package/{dist/cjs → dist-cjs}/runtimeConfig.native.js +0 -1
  57. package/{dist/cjs → dist-cjs}/runtimeConfig.shared.js +1 -2
  58. package/{dist/es → dist-es}/WorkDocs.js +2 -38
  59. package/dist-es/WorkDocsClient.js +37 -0
  60. package/{dist/es → dist-es}/commands/AbortDocumentVersionUploadCommand.js +4 -33
  61. package/{dist/es → dist-es}/commands/ActivateUserCommand.js +4 -31
  62. package/{dist/es → dist-es}/commands/AddResourcePermissionsCommand.js +4 -32
  63. package/{dist/es → dist-es}/commands/CreateCommentCommand.js +4 -30
  64. package/{dist/es → dist-es}/commands/CreateCustomMetadataCommand.js +4 -31
  65. package/{dist/es → dist-es}/commands/CreateFolderCommand.js +4 -30
  66. package/{dist/es → dist-es}/commands/CreateLabelsCommand.js +4 -31
  67. package/{dist/es → dist-es}/commands/CreateNotificationSubscriptionCommand.js +4 -34
  68. package/{dist/es → dist-es}/commands/CreateUserCommand.js +4 -31
  69. package/{dist/es → dist-es}/commands/DeactivateUserCommand.js +4 -31
  70. package/{dist/es → dist-es}/commands/DeleteCommentCommand.js +4 -30
  71. package/{dist/es → dist-es}/commands/DeleteCustomMetadataCommand.js +4 -30
  72. package/{dist/es → dist-es}/commands/DeleteDocumentCommand.js +4 -30
  73. package/{dist/es → dist-es}/commands/DeleteFolderCommand.js +4 -30
  74. package/{dist/es → dist-es}/commands/DeleteFolderContentsCommand.js +4 -30
  75. package/{dist/es → dist-es}/commands/DeleteLabelsCommand.js +4 -30
  76. package/{dist/es → dist-es}/commands/DeleteNotificationSubscriptionCommand.js +4 -30
  77. package/{dist/es → dist-es}/commands/DeleteUserCommand.js +4 -30
  78. package/{dist/es → dist-es}/commands/DescribeActivitiesCommand.js +4 -30
  79. package/{dist/es → dist-es}/commands/DescribeCommentsCommand.js +4 -30
  80. package/{dist/es → dist-es}/commands/DescribeDocumentVersionsCommand.js +4 -31
  81. package/{dist/es → dist-es}/commands/DescribeFolderContentsCommand.js +4 -35
  82. package/{dist/es → dist-es}/commands/DescribeGroupsCommand.js +4 -31
  83. package/{dist/es → dist-es}/commands/DescribeNotificationSubscriptionsCommand.js +4 -30
  84. package/{dist/es → dist-es}/commands/DescribeResourcePermissionsCommand.js +4 -30
  85. package/{dist/es → dist-es}/commands/DescribeRootFoldersCommand.js +4 -38
  86. package/{dist/es → dist-es}/commands/DescribeUsersCommand.js +4 -34
  87. package/{dist/es → dist-es}/commands/GetCurrentUserCommand.js +4 -36
  88. package/{dist/es → dist-es}/commands/GetDocumentCommand.js +4 -30
  89. package/{dist/es → dist-es}/commands/GetDocumentPathCommand.js +4 -35
  90. package/{dist/es → dist-es}/commands/GetDocumentVersionCommand.js +4 -30
  91. package/{dist/es → dist-es}/commands/GetFolderCommand.js +4 -30
  92. package/{dist/es → dist-es}/commands/GetFolderPathCommand.js +4 -35
  93. package/{dist/es → dist-es}/commands/GetResourcesCommand.js +4 -31
  94. package/{dist/es → dist-es}/commands/InitiateDocumentVersionUploadCommand.js +4 -35
  95. package/{dist/es → dist-es}/commands/RemoveAllResourcePermissionsCommand.js +4 -30
  96. package/{dist/es → dist-es}/commands/RemoveResourcePermissionCommand.js +4 -31
  97. package/{dist/es → dist-es}/commands/UpdateDocumentCommand.js +4 -31
  98. package/{dist/es → dist-es}/commands/UpdateDocumentVersionCommand.js +4 -33
  99. package/{dist/es → dist-es}/commands/UpdateFolderCommand.js +4 -31
  100. package/{dist/es → dist-es}/commands/UpdateUserCommand.js +4 -31
  101. package/{dist/es → dist-es}/endpoints.js +1 -2
  102. package/{dist/types/index.d.ts → dist-es/index.js} +0 -0
  103. package/{dist/types/models/index.d.ts → dist-es/models/index.js} +0 -0
  104. package/{dist/es → dist-es}/models/models_0.js +0 -349
  105. package/{dist/es → dist-es}/pagination/DescribeDocumentVersionsPaginator.js +17 -30
  106. package/{dist/es → dist-es}/pagination/DescribeFolderContentsPaginator.js +17 -30
  107. package/{dist/es → dist-es}/pagination/DescribeUsersPaginator.js +17 -30
  108. package/dist-es/pagination/Interfaces.js +1 -0
  109. package/{dist/es → dist-es}/protocols/Aws_restJson1.js +1398 -1404
  110. package/{dist/es → dist-es}/runtimeConfig.browser.js +1 -5
  111. package/{dist/es → dist-es}/runtimeConfig.js +1 -5
  112. package/{dist/es → dist-es}/runtimeConfig.native.js +0 -4
  113. package/{dist/es → dist-es}/runtimeConfig.shared.js +1 -5
  114. package/{dist/types → dist-types}/WorkDocs.d.ts +2 -2
  115. package/{dist/types → dist-types}/WorkDocsClient.d.ts +8 -8
  116. package/{dist/types → dist-types}/commands/AbortDocumentVersionUploadCommand.d.ts +3 -3
  117. package/{dist/types → dist-types}/commands/ActivateUserCommand.d.ts +3 -3
  118. package/{dist/types → dist-types}/commands/AddResourcePermissionsCommand.d.ts +3 -3
  119. package/{dist/types → dist-types}/commands/CreateCommentCommand.d.ts +3 -3
  120. package/{dist/types → dist-types}/commands/CreateCustomMetadataCommand.d.ts +3 -3
  121. package/{dist/types → dist-types}/commands/CreateFolderCommand.d.ts +3 -3
  122. package/{dist/types → dist-types}/commands/CreateLabelsCommand.d.ts +3 -3
  123. package/{dist/types → dist-types}/commands/CreateNotificationSubscriptionCommand.d.ts +3 -3
  124. package/{dist/types → dist-types}/commands/CreateUserCommand.d.ts +3 -3
  125. package/{dist/types → dist-types}/commands/DeactivateUserCommand.d.ts +3 -3
  126. package/{dist/types → dist-types}/commands/DeleteCommentCommand.d.ts +3 -3
  127. package/{dist/types → dist-types}/commands/DeleteCustomMetadataCommand.d.ts +3 -3
  128. package/{dist/types → dist-types}/commands/DeleteDocumentCommand.d.ts +3 -3
  129. package/{dist/types → dist-types}/commands/DeleteFolderCommand.d.ts +3 -3
  130. package/{dist/types → dist-types}/commands/DeleteFolderContentsCommand.d.ts +3 -3
  131. package/{dist/types → dist-types}/commands/DeleteLabelsCommand.d.ts +3 -3
  132. package/{dist/types → dist-types}/commands/DeleteNotificationSubscriptionCommand.d.ts +3 -3
  133. package/{dist/types → dist-types}/commands/DeleteUserCommand.d.ts +3 -3
  134. package/{dist/types → dist-types}/commands/DescribeActivitiesCommand.d.ts +3 -3
  135. package/{dist/types → dist-types}/commands/DescribeCommentsCommand.d.ts +3 -3
  136. package/{dist/types → dist-types}/commands/DescribeDocumentVersionsCommand.d.ts +3 -3
  137. package/{dist/types → dist-types}/commands/DescribeFolderContentsCommand.d.ts +3 -3
  138. package/{dist/types → dist-types}/commands/DescribeGroupsCommand.d.ts +3 -3
  139. package/{dist/types → dist-types}/commands/DescribeNotificationSubscriptionsCommand.d.ts +3 -3
  140. package/{dist/types → dist-types}/commands/DescribeResourcePermissionsCommand.d.ts +3 -3
  141. package/{dist/types → dist-types}/commands/DescribeRootFoldersCommand.d.ts +3 -3
  142. package/{dist/types → dist-types}/commands/DescribeUsersCommand.d.ts +3 -3
  143. package/{dist/types → dist-types}/commands/GetCurrentUserCommand.d.ts +3 -3
  144. package/{dist/types → dist-types}/commands/GetDocumentCommand.d.ts +3 -3
  145. package/{dist/types → dist-types}/commands/GetDocumentPathCommand.d.ts +3 -3
  146. package/{dist/types → dist-types}/commands/GetDocumentVersionCommand.d.ts +3 -3
  147. package/{dist/types → dist-types}/commands/GetFolderCommand.d.ts +3 -3
  148. package/{dist/types → dist-types}/commands/GetFolderPathCommand.d.ts +3 -3
  149. package/{dist/types → dist-types}/commands/GetResourcesCommand.d.ts +3 -3
  150. package/{dist/types → dist-types}/commands/InitiateDocumentVersionUploadCommand.d.ts +3 -3
  151. package/{dist/types → dist-types}/commands/RemoveAllResourcePermissionsCommand.d.ts +3 -3
  152. package/{dist/types → dist-types}/commands/RemoveResourcePermissionCommand.d.ts +3 -3
  153. package/{dist/types → dist-types}/commands/UpdateDocumentCommand.d.ts +3 -3
  154. package/{dist/types → dist-types}/commands/UpdateDocumentVersionCommand.d.ts +3 -3
  155. package/{dist/types → dist-types}/commands/UpdateFolderCommand.d.ts +3 -3
  156. package/{dist/types → dist-types}/commands/UpdateUserCommand.d.ts +3 -3
  157. package/{dist/types → dist-types}/endpoints.d.ts +0 -0
  158. package/{index.ts → dist-types/index.d.ts} +0 -0
  159. package/{models/index.ts → dist-types/models/index.d.ts} +0 -0
  160. package/{dist/types → dist-types}/models/models_0.d.ts +0 -0
  161. package/{dist/types → dist-types}/pagination/DescribeDocumentVersionsPaginator.d.ts +1 -1
  162. package/{dist/types → dist-types}/pagination/DescribeFolderContentsPaginator.d.ts +1 -1
  163. package/{dist/types → dist-types}/pagination/DescribeUsersPaginator.d.ts +1 -1
  164. package/{dist/types → dist-types}/pagination/Interfaces.d.ts +1 -1
  165. package/{dist/types → dist-types}/protocols/Aws_restJson1.d.ts +2 -2
  166. package/{dist/types → dist-types}/runtimeConfig.browser.d.ts +1 -0
  167. package/{dist/types/ts3.4 → dist-types}/runtimeConfig.d.ts +37 -36
  168. package/{dist/types/ts3.4 → dist-types}/runtimeConfig.native.d.ts +36 -35
  169. package/{dist/types → dist-types}/runtimeConfig.shared.d.ts +0 -0
  170. package/{dist/types → dist-types}/ts3.4/WorkDocs.d.ts +2 -2
  171. package/{dist/types → dist-types}/ts3.4/WorkDocsClient.d.ts +8 -8
  172. package/{dist/types → dist-types}/ts3.4/commands/AbortDocumentVersionUploadCommand.d.ts +3 -3
  173. package/{dist/types → dist-types}/ts3.4/commands/ActivateUserCommand.d.ts +3 -3
  174. package/{dist/types → dist-types}/ts3.4/commands/AddResourcePermissionsCommand.d.ts +3 -3
  175. package/{dist/types → dist-types}/ts3.4/commands/CreateCommentCommand.d.ts +3 -3
  176. package/{dist/types → dist-types}/ts3.4/commands/CreateCustomMetadataCommand.d.ts +3 -3
  177. package/{dist/types → dist-types}/ts3.4/commands/CreateFolderCommand.d.ts +3 -3
  178. package/{dist/types → dist-types}/ts3.4/commands/CreateLabelsCommand.d.ts +3 -3
  179. package/{dist/types → dist-types}/ts3.4/commands/CreateNotificationSubscriptionCommand.d.ts +3 -3
  180. package/{dist/types → dist-types}/ts3.4/commands/CreateUserCommand.d.ts +3 -3
  181. package/{dist/types → dist-types}/ts3.4/commands/DeactivateUserCommand.d.ts +3 -3
  182. package/{dist/types → dist-types}/ts3.4/commands/DeleteCommentCommand.d.ts +3 -3
  183. package/{dist/types → dist-types}/ts3.4/commands/DeleteCustomMetadataCommand.d.ts +3 -3
  184. package/{dist/types → dist-types}/ts3.4/commands/DeleteDocumentCommand.d.ts +3 -3
  185. package/{dist/types → dist-types}/ts3.4/commands/DeleteFolderCommand.d.ts +3 -3
  186. package/{dist/types → dist-types}/ts3.4/commands/DeleteFolderContentsCommand.d.ts +3 -3
  187. package/{dist/types → dist-types}/ts3.4/commands/DeleteLabelsCommand.d.ts +3 -3
  188. package/{dist/types → dist-types}/ts3.4/commands/DeleteNotificationSubscriptionCommand.d.ts +3 -3
  189. package/{dist/types → dist-types}/ts3.4/commands/DeleteUserCommand.d.ts +3 -3
  190. package/{dist/types → dist-types}/ts3.4/commands/DescribeActivitiesCommand.d.ts +3 -3
  191. package/{dist/types → dist-types}/ts3.4/commands/DescribeCommentsCommand.d.ts +3 -3
  192. package/{dist/types → dist-types}/ts3.4/commands/DescribeDocumentVersionsCommand.d.ts +3 -3
  193. package/{dist/types → dist-types}/ts3.4/commands/DescribeFolderContentsCommand.d.ts +3 -3
  194. package/{dist/types → dist-types}/ts3.4/commands/DescribeGroupsCommand.d.ts +3 -3
  195. package/{dist/types → dist-types}/ts3.4/commands/DescribeNotificationSubscriptionsCommand.d.ts +3 -3
  196. package/{dist/types → dist-types}/ts3.4/commands/DescribeResourcePermissionsCommand.d.ts +3 -3
  197. package/{dist/types → dist-types}/ts3.4/commands/DescribeRootFoldersCommand.d.ts +3 -3
  198. package/{dist/types → dist-types}/ts3.4/commands/DescribeUsersCommand.d.ts +3 -3
  199. package/{dist/types → dist-types}/ts3.4/commands/GetCurrentUserCommand.d.ts +3 -3
  200. package/{dist/types → dist-types}/ts3.4/commands/GetDocumentCommand.d.ts +3 -3
  201. package/{dist/types → dist-types}/ts3.4/commands/GetDocumentPathCommand.d.ts +3 -3
  202. package/{dist/types → dist-types}/ts3.4/commands/GetDocumentVersionCommand.d.ts +3 -3
  203. package/{dist/types → dist-types}/ts3.4/commands/GetFolderCommand.d.ts +3 -3
  204. package/{dist/types → dist-types}/ts3.4/commands/GetFolderPathCommand.d.ts +3 -3
  205. package/{dist/types → dist-types}/ts3.4/commands/GetResourcesCommand.d.ts +3 -3
  206. package/{dist/types → dist-types}/ts3.4/commands/InitiateDocumentVersionUploadCommand.d.ts +3 -3
  207. package/{dist/types → dist-types}/ts3.4/commands/RemoveAllResourcePermissionsCommand.d.ts +3 -3
  208. package/{dist/types → dist-types}/ts3.4/commands/RemoveResourcePermissionCommand.d.ts +3 -3
  209. package/{dist/types → dist-types}/ts3.4/commands/UpdateDocumentCommand.d.ts +3 -3
  210. package/{dist/types → dist-types}/ts3.4/commands/UpdateDocumentVersionCommand.d.ts +3 -3
  211. package/{dist/types → dist-types}/ts3.4/commands/UpdateFolderCommand.d.ts +3 -3
  212. package/{dist/types → dist-types}/ts3.4/commands/UpdateUserCommand.d.ts +3 -3
  213. package/{dist/types → dist-types}/ts3.4/endpoints.d.ts +0 -0
  214. package/{dist/types → dist-types}/ts3.4/index.d.ts +0 -0
  215. package/{dist/types → dist-types}/ts3.4/models/index.d.ts +0 -0
  216. package/{dist/types → dist-types}/ts3.4/models/models_0.d.ts +0 -0
  217. package/{dist/types → dist-types}/ts3.4/pagination/DescribeDocumentVersionsPaginator.d.ts +1 -1
  218. package/{dist/types → dist-types}/ts3.4/pagination/DescribeFolderContentsPaginator.d.ts +1 -1
  219. package/{dist/types → dist-types}/ts3.4/pagination/DescribeUsersPaginator.d.ts +1 -1
  220. package/{dist/types → dist-types}/ts3.4/pagination/Interfaces.d.ts +1 -1
  221. package/{dist/types → dist-types}/ts3.4/protocols/Aws_restJson1.d.ts +2 -2
  222. package/{dist/types → dist-types}/ts3.4/runtimeConfig.browser.d.ts +1 -0
  223. package/{dist/types → dist-types/ts3.4}/runtimeConfig.d.ts +37 -36
  224. package/{dist/types → dist-types/ts3.4}/runtimeConfig.native.d.ts +36 -35
  225. package/{dist/types → dist-types}/ts3.4/runtimeConfig.shared.d.ts +0 -0
  226. package/package.json +52 -49
  227. package/WorkDocs.ts +0 -1547
  228. package/WorkDocsClient.ts +0 -438
  229. package/commands/AbortDocumentVersionUploadCommand.ts +0 -100
  230. package/commands/ActivateUserCommand.ts +0 -95
  231. package/commands/AddResourcePermissionsCommand.ts +0 -96
  232. package/commands/CreateCommentCommand.ts +0 -94
  233. package/commands/CreateCustomMetadataCommand.ts +0 -95
  234. package/commands/CreateFolderCommand.ts +0 -94
  235. package/commands/CreateLabelsCommand.ts +0 -95
  236. package/commands/CreateNotificationSubscriptionCommand.ts +0 -106
  237. package/commands/CreateUserCommand.ts +0 -95
  238. package/commands/DeactivateUserCommand.ts +0 -95
  239. package/commands/DeleteCommentCommand.ts +0 -94
  240. package/commands/DeleteCustomMetadataCommand.ts +0 -94
  241. package/commands/DeleteDocumentCommand.ts +0 -94
  242. package/commands/DeleteFolderCommand.ts +0 -94
  243. package/commands/DeleteFolderContentsCommand.ts +0 -94
  244. package/commands/DeleteLabelsCommand.ts +0 -94
  245. package/commands/DeleteNotificationSubscriptionCommand.ts +0 -100
  246. package/commands/DeleteUserCommand.ts +0 -94
  247. package/commands/DescribeActivitiesCommand.ts +0 -94
  248. package/commands/DescribeCommentsCommand.ts +0 -94
  249. package/commands/DescribeDocumentVersionsCommand.ts +0 -95
  250. package/commands/DescribeFolderContentsCommand.ts +0 -99
  251. package/commands/DescribeGroupsCommand.ts +0 -95
  252. package/commands/DescribeNotificationSubscriptionsCommand.ts +0 -105
  253. package/commands/DescribeResourcePermissionsCommand.ts +0 -99
  254. package/commands/DescribeRootFoldersCommand.ts +0 -102
  255. package/commands/DescribeUsersCommand.ts +0 -98
  256. package/commands/GetCurrentUserCommand.ts +0 -100
  257. package/commands/GetDocumentCommand.ts +0 -94
  258. package/commands/GetDocumentPathCommand.ts +0 -99
  259. package/commands/GetDocumentVersionCommand.ts +0 -94
  260. package/commands/GetFolderCommand.ts +0 -94
  261. package/commands/GetFolderPathCommand.ts +0 -99
  262. package/commands/GetResourcesCommand.ts +0 -95
  263. package/commands/InitiateDocumentVersionUploadCommand.ts +0 -104
  264. package/commands/RemoveAllResourcePermissionsCommand.ts +0 -97
  265. package/commands/RemoveResourcePermissionCommand.ts +0 -95
  266. package/commands/UpdateDocumentCommand.ts +0 -95
  267. package/commands/UpdateDocumentVersionCommand.ts +0 -97
  268. package/commands/UpdateFolderCommand.ts +0 -95
  269. package/commands/UpdateUserCommand.ts +0 -95
  270. package/dist/cjs/WorkDocs.js.map +0 -1
  271. package/dist/cjs/WorkDocsClient.js.map +0 -1
  272. package/dist/cjs/commands/AbortDocumentVersionUploadCommand.js.map +0 -1
  273. package/dist/cjs/commands/ActivateUserCommand.js.map +0 -1
  274. package/dist/cjs/commands/AddResourcePermissionsCommand.js.map +0 -1
  275. package/dist/cjs/commands/CreateCommentCommand.js.map +0 -1
  276. package/dist/cjs/commands/CreateCustomMetadataCommand.js.map +0 -1
  277. package/dist/cjs/commands/CreateFolderCommand.js.map +0 -1
  278. package/dist/cjs/commands/CreateLabelsCommand.js.map +0 -1
  279. package/dist/cjs/commands/CreateNotificationSubscriptionCommand.js.map +0 -1
  280. package/dist/cjs/commands/CreateUserCommand.js.map +0 -1
  281. package/dist/cjs/commands/DeactivateUserCommand.js.map +0 -1
  282. package/dist/cjs/commands/DeleteCommentCommand.js.map +0 -1
  283. package/dist/cjs/commands/DeleteCustomMetadataCommand.js.map +0 -1
  284. package/dist/cjs/commands/DeleteDocumentCommand.js.map +0 -1
  285. package/dist/cjs/commands/DeleteFolderCommand.js.map +0 -1
  286. package/dist/cjs/commands/DeleteFolderContentsCommand.js.map +0 -1
  287. package/dist/cjs/commands/DeleteLabelsCommand.js.map +0 -1
  288. package/dist/cjs/commands/DeleteNotificationSubscriptionCommand.js.map +0 -1
  289. package/dist/cjs/commands/DeleteUserCommand.js.map +0 -1
  290. package/dist/cjs/commands/DescribeActivitiesCommand.js.map +0 -1
  291. package/dist/cjs/commands/DescribeCommentsCommand.js.map +0 -1
  292. package/dist/cjs/commands/DescribeDocumentVersionsCommand.js.map +0 -1
  293. package/dist/cjs/commands/DescribeFolderContentsCommand.js.map +0 -1
  294. package/dist/cjs/commands/DescribeGroupsCommand.js.map +0 -1
  295. package/dist/cjs/commands/DescribeNotificationSubscriptionsCommand.js.map +0 -1
  296. package/dist/cjs/commands/DescribeResourcePermissionsCommand.js.map +0 -1
  297. package/dist/cjs/commands/DescribeRootFoldersCommand.js.map +0 -1
  298. package/dist/cjs/commands/DescribeUsersCommand.js.map +0 -1
  299. package/dist/cjs/commands/GetCurrentUserCommand.js.map +0 -1
  300. package/dist/cjs/commands/GetDocumentCommand.js.map +0 -1
  301. package/dist/cjs/commands/GetDocumentPathCommand.js.map +0 -1
  302. package/dist/cjs/commands/GetDocumentVersionCommand.js.map +0 -1
  303. package/dist/cjs/commands/GetFolderCommand.js.map +0 -1
  304. package/dist/cjs/commands/GetFolderPathCommand.js.map +0 -1
  305. package/dist/cjs/commands/GetResourcesCommand.js.map +0 -1
  306. package/dist/cjs/commands/InitiateDocumentVersionUploadCommand.js.map +0 -1
  307. package/dist/cjs/commands/RemoveAllResourcePermissionsCommand.js.map +0 -1
  308. package/dist/cjs/commands/RemoveResourcePermissionCommand.js.map +0 -1
  309. package/dist/cjs/commands/UpdateDocumentCommand.js.map +0 -1
  310. package/dist/cjs/commands/UpdateDocumentVersionCommand.js.map +0 -1
  311. package/dist/cjs/commands/UpdateFolderCommand.js.map +0 -1
  312. package/dist/cjs/commands/UpdateUserCommand.js.map +0 -1
  313. package/dist/cjs/endpoints.js.map +0 -1
  314. package/dist/cjs/index.js.map +0 -1
  315. package/dist/cjs/models/index.js.map +0 -1
  316. package/dist/cjs/models/models_0.js.map +0 -1
  317. package/dist/cjs/package.json +0 -91
  318. package/dist/cjs/pagination/DescribeDocumentVersionsPaginator.js.map +0 -1
  319. package/dist/cjs/pagination/DescribeFolderContentsPaginator.js.map +0 -1
  320. package/dist/cjs/pagination/DescribeUsersPaginator.js.map +0 -1
  321. package/dist/cjs/pagination/Interfaces.js.map +0 -1
  322. package/dist/cjs/protocols/Aws_restJson1.js.map +0 -1
  323. package/dist/cjs/runtimeConfig.browser.js.map +0 -1
  324. package/dist/cjs/runtimeConfig.js.map +0 -1
  325. package/dist/cjs/runtimeConfig.native.js.map +0 -1
  326. package/dist/cjs/runtimeConfig.shared.js.map +0 -1
  327. package/dist/es/WorkDocs.js.map +0 -1
  328. package/dist/es/WorkDocsClient.js +0 -78
  329. package/dist/es/WorkDocsClient.js.map +0 -1
  330. package/dist/es/commands/AbortDocumentVersionUploadCommand.js.map +0 -1
  331. package/dist/es/commands/ActivateUserCommand.js.map +0 -1
  332. package/dist/es/commands/AddResourcePermissionsCommand.js.map +0 -1
  333. package/dist/es/commands/CreateCommentCommand.js.map +0 -1
  334. package/dist/es/commands/CreateCustomMetadataCommand.js.map +0 -1
  335. package/dist/es/commands/CreateFolderCommand.js.map +0 -1
  336. package/dist/es/commands/CreateLabelsCommand.js.map +0 -1
  337. package/dist/es/commands/CreateNotificationSubscriptionCommand.js.map +0 -1
  338. package/dist/es/commands/CreateUserCommand.js.map +0 -1
  339. package/dist/es/commands/DeactivateUserCommand.js.map +0 -1
  340. package/dist/es/commands/DeleteCommentCommand.js.map +0 -1
  341. package/dist/es/commands/DeleteCustomMetadataCommand.js.map +0 -1
  342. package/dist/es/commands/DeleteDocumentCommand.js.map +0 -1
  343. package/dist/es/commands/DeleteFolderCommand.js.map +0 -1
  344. package/dist/es/commands/DeleteFolderContentsCommand.js.map +0 -1
  345. package/dist/es/commands/DeleteLabelsCommand.js.map +0 -1
  346. package/dist/es/commands/DeleteNotificationSubscriptionCommand.js.map +0 -1
  347. package/dist/es/commands/DeleteUserCommand.js.map +0 -1
  348. package/dist/es/commands/DescribeActivitiesCommand.js.map +0 -1
  349. package/dist/es/commands/DescribeCommentsCommand.js.map +0 -1
  350. package/dist/es/commands/DescribeDocumentVersionsCommand.js.map +0 -1
  351. package/dist/es/commands/DescribeFolderContentsCommand.js.map +0 -1
  352. package/dist/es/commands/DescribeGroupsCommand.js.map +0 -1
  353. package/dist/es/commands/DescribeNotificationSubscriptionsCommand.js.map +0 -1
  354. package/dist/es/commands/DescribeResourcePermissionsCommand.js.map +0 -1
  355. package/dist/es/commands/DescribeRootFoldersCommand.js.map +0 -1
  356. package/dist/es/commands/DescribeUsersCommand.js.map +0 -1
  357. package/dist/es/commands/GetCurrentUserCommand.js.map +0 -1
  358. package/dist/es/commands/GetDocumentCommand.js.map +0 -1
  359. package/dist/es/commands/GetDocumentPathCommand.js.map +0 -1
  360. package/dist/es/commands/GetDocumentVersionCommand.js.map +0 -1
  361. package/dist/es/commands/GetFolderCommand.js.map +0 -1
  362. package/dist/es/commands/GetFolderPathCommand.js.map +0 -1
  363. package/dist/es/commands/GetResourcesCommand.js.map +0 -1
  364. package/dist/es/commands/InitiateDocumentVersionUploadCommand.js.map +0 -1
  365. package/dist/es/commands/RemoveAllResourcePermissionsCommand.js.map +0 -1
  366. package/dist/es/commands/RemoveResourcePermissionCommand.js.map +0 -1
  367. package/dist/es/commands/UpdateDocumentCommand.js.map +0 -1
  368. package/dist/es/commands/UpdateDocumentVersionCommand.js.map +0 -1
  369. package/dist/es/commands/UpdateFolderCommand.js.map +0 -1
  370. package/dist/es/commands/UpdateUserCommand.js.map +0 -1
  371. package/dist/es/endpoints.js.map +0 -1
  372. package/dist/es/index.js +0 -49
  373. package/dist/es/index.js.map +0 -1
  374. package/dist/es/models/index.js +0 -2
  375. package/dist/es/models/index.js.map +0 -1
  376. package/dist/es/models/models_0.js.map +0 -1
  377. package/dist/es/package.json +0 -91
  378. package/dist/es/pagination/DescribeDocumentVersionsPaginator.js.map +0 -1
  379. package/dist/es/pagination/DescribeFolderContentsPaginator.js.map +0 -1
  380. package/dist/es/pagination/DescribeUsersPaginator.js.map +0 -1
  381. package/dist/es/pagination/Interfaces.js +0 -2
  382. package/dist/es/pagination/Interfaces.js.map +0 -1
  383. package/dist/es/protocols/Aws_restJson1.js.map +0 -1
  384. package/dist/es/runtimeConfig.browser.js.map +0 -1
  385. package/dist/es/runtimeConfig.js.map +0 -1
  386. package/dist/es/runtimeConfig.native.js.map +0 -1
  387. package/dist/es/runtimeConfig.shared.js.map +0 -1
  388. package/endpoints.ts +0 -68
  389. package/jest.config.js +0 -4
  390. package/models/models_0.ts +0 -3531
  391. package/pagination/DescribeDocumentVersionsPaginator.ts +0 -58
  392. package/pagination/DescribeFolderContentsPaginator.ts +0 -58
  393. package/pagination/DescribeUsersPaginator.ts +0 -58
  394. package/pagination/Interfaces.ts +0 -7
  395. package/protocols/Aws_restJson1.ts +0 -6691
  396. package/runtimeConfig.browser.ts +0 -40
  397. package/runtimeConfig.native.ts +0 -16
  398. package/runtimeConfig.shared.ts +0 -16
  399. package/runtimeConfig.ts +0 -45
  400. package/tsconfig.es.json +0 -12
  401. package/tsconfig.json +0 -32
@@ -1,3531 +0,0 @@
1
- import { SENSITIVE_STRING } from "@aws-sdk/smithy-client";
2
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
3
-
4
- export interface AbortDocumentVersionUploadRequest {
5
- /**
6
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
7
- */
8
- AuthenticationToken?: string;
9
-
10
- /**
11
- * <p>The ID of the document.</p>
12
- */
13
- DocumentId: string | undefined;
14
-
15
- /**
16
- * <p>The ID of the version.</p>
17
- */
18
- VersionId: string | undefined;
19
- }
20
-
21
- export namespace AbortDocumentVersionUploadRequest {
22
- /**
23
- * @internal
24
- */
25
- export const filterSensitiveLog = (obj: AbortDocumentVersionUploadRequest): any => ({
26
- ...obj,
27
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
28
- });
29
- }
30
-
31
- /**
32
- * <p>The resource does not exist.</p>
33
- */
34
- export interface EntityNotExistsException extends __SmithyException, $MetadataBearer {
35
- name: "EntityNotExistsException";
36
- $fault: "client";
37
- Message?: string;
38
- EntityIds?: string[];
39
- }
40
-
41
- export namespace EntityNotExistsException {
42
- /**
43
- * @internal
44
- */
45
- export const filterSensitiveLog = (obj: EntityNotExistsException): any => ({
46
- ...obj,
47
- });
48
- }
49
-
50
- /**
51
- * <p>The AWS Directory Service cannot reach an on-premises instance. Or a dependency
52
- * under the control of the organization is failing, such as a connected Active
53
- * Directory.</p>
54
- */
55
- export interface FailedDependencyException extends __SmithyException, $MetadataBearer {
56
- name: "FailedDependencyException";
57
- $fault: "client";
58
- Message?: string;
59
- }
60
-
61
- export namespace FailedDependencyException {
62
- /**
63
- * @internal
64
- */
65
- export const filterSensitiveLog = (obj: FailedDependencyException): any => ({
66
- ...obj,
67
- });
68
- }
69
-
70
- /**
71
- * <p>The specified document version is not in the INITIALIZED state.</p>
72
- */
73
- export interface ProhibitedStateException extends __SmithyException, $MetadataBearer {
74
- name: "ProhibitedStateException";
75
- $fault: "client";
76
- Message?: string;
77
- }
78
-
79
- export namespace ProhibitedStateException {
80
- /**
81
- * @internal
82
- */
83
- export const filterSensitiveLog = (obj: ProhibitedStateException): any => ({
84
- ...obj,
85
- });
86
- }
87
-
88
- /**
89
- * <p>One or more of the dependencies is unavailable.</p>
90
- */
91
- export interface ServiceUnavailableException extends __SmithyException, $MetadataBearer {
92
- name: "ServiceUnavailableException";
93
- $fault: "server";
94
- Message?: string;
95
- }
96
-
97
- export namespace ServiceUnavailableException {
98
- /**
99
- * @internal
100
- */
101
- export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({
102
- ...obj,
103
- });
104
- }
105
-
106
- /**
107
- * <p>The operation is not permitted.</p>
108
- */
109
- export interface UnauthorizedOperationException extends __SmithyException, $MetadataBearer {
110
- name: "UnauthorizedOperationException";
111
- $fault: "client";
112
- Message?: string;
113
- Code?: string;
114
- }
115
-
116
- export namespace UnauthorizedOperationException {
117
- /**
118
- * @internal
119
- */
120
- export const filterSensitiveLog = (obj: UnauthorizedOperationException): any => ({
121
- ...obj,
122
- });
123
- }
124
-
125
- /**
126
- * <p>The caller does not have access to perform the action on the resource.</p>
127
- */
128
- export interface UnauthorizedResourceAccessException extends __SmithyException, $MetadataBearer {
129
- name: "UnauthorizedResourceAccessException";
130
- $fault: "client";
131
- Message?: string;
132
- }
133
-
134
- export namespace UnauthorizedResourceAccessException {
135
- /**
136
- * @internal
137
- */
138
- export const filterSensitiveLog = (obj: UnauthorizedResourceAccessException): any => ({
139
- ...obj,
140
- });
141
- }
142
-
143
- export interface ActivateUserRequest {
144
- /**
145
- * <p>The ID of the user.</p>
146
- */
147
- UserId: string | undefined;
148
-
149
- /**
150
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
151
- */
152
- AuthenticationToken?: string;
153
- }
154
-
155
- export namespace ActivateUserRequest {
156
- /**
157
- * @internal
158
- */
159
- export const filterSensitiveLog = (obj: ActivateUserRequest): any => ({
160
- ...obj,
161
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
162
- });
163
- }
164
-
165
- export enum LocaleType {
166
- DE = "de",
167
- DEFAULT = "default",
168
- EN = "en",
169
- ES = "es",
170
- FR = "fr",
171
- JA = "ja",
172
- KO = "ko",
173
- PT_BR = "pt_BR",
174
- RU = "ru",
175
- ZH_CN = "zh_CN",
176
- ZH_TW = "zh_TW",
177
- }
178
-
179
- export enum UserStatusType {
180
- ACTIVE = "ACTIVE",
181
- INACTIVE = "INACTIVE",
182
- PENDING = "PENDING",
183
- }
184
-
185
- export enum StorageType {
186
- QUOTA = "QUOTA",
187
- UNLIMITED = "UNLIMITED",
188
- }
189
-
190
- /**
191
- * <p>Describes the storage for a user.</p>
192
- */
193
- export interface StorageRuleType {
194
- /**
195
- * <p>The amount of storage allocated, in bytes.</p>
196
- */
197
- StorageAllocatedInBytes?: number;
198
-
199
- /**
200
- * <p>The type of storage.</p>
201
- */
202
- StorageType?: StorageType | string;
203
- }
204
-
205
- export namespace StorageRuleType {
206
- /**
207
- * @internal
208
- */
209
- export const filterSensitiveLog = (obj: StorageRuleType): any => ({
210
- ...obj,
211
- });
212
- }
213
-
214
- /**
215
- * <p>Describes the storage for a user.</p>
216
- */
217
- export interface UserStorageMetadata {
218
- /**
219
- * <p>The amount of storage used, in bytes.</p>
220
- */
221
- StorageUtilizedInBytes?: number;
222
-
223
- /**
224
- * <p>The storage for a user.</p>
225
- */
226
- StorageRule?: StorageRuleType;
227
- }
228
-
229
- export namespace UserStorageMetadata {
230
- /**
231
- * @internal
232
- */
233
- export const filterSensitiveLog = (obj: UserStorageMetadata): any => ({
234
- ...obj,
235
- });
236
- }
237
-
238
- export enum UserType {
239
- ADMIN = "ADMIN",
240
- MINIMALUSER = "MINIMALUSER",
241
- POWERUSER = "POWERUSER",
242
- USER = "USER",
243
- WORKSPACESUSER = "WORKSPACESUSER",
244
- }
245
-
246
- /**
247
- * <p>Describes a user.</p>
248
- */
249
- export interface User {
250
- /**
251
- * <p>The ID of the user.</p>
252
- */
253
- Id?: string;
254
-
255
- /**
256
- * <p>The login name of the user.</p>
257
- */
258
- Username?: string;
259
-
260
- /**
261
- * <p>The email address of the user.</p>
262
- */
263
- EmailAddress?: string;
264
-
265
- /**
266
- * <p>The given name of the user.</p>
267
- */
268
- GivenName?: string;
269
-
270
- /**
271
- * <p>The surname of the user.</p>
272
- */
273
- Surname?: string;
274
-
275
- /**
276
- * <p>The ID of the organization.</p>
277
- */
278
- OrganizationId?: string;
279
-
280
- /**
281
- * <p>The ID of the root folder.</p>
282
- */
283
- RootFolderId?: string;
284
-
285
- /**
286
- * <p>The ID of the recycle bin folder.</p>
287
- */
288
- RecycleBinFolderId?: string;
289
-
290
- /**
291
- * <p>The status of the user.</p>
292
- */
293
- Status?: UserStatusType | string;
294
-
295
- /**
296
- * <p>The type of user.</p>
297
- */
298
- Type?: UserType | string;
299
-
300
- /**
301
- * <p>The time when the user was created.</p>
302
- */
303
- CreatedTimestamp?: Date;
304
-
305
- /**
306
- * <p>The time when the user was modified.</p>
307
- */
308
- ModifiedTimestamp?: Date;
309
-
310
- /**
311
- * <p>The time zone ID of the user.</p>
312
- */
313
- TimeZoneId?: string;
314
-
315
- /**
316
- * <p>The locale of the user.</p>
317
- */
318
- Locale?: LocaleType | string;
319
-
320
- /**
321
- * <p>The storage for the user.</p>
322
- */
323
- Storage?: UserStorageMetadata;
324
- }
325
-
326
- export namespace User {
327
- /**
328
- * @internal
329
- */
330
- export const filterSensitiveLog = (obj: User): any => ({
331
- ...obj,
332
- });
333
- }
334
-
335
- export interface ActivateUserResponse {
336
- /**
337
- * <p>The user information.</p>
338
- */
339
- User?: User;
340
- }
341
-
342
- export namespace ActivateUserResponse {
343
- /**
344
- * @internal
345
- */
346
- export const filterSensitiveLog = (obj: ActivateUserResponse): any => ({
347
- ...obj,
348
- });
349
- }
350
-
351
- export enum CommentStatusType {
352
- DELETED = "DELETED",
353
- DRAFT = "DRAFT",
354
- PUBLISHED = "PUBLISHED",
355
- }
356
-
357
- /**
358
- * <p>Describes the metadata of a comment.</p>
359
- */
360
- export interface CommentMetadata {
361
- /**
362
- * <p>The ID of the comment.</p>
363
- */
364
- CommentId?: string;
365
-
366
- /**
367
- * <p>The user who made the comment.</p>
368
- */
369
- Contributor?: User;
370
-
371
- /**
372
- * <p>The timestamp that the comment was created.</p>
373
- */
374
- CreatedTimestamp?: Date;
375
-
376
- /**
377
- * <p>The status of the comment.</p>
378
- */
379
- CommentStatus?: CommentStatusType | string;
380
-
381
- /**
382
- * <p>The ID of the user being replied to.</p>
383
- */
384
- RecipientId?: string;
385
- }
386
-
387
- export namespace CommentMetadata {
388
- /**
389
- * @internal
390
- */
391
- export const filterSensitiveLog = (obj: CommentMetadata): any => ({
392
- ...obj,
393
- });
394
- }
395
-
396
- /**
397
- * <p>Describes the metadata of the user.</p>
398
- */
399
- export interface UserMetadata {
400
- /**
401
- * <p>The ID of the user.</p>
402
- */
403
- Id?: string;
404
-
405
- /**
406
- * <p>The name of the user.</p>
407
- */
408
- Username?: string;
409
-
410
- /**
411
- * <p>The given name of the user before a rename operation.</p>
412
- */
413
- GivenName?: string;
414
-
415
- /**
416
- * <p>The surname of the user.</p>
417
- */
418
- Surname?: string;
419
-
420
- /**
421
- * <p>The email address of the user.</p>
422
- */
423
- EmailAddress?: string;
424
- }
425
-
426
- export namespace UserMetadata {
427
- /**
428
- * @internal
429
- */
430
- export const filterSensitiveLog = (obj: UserMetadata): any => ({
431
- ...obj,
432
- });
433
- }
434
-
435
- export enum ResourceType {
436
- DOCUMENT = "DOCUMENT",
437
- FOLDER = "FOLDER",
438
- }
439
-
440
- /**
441
- * <p>Describes the metadata of a resource.</p>
442
- */
443
- export interface ResourceMetadata {
444
- /**
445
- * <p>The type of resource.</p>
446
- */
447
- Type?: ResourceType | string;
448
-
449
- /**
450
- * <p>The name of the resource.</p>
451
- */
452
- Name?: string;
453
-
454
- /**
455
- * <p>The original name of the resource before a rename operation.</p>
456
- */
457
- OriginalName?: string;
458
-
459
- /**
460
- * <p>The ID of the resource.</p>
461
- */
462
- Id?: string;
463
-
464
- /**
465
- * <p>The version ID of the resource. This is an optional field and is filled for action
466
- * on document version.</p>
467
- */
468
- VersionId?: string;
469
-
470
- /**
471
- * <p>The owner of the resource.</p>
472
- */
473
- Owner?: UserMetadata;
474
-
475
- /**
476
- * <p>The parent ID of the resource before a rename operation.</p>
477
- */
478
- ParentId?: string;
479
- }
480
-
481
- export namespace ResourceMetadata {
482
- /**
483
- * @internal
484
- */
485
- export const filterSensitiveLog = (obj: ResourceMetadata): any => ({
486
- ...obj,
487
- });
488
- }
489
-
490
- /**
491
- * <p>Describes the metadata of a user group.</p>
492
- */
493
- export interface GroupMetadata {
494
- /**
495
- * <p>The ID of the user group.</p>
496
- */
497
- Id?: string;
498
-
499
- /**
500
- * <p>The name of the group.</p>
501
- */
502
- Name?: string;
503
- }
504
-
505
- export namespace GroupMetadata {
506
- /**
507
- * @internal
508
- */
509
- export const filterSensitiveLog = (obj: GroupMetadata): any => ({
510
- ...obj,
511
- });
512
- }
513
-
514
- /**
515
- * <p>Describes the users or user groups.</p>
516
- */
517
- export interface Participants {
518
- /**
519
- * <p>The list of users.</p>
520
- */
521
- Users?: UserMetadata[];
522
-
523
- /**
524
- * <p>The list of user groups.</p>
525
- */
526
- Groups?: GroupMetadata[];
527
- }
528
-
529
- export namespace Participants {
530
- /**
531
- * @internal
532
- */
533
- export const filterSensitiveLog = (obj: Participants): any => ({
534
- ...obj,
535
- });
536
- }
537
-
538
- export enum ActivityType {
539
- DOCUMENT_ANNOTATION_ADDED = "DOCUMENT_ANNOTATION_ADDED",
540
- DOCUMENT_ANNOTATION_DELETED = "DOCUMENT_ANNOTATION_DELETED",
541
- DOCUMENT_CHECKED_IN = "DOCUMENT_CHECKED_IN",
542
- DOCUMENT_CHECKED_OUT = "DOCUMENT_CHECKED_OUT",
543
- DOCUMENT_COMMENT_ADDED = "DOCUMENT_COMMENT_ADDED",
544
- DOCUMENT_COMMENT_DELETED = "DOCUMENT_COMMENT_DELETED",
545
- DOCUMENT_MOVED = "DOCUMENT_MOVED",
546
- DOCUMENT_RECYCLED = "DOCUMENT_RECYCLED",
547
- DOCUMENT_RENAMED = "DOCUMENT_RENAMED",
548
- DOCUMENT_RESTORED = "DOCUMENT_RESTORED",
549
- DOCUMENT_REVERTED = "DOCUMENT_REVERTED",
550
- DOCUMENT_SHAREABLE_LINK_CREATED = "DOCUMENT_SHAREABLE_LINK_CREATED",
551
- DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED = "DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED",
552
- DOCUMENT_SHAREABLE_LINK_REMOVED = "DOCUMENT_SHAREABLE_LINK_REMOVED",
553
- DOCUMENT_SHARED = "DOCUMENT_SHARED",
554
- DOCUMENT_SHARE_PERMISSION_CHANGED = "DOCUMENT_SHARE_PERMISSION_CHANGED",
555
- DOCUMENT_UNSHARED = "DOCUMENT_UNSHARED",
556
- DOCUMENT_VERSION_DELETED = "DOCUMENT_VERSION_DELETED",
557
- DOCUMENT_VERSION_DOWNLOADED = "DOCUMENT_VERSION_DOWNLOADED",
558
- DOCUMENT_VERSION_UPLOADED = "DOCUMENT_VERSION_UPLOADED",
559
- DOCUMENT_VERSION_VIEWED = "DOCUMENT_VERSION_VIEWED",
560
- FOLDER_CREATED = "FOLDER_CREATED",
561
- FOLDER_DELETED = "FOLDER_DELETED",
562
- FOLDER_MOVED = "FOLDER_MOVED",
563
- FOLDER_RECYCLED = "FOLDER_RECYCLED",
564
- FOLDER_RENAMED = "FOLDER_RENAMED",
565
- FOLDER_RESTORED = "FOLDER_RESTORED",
566
- FOLDER_SHAREABLE_LINK_CREATED = "FOLDER_SHAREABLE_LINK_CREATED",
567
- FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED = "FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED",
568
- FOLDER_SHAREABLE_LINK_REMOVED = "FOLDER_SHAREABLE_LINK_REMOVED",
569
- FOLDER_SHARED = "FOLDER_SHARED",
570
- FOLDER_SHARE_PERMISSION_CHANGED = "FOLDER_SHARE_PERMISSION_CHANGED",
571
- FOLDER_UNSHARED = "FOLDER_UNSHARED",
572
- }
573
-
574
- /**
575
- * <p>Describes the activity information.</p>
576
- */
577
- export interface Activity {
578
- /**
579
- * <p>The activity type.</p>
580
- */
581
- Type?: ActivityType | string;
582
-
583
- /**
584
- * <p>The timestamp when the action was performed.</p>
585
- */
586
- TimeStamp?: Date;
587
-
588
- /**
589
- * <p>Indicates whether an activity is indirect or direct. An indirect activity results
590
- * from a direct activity performed on a parent resource. For example, sharing a parent
591
- * folder (the direct activity) shares all of the subfolders and documents within the
592
- * parent folder (the indirect activity).</p>
593
- */
594
- IsIndirectActivity?: boolean;
595
-
596
- /**
597
- * <p>The ID of the organization.</p>
598
- */
599
- OrganizationId?: string;
600
-
601
- /**
602
- * <p>The user who performed the action.</p>
603
- */
604
- Initiator?: UserMetadata;
605
-
606
- /**
607
- * <p>The list of users or groups impacted by this action. This is an optional field and
608
- * is filled for the following sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED,
609
- * DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED.</p>
610
- */
611
- Participants?: Participants;
612
-
613
- /**
614
- * <p>The metadata of the resource involved in the user action.</p>
615
- */
616
- ResourceMetadata?: ResourceMetadata;
617
-
618
- /**
619
- * <p>The original parent of the resource. This is an optional field and is filled for
620
- * move activities.</p>
621
- */
622
- OriginalParent?: ResourceMetadata;
623
-
624
- /**
625
- * <p>Metadata of the commenting activity. This is an optional field and is filled for
626
- * commenting activities.</p>
627
- */
628
- CommentMetadata?: CommentMetadata;
629
- }
630
-
631
- export namespace Activity {
632
- /**
633
- * @internal
634
- */
635
- export const filterSensitiveLog = (obj: Activity): any => ({
636
- ...obj,
637
- });
638
- }
639
-
640
- /**
641
- * <p>Set of options which defines notification preferences of given action.</p>
642
- */
643
- export interface NotificationOptions {
644
- /**
645
- * <p>Boolean value to indicate an email notification should be sent to the
646
- * receipients.</p>
647
- */
648
- SendEmail?: boolean;
649
-
650
- /**
651
- * <p>Text value to be included in the email body.</p>
652
- */
653
- EmailMessage?: string;
654
- }
655
-
656
- export namespace NotificationOptions {
657
- /**
658
- * @internal
659
- */
660
- export const filterSensitiveLog = (obj: NotificationOptions): any => ({
661
- ...obj,
662
- ...(obj.EmailMessage && { EmailMessage: SENSITIVE_STRING }),
663
- });
664
- }
665
-
666
- export enum RoleType {
667
- CONTRIBUTOR = "CONTRIBUTOR",
668
- COOWNER = "COOWNER",
669
- OWNER = "OWNER",
670
- VIEWER = "VIEWER",
671
- }
672
-
673
- export enum PrincipalType {
674
- ANONYMOUS = "ANONYMOUS",
675
- GROUP = "GROUP",
676
- INVITE = "INVITE",
677
- ORGANIZATION = "ORGANIZATION",
678
- USER = "USER",
679
- }
680
-
681
- /**
682
- * <p>Describes the recipient type and ID, if available.</p>
683
- */
684
- export interface SharePrincipal {
685
- /**
686
- * <p>The ID of the recipient.</p>
687
- */
688
- Id: string | undefined;
689
-
690
- /**
691
- * <p>The type of the recipient.</p>
692
- */
693
- Type: PrincipalType | string | undefined;
694
-
695
- /**
696
- * <p>The role of the recipient.</p>
697
- */
698
- Role: RoleType | string | undefined;
699
- }
700
-
701
- export namespace SharePrincipal {
702
- /**
703
- * @internal
704
- */
705
- export const filterSensitiveLog = (obj: SharePrincipal): any => ({
706
- ...obj,
707
- });
708
- }
709
-
710
- export interface AddResourcePermissionsRequest {
711
- /**
712
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
713
- */
714
- AuthenticationToken?: string;
715
-
716
- /**
717
- * <p>The ID of the resource.</p>
718
- */
719
- ResourceId: string | undefined;
720
-
721
- /**
722
- * <p>The users, groups, or organization being granted permission.</p>
723
- */
724
- Principals: SharePrincipal[] | undefined;
725
-
726
- /**
727
- * <p>The notification options.</p>
728
- */
729
- NotificationOptions?: NotificationOptions;
730
- }
731
-
732
- export namespace AddResourcePermissionsRequest {
733
- /**
734
- * @internal
735
- */
736
- export const filterSensitiveLog = (obj: AddResourcePermissionsRequest): any => ({
737
- ...obj,
738
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
739
- ...(obj.NotificationOptions && {
740
- NotificationOptions: NotificationOptions.filterSensitiveLog(obj.NotificationOptions),
741
- }),
742
- });
743
- }
744
-
745
- export enum ShareStatusType {
746
- FAILURE = "FAILURE",
747
- SUCCESS = "SUCCESS",
748
- }
749
-
750
- /**
751
- * <p>Describes the share results of a resource.</p>
752
- */
753
- export interface ShareResult {
754
- /**
755
- * <p>The ID of the principal.</p>
756
- */
757
- PrincipalId?: string;
758
-
759
- /**
760
- * <p>The ID of the invited user.</p>
761
- */
762
- InviteePrincipalId?: string;
763
-
764
- /**
765
- * <p>The role.</p>
766
- */
767
- Role?: RoleType | string;
768
-
769
- /**
770
- * <p>The status.</p>
771
- */
772
- Status?: ShareStatusType | string;
773
-
774
- /**
775
- * <p>The ID of the resource that was shared.</p>
776
- */
777
- ShareId?: string;
778
-
779
- /**
780
- * <p>The status message.</p>
781
- */
782
- StatusMessage?: string;
783
- }
784
-
785
- export namespace ShareResult {
786
- /**
787
- * @internal
788
- */
789
- export const filterSensitiveLog = (obj: ShareResult): any => ({
790
- ...obj,
791
- ...(obj.StatusMessage && { StatusMessage: SENSITIVE_STRING }),
792
- });
793
- }
794
-
795
- export interface AddResourcePermissionsResponse {
796
- /**
797
- * <p>The share results.</p>
798
- */
799
- ShareResults?: ShareResult[];
800
- }
801
-
802
- export namespace AddResourcePermissionsResponse {
803
- /**
804
- * @internal
805
- */
806
- export const filterSensitiveLog = (obj: AddResourcePermissionsResponse): any => ({
807
- ...obj,
808
- ...(obj.ShareResults && { ShareResults: obj.ShareResults.map((item) => ShareResult.filterSensitiveLog(item)) }),
809
- });
810
- }
811
-
812
- export enum CommentVisibilityType {
813
- PRIVATE = "PRIVATE",
814
- PUBLIC = "PUBLIC",
815
- }
816
-
817
- export interface CreateCommentRequest {
818
- /**
819
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
820
- */
821
- AuthenticationToken?: string;
822
-
823
- /**
824
- * <p>The ID of the document.</p>
825
- */
826
- DocumentId: string | undefined;
827
-
828
- /**
829
- * <p>The ID of the document version.</p>
830
- */
831
- VersionId: string | undefined;
832
-
833
- /**
834
- * <p>The ID of the parent comment.</p>
835
- */
836
- ParentId?: string;
837
-
838
- /**
839
- * <p>The ID of the root comment in the thread.</p>
840
- */
841
- ThreadId?: string;
842
-
843
- /**
844
- * <p>The text of the comment.</p>
845
- */
846
- Text: string | undefined;
847
-
848
- /**
849
- * <p>The visibility of the comment. Options are either PRIVATE, where the comment is
850
- * visible only to the comment author and document owner and co-owners, or PUBLIC, where
851
- * the comment is visible to document owners, co-owners, and contributors.</p>
852
- */
853
- Visibility?: CommentVisibilityType | string;
854
-
855
- /**
856
- * <p>Set this parameter to TRUE to send an email out to the document collaborators after
857
- * the comment is created.</p>
858
- */
859
- NotifyCollaborators?: boolean;
860
- }
861
-
862
- export namespace CreateCommentRequest {
863
- /**
864
- * @internal
865
- */
866
- export const filterSensitiveLog = (obj: CreateCommentRequest): any => ({
867
- ...obj,
868
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
869
- ...(obj.Text && { Text: SENSITIVE_STRING }),
870
- });
871
- }
872
-
873
- /**
874
- * <p>Describes a comment.</p>
875
- */
876
- export interface Comment {
877
- /**
878
- * <p>The ID of the comment.</p>
879
- */
880
- CommentId: string | undefined;
881
-
882
- /**
883
- * <p>The ID of the parent comment.</p>
884
- */
885
- ParentId?: string;
886
-
887
- /**
888
- * <p>The ID of the root comment in the thread.</p>
889
- */
890
- ThreadId?: string;
891
-
892
- /**
893
- * <p>The text of the comment.</p>
894
- */
895
- Text?: string;
896
-
897
- /**
898
- * <p>The details of the user who made the comment.</p>
899
- */
900
- Contributor?: User;
901
-
902
- /**
903
- * <p>The time that the comment was created.</p>
904
- */
905
- CreatedTimestamp?: Date;
906
-
907
- /**
908
- * <p>The status of the comment.</p>
909
- */
910
- Status?: CommentStatusType | string;
911
-
912
- /**
913
- * <p>The visibility of the comment. Options are either PRIVATE, where the comment is
914
- * visible only to the comment author and document owner and co-owners, or PUBLIC, where
915
- * the comment is visible to document owners, co-owners, and contributors.</p>
916
- */
917
- Visibility?: CommentVisibilityType | string;
918
-
919
- /**
920
- * <p>If the comment is a reply to another user's comment, this field contains the user
921
- * ID of the user being replied to.</p>
922
- */
923
- RecipientId?: string;
924
- }
925
-
926
- export namespace Comment {
927
- /**
928
- * @internal
929
- */
930
- export const filterSensitiveLog = (obj: Comment): any => ({
931
- ...obj,
932
- ...(obj.Text && { Text: SENSITIVE_STRING }),
933
- });
934
- }
935
-
936
- export interface CreateCommentResponse {
937
- /**
938
- * <p>The comment that has been created.</p>
939
- */
940
- Comment?: Comment;
941
- }
942
-
943
- export namespace CreateCommentResponse {
944
- /**
945
- * @internal
946
- */
947
- export const filterSensitiveLog = (obj: CreateCommentResponse): any => ({
948
- ...obj,
949
- ...(obj.Comment && { Comment: Comment.filterSensitiveLog(obj.Comment) }),
950
- });
951
- }
952
-
953
- /**
954
- * <p>This exception is thrown when the document is locked for comments and user tries to
955
- * create or delete a comment on that document.</p>
956
- */
957
- export interface DocumentLockedForCommentsException extends __SmithyException, $MetadataBearer {
958
- name: "DocumentLockedForCommentsException";
959
- $fault: "client";
960
- Message?: string;
961
- }
962
-
963
- export namespace DocumentLockedForCommentsException {
964
- /**
965
- * @internal
966
- */
967
- export const filterSensitiveLog = (obj: DocumentLockedForCommentsException): any => ({
968
- ...obj,
969
- });
970
- }
971
-
972
- /**
973
- * <p>The requested operation is not allowed on the specified comment object.</p>
974
- */
975
- export interface InvalidCommentOperationException extends __SmithyException, $MetadataBearer {
976
- name: "InvalidCommentOperationException";
977
- $fault: "client";
978
- Message?: string;
979
- }
980
-
981
- export namespace InvalidCommentOperationException {
982
- /**
983
- * @internal
984
- */
985
- export const filterSensitiveLog = (obj: InvalidCommentOperationException): any => ({
986
- ...obj,
987
- });
988
- }
989
-
990
- export interface CreateCustomMetadataRequest {
991
- /**
992
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
993
- */
994
- AuthenticationToken?: string;
995
-
996
- /**
997
- * <p>The ID of the resource.</p>
998
- */
999
- ResourceId: string | undefined;
1000
-
1001
- /**
1002
- * <p>The ID of the version, if the custom metadata is being added to a document
1003
- * version.</p>
1004
- */
1005
- VersionId?: string;
1006
-
1007
- /**
1008
- * <p>Custom metadata in the form of name-value pairs.</p>
1009
- */
1010
- CustomMetadata: { [key: string]: string } | undefined;
1011
- }
1012
-
1013
- export namespace CreateCustomMetadataRequest {
1014
- /**
1015
- * @internal
1016
- */
1017
- export const filterSensitiveLog = (obj: CreateCustomMetadataRequest): any => ({
1018
- ...obj,
1019
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
1020
- });
1021
- }
1022
-
1023
- export interface CreateCustomMetadataResponse {}
1024
-
1025
- export namespace CreateCustomMetadataResponse {
1026
- /**
1027
- * @internal
1028
- */
1029
- export const filterSensitiveLog = (obj: CreateCustomMetadataResponse): any => ({
1030
- ...obj,
1031
- });
1032
- }
1033
-
1034
- /**
1035
- * <p>The limit has been reached on the number of custom properties for the specified
1036
- * resource.</p>
1037
- */
1038
- export interface CustomMetadataLimitExceededException extends __SmithyException, $MetadataBearer {
1039
- name: "CustomMetadataLimitExceededException";
1040
- $fault: "client";
1041
- Message?: string;
1042
- }
1043
-
1044
- export namespace CustomMetadataLimitExceededException {
1045
- /**
1046
- * @internal
1047
- */
1048
- export const filterSensitiveLog = (obj: CustomMetadataLimitExceededException): any => ({
1049
- ...obj,
1050
- });
1051
- }
1052
-
1053
- /**
1054
- * <p>Another operation is in progress on the resource that conflicts with the current operation.</p>
1055
- */
1056
- export interface ConflictingOperationException extends __SmithyException, $MetadataBearer {
1057
- name: "ConflictingOperationException";
1058
- $fault: "client";
1059
- Message?: string;
1060
- }
1061
-
1062
- export namespace ConflictingOperationException {
1063
- /**
1064
- * @internal
1065
- */
1066
- export const filterSensitiveLog = (obj: ConflictingOperationException): any => ({
1067
- ...obj,
1068
- });
1069
- }
1070
-
1071
- export interface CreateFolderRequest {
1072
- /**
1073
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1074
- */
1075
- AuthenticationToken?: string;
1076
-
1077
- /**
1078
- * <p>The name of the new folder.</p>
1079
- */
1080
- Name?: string;
1081
-
1082
- /**
1083
- * <p>The ID of the parent folder.</p>
1084
- */
1085
- ParentFolderId: string | undefined;
1086
- }
1087
-
1088
- export namespace CreateFolderRequest {
1089
- /**
1090
- * @internal
1091
- */
1092
- export const filterSensitiveLog = (obj: CreateFolderRequest): any => ({
1093
- ...obj,
1094
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
1095
- });
1096
- }
1097
-
1098
- export enum ResourceStateType {
1099
- ACTIVE = "ACTIVE",
1100
- RECYCLED = "RECYCLED",
1101
- RECYCLING = "RECYCLING",
1102
- RESTORING = "RESTORING",
1103
- }
1104
-
1105
- /**
1106
- * <p>Describes a folder.</p>
1107
- */
1108
- export interface FolderMetadata {
1109
- /**
1110
- * <p>The ID of the folder.</p>
1111
- */
1112
- Id?: string;
1113
-
1114
- /**
1115
- * <p>The name of the folder.</p>
1116
- */
1117
- Name?: string;
1118
-
1119
- /**
1120
- * <p>The ID of the creator.</p>
1121
- */
1122
- CreatorId?: string;
1123
-
1124
- /**
1125
- * <p>The ID of the parent folder.</p>
1126
- */
1127
- ParentFolderId?: string;
1128
-
1129
- /**
1130
- * <p>The time when the folder was created.</p>
1131
- */
1132
- CreatedTimestamp?: Date;
1133
-
1134
- /**
1135
- * <p>The time when the folder was updated.</p>
1136
- */
1137
- ModifiedTimestamp?: Date;
1138
-
1139
- /**
1140
- * <p>The resource state of the folder.</p>
1141
- */
1142
- ResourceState?: ResourceStateType | string;
1143
-
1144
- /**
1145
- * <p>The unique identifier created from the subfolders and documents of the
1146
- * folder.</p>
1147
- */
1148
- Signature?: string;
1149
-
1150
- /**
1151
- * <p>List of labels on the folder.</p>
1152
- */
1153
- Labels?: string[];
1154
-
1155
- /**
1156
- * <p>The size of the folder metadata.</p>
1157
- */
1158
- Size?: number;
1159
-
1160
- /**
1161
- * <p>The size of the latest version of the folder metadata.</p>
1162
- */
1163
- LatestVersionSize?: number;
1164
- }
1165
-
1166
- export namespace FolderMetadata {
1167
- /**
1168
- * @internal
1169
- */
1170
- export const filterSensitiveLog = (obj: FolderMetadata): any => ({
1171
- ...obj,
1172
- });
1173
- }
1174
-
1175
- export interface CreateFolderResponse {
1176
- /**
1177
- * <p>The metadata of the folder.</p>
1178
- */
1179
- Metadata?: FolderMetadata;
1180
- }
1181
-
1182
- export namespace CreateFolderResponse {
1183
- /**
1184
- * @internal
1185
- */
1186
- export const filterSensitiveLog = (obj: CreateFolderResponse): any => ({
1187
- ...obj,
1188
- });
1189
- }
1190
-
1191
- /**
1192
- * <p>The resource already exists.</p>
1193
- */
1194
- export interface EntityAlreadyExistsException extends __SmithyException, $MetadataBearer {
1195
- name: "EntityAlreadyExistsException";
1196
- $fault: "client";
1197
- Message?: string;
1198
- }
1199
-
1200
- export namespace EntityAlreadyExistsException {
1201
- /**
1202
- * @internal
1203
- */
1204
- export const filterSensitiveLog = (obj: EntityAlreadyExistsException): any => ({
1205
- ...obj,
1206
- });
1207
- }
1208
-
1209
- /**
1210
- * <p>The maximum of 100,000 folders under the parent folder has been exceeded.</p>
1211
- */
1212
- export interface LimitExceededException extends __SmithyException, $MetadataBearer {
1213
- name: "LimitExceededException";
1214
- $fault: "client";
1215
- Message?: string;
1216
- }
1217
-
1218
- export namespace LimitExceededException {
1219
- /**
1220
- * @internal
1221
- */
1222
- export const filterSensitiveLog = (obj: LimitExceededException): any => ({
1223
- ...obj,
1224
- });
1225
- }
1226
-
1227
- export interface CreateLabelsRequest {
1228
- /**
1229
- * <p>The ID of the resource.</p>
1230
- */
1231
- ResourceId: string | undefined;
1232
-
1233
- /**
1234
- * <p>List of labels to add to the resource.</p>
1235
- */
1236
- Labels: string[] | undefined;
1237
-
1238
- /**
1239
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1240
- */
1241
- AuthenticationToken?: string;
1242
- }
1243
-
1244
- export namespace CreateLabelsRequest {
1245
- /**
1246
- * @internal
1247
- */
1248
- export const filterSensitiveLog = (obj: CreateLabelsRequest): any => ({
1249
- ...obj,
1250
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
1251
- });
1252
- }
1253
-
1254
- export interface CreateLabelsResponse {}
1255
-
1256
- export namespace CreateLabelsResponse {
1257
- /**
1258
- * @internal
1259
- */
1260
- export const filterSensitiveLog = (obj: CreateLabelsResponse): any => ({
1261
- ...obj,
1262
- });
1263
- }
1264
-
1265
- /**
1266
- * <p>The limit has been reached on the number of labels for the specified
1267
- * resource.</p>
1268
- */
1269
- export interface TooManyLabelsException extends __SmithyException, $MetadataBearer {
1270
- name: "TooManyLabelsException";
1271
- $fault: "client";
1272
- Message?: string;
1273
- }
1274
-
1275
- export namespace TooManyLabelsException {
1276
- /**
1277
- * @internal
1278
- */
1279
- export const filterSensitiveLog = (obj: TooManyLabelsException): any => ({
1280
- ...obj,
1281
- });
1282
- }
1283
-
1284
- export enum SubscriptionProtocolType {
1285
- HTTPS = "HTTPS",
1286
- }
1287
-
1288
- export enum SubscriptionType {
1289
- ALL = "ALL",
1290
- }
1291
-
1292
- export interface CreateNotificationSubscriptionRequest {
1293
- /**
1294
- * <p>The ID of the organization.</p>
1295
- */
1296
- OrganizationId: string | undefined;
1297
-
1298
- /**
1299
- * <p>The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint
1300
- * is a URL that begins with <code>https</code>.</p>
1301
- */
1302
- Endpoint: string | undefined;
1303
-
1304
- /**
1305
- * <p>The protocol to use. The supported value is https, which delivers JSON-encoded
1306
- * messages using HTTPS POST.</p>
1307
- */
1308
- Protocol: SubscriptionProtocolType | string | undefined;
1309
-
1310
- /**
1311
- * <p>The notification type.</p>
1312
- */
1313
- SubscriptionType: SubscriptionType | string | undefined;
1314
- }
1315
-
1316
- export namespace CreateNotificationSubscriptionRequest {
1317
- /**
1318
- * @internal
1319
- */
1320
- export const filterSensitiveLog = (obj: CreateNotificationSubscriptionRequest): any => ({
1321
- ...obj,
1322
- });
1323
- }
1324
-
1325
- /**
1326
- * <p>Describes a subscription.</p>
1327
- */
1328
- export interface Subscription {
1329
- /**
1330
- * <p>The ID of the subscription.</p>
1331
- */
1332
- SubscriptionId?: string;
1333
-
1334
- /**
1335
- * <p>The endpoint of the subscription.</p>
1336
- */
1337
- EndPoint?: string;
1338
-
1339
- /**
1340
- * <p>The protocol of the subscription.</p>
1341
- */
1342
- Protocol?: SubscriptionProtocolType | string;
1343
- }
1344
-
1345
- export namespace Subscription {
1346
- /**
1347
- * @internal
1348
- */
1349
- export const filterSensitiveLog = (obj: Subscription): any => ({
1350
- ...obj,
1351
- });
1352
- }
1353
-
1354
- export interface CreateNotificationSubscriptionResponse {
1355
- /**
1356
- * <p>The subscription.</p>
1357
- */
1358
- Subscription?: Subscription;
1359
- }
1360
-
1361
- export namespace CreateNotificationSubscriptionResponse {
1362
- /**
1363
- * @internal
1364
- */
1365
- export const filterSensitiveLog = (obj: CreateNotificationSubscriptionResponse): any => ({
1366
- ...obj,
1367
- });
1368
- }
1369
-
1370
- /**
1371
- * <p>You've reached the limit on the number of subscriptions for the WorkDocs
1372
- * instance.</p>
1373
- */
1374
- export interface TooManySubscriptionsException extends __SmithyException, $MetadataBearer {
1375
- name: "TooManySubscriptionsException";
1376
- $fault: "client";
1377
- Message?: string;
1378
- }
1379
-
1380
- export namespace TooManySubscriptionsException {
1381
- /**
1382
- * @internal
1383
- */
1384
- export const filterSensitiveLog = (obj: TooManySubscriptionsException): any => ({
1385
- ...obj,
1386
- });
1387
- }
1388
-
1389
- export interface CreateUserRequest {
1390
- /**
1391
- * <p>The ID of the organization.</p>
1392
- */
1393
- OrganizationId?: string;
1394
-
1395
- /**
1396
- * <p>The login name of the user.</p>
1397
- */
1398
- Username: string | undefined;
1399
-
1400
- /**
1401
- * <p>The email address of the user.</p>
1402
- */
1403
- EmailAddress?: string;
1404
-
1405
- /**
1406
- * <p>The given name of the user.</p>
1407
- */
1408
- GivenName: string | undefined;
1409
-
1410
- /**
1411
- * <p>The surname of the user.</p>
1412
- */
1413
- Surname: string | undefined;
1414
-
1415
- /**
1416
- * <p>The password of the user.</p>
1417
- */
1418
- Password: string | undefined;
1419
-
1420
- /**
1421
- * <p>The time zone ID of the user.</p>
1422
- */
1423
- TimeZoneId?: string;
1424
-
1425
- /**
1426
- * <p>The amount of storage for the user.</p>
1427
- */
1428
- StorageRule?: StorageRuleType;
1429
-
1430
- /**
1431
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1432
- */
1433
- AuthenticationToken?: string;
1434
- }
1435
-
1436
- export namespace CreateUserRequest {
1437
- /**
1438
- * @internal
1439
- */
1440
- export const filterSensitiveLog = (obj: CreateUserRequest): any => ({
1441
- ...obj,
1442
- ...(obj.Password && { Password: SENSITIVE_STRING }),
1443
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
1444
- });
1445
- }
1446
-
1447
- export interface CreateUserResponse {
1448
- /**
1449
- * <p>The user information.</p>
1450
- */
1451
- User?: User;
1452
- }
1453
-
1454
- export namespace CreateUserResponse {
1455
- /**
1456
- * @internal
1457
- */
1458
- export const filterSensitiveLog = (obj: CreateUserResponse): any => ({
1459
- ...obj,
1460
- });
1461
- }
1462
-
1463
- export interface DeactivateUserRequest {
1464
- /**
1465
- * <p>The ID of the user.</p>
1466
- */
1467
- UserId: string | undefined;
1468
-
1469
- /**
1470
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1471
- */
1472
- AuthenticationToken?: string;
1473
- }
1474
-
1475
- export namespace DeactivateUserRequest {
1476
- /**
1477
- * @internal
1478
- */
1479
- export const filterSensitiveLog = (obj: DeactivateUserRequest): any => ({
1480
- ...obj,
1481
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
1482
- });
1483
- }
1484
-
1485
- export interface DeleteCommentRequest {
1486
- /**
1487
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1488
- */
1489
- AuthenticationToken?: string;
1490
-
1491
- /**
1492
- * <p>The ID of the document.</p>
1493
- */
1494
- DocumentId: string | undefined;
1495
-
1496
- /**
1497
- * <p>The ID of the document version.</p>
1498
- */
1499
- VersionId: string | undefined;
1500
-
1501
- /**
1502
- * <p>The ID of the comment.</p>
1503
- */
1504
- CommentId: string | undefined;
1505
- }
1506
-
1507
- export namespace DeleteCommentRequest {
1508
- /**
1509
- * @internal
1510
- */
1511
- export const filterSensitiveLog = (obj: DeleteCommentRequest): any => ({
1512
- ...obj,
1513
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
1514
- });
1515
- }
1516
-
1517
- export interface DeleteCustomMetadataRequest {
1518
- /**
1519
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1520
- */
1521
- AuthenticationToken?: string;
1522
-
1523
- /**
1524
- * <p>The ID of the resource, either a document or folder.</p>
1525
- */
1526
- ResourceId: string | undefined;
1527
-
1528
- /**
1529
- * <p>The ID of the version, if the custom metadata is being deleted from a document
1530
- * version.</p>
1531
- */
1532
- VersionId?: string;
1533
-
1534
- /**
1535
- * <p>List of properties to remove.</p>
1536
- */
1537
- Keys?: string[];
1538
-
1539
- /**
1540
- * <p>Flag to indicate removal of all custom metadata properties from the specified
1541
- * resource.</p>
1542
- */
1543
- DeleteAll?: boolean;
1544
- }
1545
-
1546
- export namespace DeleteCustomMetadataRequest {
1547
- /**
1548
- * @internal
1549
- */
1550
- export const filterSensitiveLog = (obj: DeleteCustomMetadataRequest): any => ({
1551
- ...obj,
1552
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
1553
- });
1554
- }
1555
-
1556
- export interface DeleteCustomMetadataResponse {}
1557
-
1558
- export namespace DeleteCustomMetadataResponse {
1559
- /**
1560
- * @internal
1561
- */
1562
- export const filterSensitiveLog = (obj: DeleteCustomMetadataResponse): any => ({
1563
- ...obj,
1564
- });
1565
- }
1566
-
1567
- /**
1568
- * <p>The resource hierarchy is changing.</p>
1569
- */
1570
- export interface ConcurrentModificationException extends __SmithyException, $MetadataBearer {
1571
- name: "ConcurrentModificationException";
1572
- $fault: "client";
1573
- Message?: string;
1574
- }
1575
-
1576
- export namespace ConcurrentModificationException {
1577
- /**
1578
- * @internal
1579
- */
1580
- export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({
1581
- ...obj,
1582
- });
1583
- }
1584
-
1585
- export interface DeleteDocumentRequest {
1586
- /**
1587
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1588
- */
1589
- AuthenticationToken?: string;
1590
-
1591
- /**
1592
- * <p>The ID of the document.</p>
1593
- */
1594
- DocumentId: string | undefined;
1595
- }
1596
-
1597
- export namespace DeleteDocumentRequest {
1598
- /**
1599
- * @internal
1600
- */
1601
- export const filterSensitiveLog = (obj: DeleteDocumentRequest): any => ({
1602
- ...obj,
1603
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
1604
- });
1605
- }
1606
-
1607
- export interface DeleteFolderRequest {
1608
- /**
1609
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1610
- */
1611
- AuthenticationToken?: string;
1612
-
1613
- /**
1614
- * <p>The ID of the folder.</p>
1615
- */
1616
- FolderId: string | undefined;
1617
- }
1618
-
1619
- export namespace DeleteFolderRequest {
1620
- /**
1621
- * @internal
1622
- */
1623
- export const filterSensitiveLog = (obj: DeleteFolderRequest): any => ({
1624
- ...obj,
1625
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
1626
- });
1627
- }
1628
-
1629
- export interface DeleteFolderContentsRequest {
1630
- /**
1631
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1632
- */
1633
- AuthenticationToken?: string;
1634
-
1635
- /**
1636
- * <p>The ID of the folder.</p>
1637
- */
1638
- FolderId: string | undefined;
1639
- }
1640
-
1641
- export namespace DeleteFolderContentsRequest {
1642
- /**
1643
- * @internal
1644
- */
1645
- export const filterSensitiveLog = (obj: DeleteFolderContentsRequest): any => ({
1646
- ...obj,
1647
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
1648
- });
1649
- }
1650
-
1651
- export interface DeleteLabelsRequest {
1652
- /**
1653
- * <p>The ID of the resource.</p>
1654
- */
1655
- ResourceId: string | undefined;
1656
-
1657
- /**
1658
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1659
- */
1660
- AuthenticationToken?: string;
1661
-
1662
- /**
1663
- * <p>List of labels to delete from the resource.</p>
1664
- */
1665
- Labels?: string[];
1666
-
1667
- /**
1668
- * <p>Flag to request removal of all labels from the specified resource.</p>
1669
- */
1670
- DeleteAll?: boolean;
1671
- }
1672
-
1673
- export namespace DeleteLabelsRequest {
1674
- /**
1675
- * @internal
1676
- */
1677
- export const filterSensitiveLog = (obj: DeleteLabelsRequest): any => ({
1678
- ...obj,
1679
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
1680
- });
1681
- }
1682
-
1683
- export interface DeleteLabelsResponse {}
1684
-
1685
- export namespace DeleteLabelsResponse {
1686
- /**
1687
- * @internal
1688
- */
1689
- export const filterSensitiveLog = (obj: DeleteLabelsResponse): any => ({
1690
- ...obj,
1691
- });
1692
- }
1693
-
1694
- export interface DeleteNotificationSubscriptionRequest {
1695
- /**
1696
- * <p>The ID of the subscription.</p>
1697
- */
1698
- SubscriptionId: string | undefined;
1699
-
1700
- /**
1701
- * <p>The ID of the organization.</p>
1702
- */
1703
- OrganizationId: string | undefined;
1704
- }
1705
-
1706
- export namespace DeleteNotificationSubscriptionRequest {
1707
- /**
1708
- * @internal
1709
- */
1710
- export const filterSensitiveLog = (obj: DeleteNotificationSubscriptionRequest): any => ({
1711
- ...obj,
1712
- });
1713
- }
1714
-
1715
- export interface DeleteUserRequest {
1716
- /**
1717
- * <p>Amazon WorkDocs authentication token. Do not set this field when using
1718
- * administrative API actions, as in accessing the API using AWS credentials.</p>
1719
- */
1720
- AuthenticationToken?: string;
1721
-
1722
- /**
1723
- * <p>The ID of the user.</p>
1724
- */
1725
- UserId: string | undefined;
1726
- }
1727
-
1728
- export namespace DeleteUserRequest {
1729
- /**
1730
- * @internal
1731
- */
1732
- export const filterSensitiveLog = (obj: DeleteUserRequest): any => ({
1733
- ...obj,
1734
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
1735
- });
1736
- }
1737
-
1738
- export interface DescribeActivitiesRequest {
1739
- /**
1740
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1741
- */
1742
- AuthenticationToken?: string;
1743
-
1744
- /**
1745
- * <p>The timestamp that determines the starting time of the activities. The response
1746
- * includes the activities performed after the specified timestamp.</p>
1747
- */
1748
- StartTime?: Date;
1749
-
1750
- /**
1751
- * <p>The timestamp that determines the end time of the activities. The response includes
1752
- * the activities performed before the specified timestamp.</p>
1753
- */
1754
- EndTime?: Date;
1755
-
1756
- /**
1757
- * <p>The ID of the organization. This is a mandatory parameter when using administrative
1758
- * API (SigV4) requests.</p>
1759
- */
1760
- OrganizationId?: string;
1761
-
1762
- /**
1763
- * <p>Specifies which activity types to include in the response. If this field is left
1764
- * empty, all activity types are returned.</p>
1765
- */
1766
- ActivityTypes?: string;
1767
-
1768
- /**
1769
- * <p>The document or folder ID for which to describe activity types.</p>
1770
- */
1771
- ResourceId?: string;
1772
-
1773
- /**
1774
- * <p>The ID of the user who performed the action. The response includes activities
1775
- * pertaining to this user. This is an optional parameter and is only applicable for
1776
- * administrative API (SigV4) requests.</p>
1777
- */
1778
- UserId?: string;
1779
-
1780
- /**
1781
- * <p>Includes indirect activities. An indirect activity results from a direct activity
1782
- * performed on a parent resource. For example, sharing a parent folder (the direct
1783
- * activity) shares all of the subfolders and documents within the parent folder (the
1784
- * indirect activity).</p>
1785
- */
1786
- IncludeIndirectActivities?: boolean;
1787
-
1788
- /**
1789
- * <p>The maximum number of items to return.</p>
1790
- */
1791
- Limit?: number;
1792
-
1793
- /**
1794
- * <p>The marker for the next set of results.</p>
1795
- */
1796
- Marker?: string;
1797
- }
1798
-
1799
- export namespace DescribeActivitiesRequest {
1800
- /**
1801
- * @internal
1802
- */
1803
- export const filterSensitiveLog = (obj: DescribeActivitiesRequest): any => ({
1804
- ...obj,
1805
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
1806
- });
1807
- }
1808
-
1809
- export interface DescribeActivitiesResponse {
1810
- /**
1811
- * <p>The list of activities for the specified user and time period.</p>
1812
- */
1813
- UserActivities?: Activity[];
1814
-
1815
- /**
1816
- * <p>The marker for the next set of results.</p>
1817
- */
1818
- Marker?: string;
1819
- }
1820
-
1821
- export namespace DescribeActivitiesResponse {
1822
- /**
1823
- * @internal
1824
- */
1825
- export const filterSensitiveLog = (obj: DescribeActivitiesResponse): any => ({
1826
- ...obj,
1827
- });
1828
- }
1829
-
1830
- /**
1831
- * <p>The pagination marker or limit fields are not valid.</p>
1832
- */
1833
- export interface InvalidArgumentException extends __SmithyException, $MetadataBearer {
1834
- name: "InvalidArgumentException";
1835
- $fault: "client";
1836
- Message?: string;
1837
- }
1838
-
1839
- export namespace InvalidArgumentException {
1840
- /**
1841
- * @internal
1842
- */
1843
- export const filterSensitiveLog = (obj: InvalidArgumentException): any => ({
1844
- ...obj,
1845
- });
1846
- }
1847
-
1848
- export interface DescribeCommentsRequest {
1849
- /**
1850
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1851
- */
1852
- AuthenticationToken?: string;
1853
-
1854
- /**
1855
- * <p>The ID of the document.</p>
1856
- */
1857
- DocumentId: string | undefined;
1858
-
1859
- /**
1860
- * <p>The ID of the document version.</p>
1861
- */
1862
- VersionId: string | undefined;
1863
-
1864
- /**
1865
- * <p>The maximum number of items to return.</p>
1866
- */
1867
- Limit?: number;
1868
-
1869
- /**
1870
- * <p>The marker for the next set of results. This marker was received from a previous
1871
- * call.</p>
1872
- */
1873
- Marker?: string;
1874
- }
1875
-
1876
- export namespace DescribeCommentsRequest {
1877
- /**
1878
- * @internal
1879
- */
1880
- export const filterSensitiveLog = (obj: DescribeCommentsRequest): any => ({
1881
- ...obj,
1882
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
1883
- });
1884
- }
1885
-
1886
- export interface DescribeCommentsResponse {
1887
- /**
1888
- * <p>The list of comments for the specified document version.</p>
1889
- */
1890
- Comments?: Comment[];
1891
-
1892
- /**
1893
- * <p>The marker for the next set of results. This marker was received from a previous
1894
- * call.</p>
1895
- */
1896
- Marker?: string;
1897
- }
1898
-
1899
- export namespace DescribeCommentsResponse {
1900
- /**
1901
- * @internal
1902
- */
1903
- export const filterSensitiveLog = (obj: DescribeCommentsResponse): any => ({
1904
- ...obj,
1905
- ...(obj.Comments && { Comments: obj.Comments.map((item) => Comment.filterSensitiveLog(item)) }),
1906
- });
1907
- }
1908
-
1909
- export interface DescribeDocumentVersionsRequest {
1910
- /**
1911
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
1912
- */
1913
- AuthenticationToken?: string;
1914
-
1915
- /**
1916
- * <p>The ID of the document.</p>
1917
- */
1918
- DocumentId: string | undefined;
1919
-
1920
- /**
1921
- * <p>The marker for the next set of results. (You received this marker from a previous
1922
- * call.)</p>
1923
- */
1924
- Marker?: string;
1925
-
1926
- /**
1927
- * <p>The maximum number of versions to return with this call.</p>
1928
- */
1929
- Limit?: number;
1930
-
1931
- /**
1932
- * <p>A comma-separated list of values. Specify "INITIALIZED" to include incomplete
1933
- * versions.</p>
1934
- */
1935
- Include?: string;
1936
-
1937
- /**
1938
- * <p>Specify "SOURCE" to include initialized versions and a URL for the source
1939
- * document.</p>
1940
- */
1941
- Fields?: string;
1942
- }
1943
-
1944
- export namespace DescribeDocumentVersionsRequest {
1945
- /**
1946
- * @internal
1947
- */
1948
- export const filterSensitiveLog = (obj: DescribeDocumentVersionsRequest): any => ({
1949
- ...obj,
1950
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
1951
- });
1952
- }
1953
-
1954
- export enum DocumentSourceType {
1955
- ORIGINAL = "ORIGINAL",
1956
- WITH_COMMENTS = "WITH_COMMENTS",
1957
- }
1958
-
1959
- export enum DocumentStatusType {
1960
- ACTIVE = "ACTIVE",
1961
- INITIALIZED = "INITIALIZED",
1962
- }
1963
-
1964
- export enum DocumentThumbnailType {
1965
- LARGE = "LARGE",
1966
- SMALL = "SMALL",
1967
- SMALL_HQ = "SMALL_HQ",
1968
- }
1969
-
1970
- /**
1971
- * <p>Describes a version of a document.</p>
1972
- */
1973
- export interface DocumentVersionMetadata {
1974
- /**
1975
- * <p>The ID of the version.</p>
1976
- */
1977
- Id?: string;
1978
-
1979
- /**
1980
- * <p>The name of the version.</p>
1981
- */
1982
- Name?: string;
1983
-
1984
- /**
1985
- * <p>The content type of the document.</p>
1986
- */
1987
- ContentType?: string;
1988
-
1989
- /**
1990
- * <p>The size of the document, in bytes.</p>
1991
- */
1992
- Size?: number;
1993
-
1994
- /**
1995
- * <p>The signature of the document.</p>
1996
- */
1997
- Signature?: string;
1998
-
1999
- /**
2000
- * <p>The status of the document.</p>
2001
- */
2002
- Status?: DocumentStatusType | string;
2003
-
2004
- /**
2005
- * <p>The timestamp when the document was first uploaded.</p>
2006
- */
2007
- CreatedTimestamp?: Date;
2008
-
2009
- /**
2010
- * <p>The timestamp when the document was last uploaded.</p>
2011
- */
2012
- ModifiedTimestamp?: Date;
2013
-
2014
- /**
2015
- * <p>The timestamp when the content of the document was originally created.</p>
2016
- */
2017
- ContentCreatedTimestamp?: Date;
2018
-
2019
- /**
2020
- * <p>The timestamp when the content of the document was modified.</p>
2021
- */
2022
- ContentModifiedTimestamp?: Date;
2023
-
2024
- /**
2025
- * <p>The ID of the creator.</p>
2026
- */
2027
- CreatorId?: string;
2028
-
2029
- /**
2030
- * <p>The thumbnail of the document.</p>
2031
- */
2032
- Thumbnail?: { [key: string]: string };
2033
-
2034
- /**
2035
- * <p>The source of the document.</p>
2036
- */
2037
- Source?: { [key: string]: string };
2038
- }
2039
-
2040
- export namespace DocumentVersionMetadata {
2041
- /**
2042
- * @internal
2043
- */
2044
- export const filterSensitiveLog = (obj: DocumentVersionMetadata): any => ({
2045
- ...obj,
2046
- ...(obj.Thumbnail && { Thumbnail: SENSITIVE_STRING }),
2047
- ...(obj.Source && { Source: SENSITIVE_STRING }),
2048
- });
2049
- }
2050
-
2051
- export interface DescribeDocumentVersionsResponse {
2052
- /**
2053
- * <p>The document versions.</p>
2054
- */
2055
- DocumentVersions?: DocumentVersionMetadata[];
2056
-
2057
- /**
2058
- * <p>The marker to use when requesting the next set of results. If there are no
2059
- * additional results, the string is empty.</p>
2060
- */
2061
- Marker?: string;
2062
- }
2063
-
2064
- export namespace DescribeDocumentVersionsResponse {
2065
- /**
2066
- * @internal
2067
- */
2068
- export const filterSensitiveLog = (obj: DescribeDocumentVersionsResponse): any => ({
2069
- ...obj,
2070
- ...(obj.DocumentVersions && {
2071
- DocumentVersions: obj.DocumentVersions.map((item) => DocumentVersionMetadata.filterSensitiveLog(item)),
2072
- }),
2073
- });
2074
- }
2075
-
2076
- export enum OrderType {
2077
- ASCENDING = "ASCENDING",
2078
- DESCENDING = "DESCENDING",
2079
- }
2080
-
2081
- export enum ResourceSortType {
2082
- DATE = "DATE",
2083
- NAME = "NAME",
2084
- }
2085
-
2086
- export enum FolderContentType {
2087
- ALL = "ALL",
2088
- DOCUMENT = "DOCUMENT",
2089
- FOLDER = "FOLDER",
2090
- }
2091
-
2092
- export interface DescribeFolderContentsRequest {
2093
- /**
2094
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
2095
- */
2096
- AuthenticationToken?: string;
2097
-
2098
- /**
2099
- * <p>The ID of the folder.</p>
2100
- */
2101
- FolderId: string | undefined;
2102
-
2103
- /**
2104
- * <p>The sorting criteria.</p>
2105
- */
2106
- Sort?: ResourceSortType | string;
2107
-
2108
- /**
2109
- * <p>The order for the contents of the folder.</p>
2110
- */
2111
- Order?: OrderType | string;
2112
-
2113
- /**
2114
- * <p>The maximum number of items to return with this call.</p>
2115
- */
2116
- Limit?: number;
2117
-
2118
- /**
2119
- * <p>The marker for the next set of results. This marker was received from a previous
2120
- * call.</p>
2121
- */
2122
- Marker?: string;
2123
-
2124
- /**
2125
- * <p>The type of items.</p>
2126
- */
2127
- Type?: FolderContentType | string;
2128
-
2129
- /**
2130
- * <p>The contents to include. Specify "INITIALIZED" to include initialized
2131
- * documents.</p>
2132
- */
2133
- Include?: string;
2134
- }
2135
-
2136
- export namespace DescribeFolderContentsRequest {
2137
- /**
2138
- * @internal
2139
- */
2140
- export const filterSensitiveLog = (obj: DescribeFolderContentsRequest): any => ({
2141
- ...obj,
2142
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
2143
- });
2144
- }
2145
-
2146
- /**
2147
- * <p>Describes the document.</p>
2148
- */
2149
- export interface DocumentMetadata {
2150
- /**
2151
- * <p>The ID of the document.</p>
2152
- */
2153
- Id?: string;
2154
-
2155
- /**
2156
- * <p>The ID of the creator.</p>
2157
- */
2158
- CreatorId?: string;
2159
-
2160
- /**
2161
- * <p>The ID of the parent folder.</p>
2162
- */
2163
- ParentFolderId?: string;
2164
-
2165
- /**
2166
- * <p>The time when the document was created.</p>
2167
- */
2168
- CreatedTimestamp?: Date;
2169
-
2170
- /**
2171
- * <p>The time when the document was updated.</p>
2172
- */
2173
- ModifiedTimestamp?: Date;
2174
-
2175
- /**
2176
- * <p>The latest version of the document.</p>
2177
- */
2178
- LatestVersionMetadata?: DocumentVersionMetadata;
2179
-
2180
- /**
2181
- * <p>The resource state.</p>
2182
- */
2183
- ResourceState?: ResourceStateType | string;
2184
-
2185
- /**
2186
- * <p>List of labels on the document.</p>
2187
- */
2188
- Labels?: string[];
2189
- }
2190
-
2191
- export namespace DocumentMetadata {
2192
- /**
2193
- * @internal
2194
- */
2195
- export const filterSensitiveLog = (obj: DocumentMetadata): any => ({
2196
- ...obj,
2197
- ...(obj.LatestVersionMetadata && {
2198
- LatestVersionMetadata: DocumentVersionMetadata.filterSensitiveLog(obj.LatestVersionMetadata),
2199
- }),
2200
- });
2201
- }
2202
-
2203
- export interface DescribeFolderContentsResponse {
2204
- /**
2205
- * <p>The subfolders in the specified folder.</p>
2206
- */
2207
- Folders?: FolderMetadata[];
2208
-
2209
- /**
2210
- * <p>The documents in the specified folder.</p>
2211
- */
2212
- Documents?: DocumentMetadata[];
2213
-
2214
- /**
2215
- * <p>The marker to use when requesting the next set of results. If there are no
2216
- * additional results, the string is empty.</p>
2217
- */
2218
- Marker?: string;
2219
- }
2220
-
2221
- export namespace DescribeFolderContentsResponse {
2222
- /**
2223
- * @internal
2224
- */
2225
- export const filterSensitiveLog = (obj: DescribeFolderContentsResponse): any => ({
2226
- ...obj,
2227
- ...(obj.Documents && { Documents: obj.Documents.map((item) => DocumentMetadata.filterSensitiveLog(item)) }),
2228
- });
2229
- }
2230
-
2231
- export interface DescribeGroupsRequest {
2232
- /**
2233
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
2234
- */
2235
- AuthenticationToken?: string;
2236
-
2237
- /**
2238
- * <p>A query to describe groups by group name.</p>
2239
- */
2240
- SearchQuery: string | undefined;
2241
-
2242
- /**
2243
- * <p>The ID of the organization.</p>
2244
- */
2245
- OrganizationId?: string;
2246
-
2247
- /**
2248
- * <p>The marker for the next set of results. (You received this marker from a previous
2249
- * call.)</p>
2250
- */
2251
- Marker?: string;
2252
-
2253
- /**
2254
- * <p>The maximum number of items to return with this call.</p>
2255
- */
2256
- Limit?: number;
2257
- }
2258
-
2259
- export namespace DescribeGroupsRequest {
2260
- /**
2261
- * @internal
2262
- */
2263
- export const filterSensitiveLog = (obj: DescribeGroupsRequest): any => ({
2264
- ...obj,
2265
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
2266
- ...(obj.SearchQuery && { SearchQuery: SENSITIVE_STRING }),
2267
- });
2268
- }
2269
-
2270
- export interface DescribeGroupsResponse {
2271
- /**
2272
- * <p>The list of groups.</p>
2273
- */
2274
- Groups?: GroupMetadata[];
2275
-
2276
- /**
2277
- * <p>The marker to use when requesting the next set of results. If there are no additional
2278
- * results, the string is empty.</p>
2279
- */
2280
- Marker?: string;
2281
- }
2282
-
2283
- export namespace DescribeGroupsResponse {
2284
- /**
2285
- * @internal
2286
- */
2287
- export const filterSensitiveLog = (obj: DescribeGroupsResponse): any => ({
2288
- ...obj,
2289
- });
2290
- }
2291
-
2292
- export interface DescribeNotificationSubscriptionsRequest {
2293
- /**
2294
- * <p>The ID of the organization.</p>
2295
- */
2296
- OrganizationId: string | undefined;
2297
-
2298
- /**
2299
- * <p>The marker for the next set of results. (You received this marker from a previous
2300
- * call.)</p>
2301
- */
2302
- Marker?: string;
2303
-
2304
- /**
2305
- * <p>The maximum number of items to return with this call.</p>
2306
- */
2307
- Limit?: number;
2308
- }
2309
-
2310
- export namespace DescribeNotificationSubscriptionsRequest {
2311
- /**
2312
- * @internal
2313
- */
2314
- export const filterSensitiveLog = (obj: DescribeNotificationSubscriptionsRequest): any => ({
2315
- ...obj,
2316
- });
2317
- }
2318
-
2319
- export interface DescribeNotificationSubscriptionsResponse {
2320
- /**
2321
- * <p>The subscriptions.</p>
2322
- */
2323
- Subscriptions?: Subscription[];
2324
-
2325
- /**
2326
- * <p>The marker to use when requesting the next set of results. If there are no
2327
- * additional results, the string is empty.</p>
2328
- */
2329
- Marker?: string;
2330
- }
2331
-
2332
- export namespace DescribeNotificationSubscriptionsResponse {
2333
- /**
2334
- * @internal
2335
- */
2336
- export const filterSensitiveLog = (obj: DescribeNotificationSubscriptionsResponse): any => ({
2337
- ...obj,
2338
- });
2339
- }
2340
-
2341
- export interface DescribeResourcePermissionsRequest {
2342
- /**
2343
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
2344
- */
2345
- AuthenticationToken?: string;
2346
-
2347
- /**
2348
- * <p>The ID of the resource.</p>
2349
- */
2350
- ResourceId: string | undefined;
2351
-
2352
- /**
2353
- * <p>The ID of the principal to filter permissions by.</p>
2354
- */
2355
- PrincipalId?: string;
2356
-
2357
- /**
2358
- * <p>The maximum number of items to return with this call.</p>
2359
- */
2360
- Limit?: number;
2361
-
2362
- /**
2363
- * <p>The marker for the next set of results. (You received this marker from a previous
2364
- * call)</p>
2365
- */
2366
- Marker?: string;
2367
- }
2368
-
2369
- export namespace DescribeResourcePermissionsRequest {
2370
- /**
2371
- * @internal
2372
- */
2373
- export const filterSensitiveLog = (obj: DescribeResourcePermissionsRequest): any => ({
2374
- ...obj,
2375
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
2376
- });
2377
- }
2378
-
2379
- export enum RolePermissionType {
2380
- DIRECT = "DIRECT",
2381
- INHERITED = "INHERITED",
2382
- }
2383
-
2384
- /**
2385
- * <p>Describes the permissions.</p>
2386
- */
2387
- export interface PermissionInfo {
2388
- /**
2389
- * <p>The role of the user.</p>
2390
- */
2391
- Role?: RoleType | string;
2392
-
2393
- /**
2394
- * <p>The type of permissions.</p>
2395
- */
2396
- Type?: RolePermissionType | string;
2397
- }
2398
-
2399
- export namespace PermissionInfo {
2400
- /**
2401
- * @internal
2402
- */
2403
- export const filterSensitiveLog = (obj: PermissionInfo): any => ({
2404
- ...obj,
2405
- });
2406
- }
2407
-
2408
- /**
2409
- * <p>Describes a resource.</p>
2410
- */
2411
- export interface Principal {
2412
- /**
2413
- * <p>The ID of the resource.</p>
2414
- */
2415
- Id?: string;
2416
-
2417
- /**
2418
- * <p>The type of resource.</p>
2419
- */
2420
- Type?: PrincipalType | string;
2421
-
2422
- /**
2423
- * <p>The permission information for the resource.</p>
2424
- */
2425
- Roles?: PermissionInfo[];
2426
- }
2427
-
2428
- export namespace Principal {
2429
- /**
2430
- * @internal
2431
- */
2432
- export const filterSensitiveLog = (obj: Principal): any => ({
2433
- ...obj,
2434
- });
2435
- }
2436
-
2437
- export interface DescribeResourcePermissionsResponse {
2438
- /**
2439
- * <p>The principals.</p>
2440
- */
2441
- Principals?: Principal[];
2442
-
2443
- /**
2444
- * <p>The marker to use when requesting the next set of results. If there are no
2445
- * additional results, the string is empty.</p>
2446
- */
2447
- Marker?: string;
2448
- }
2449
-
2450
- export namespace DescribeResourcePermissionsResponse {
2451
- /**
2452
- * @internal
2453
- */
2454
- export const filterSensitiveLog = (obj: DescribeResourcePermissionsResponse): any => ({
2455
- ...obj,
2456
- });
2457
- }
2458
-
2459
- export interface DescribeRootFoldersRequest {
2460
- /**
2461
- * <p>Amazon WorkDocs authentication token.</p>
2462
- */
2463
- AuthenticationToken: string | undefined;
2464
-
2465
- /**
2466
- * <p>The maximum number of items to return.</p>
2467
- */
2468
- Limit?: number;
2469
-
2470
- /**
2471
- * <p>The marker for the next set of results. (You received this marker from a previous
2472
- * call.)</p>
2473
- */
2474
- Marker?: string;
2475
- }
2476
-
2477
- export namespace DescribeRootFoldersRequest {
2478
- /**
2479
- * @internal
2480
- */
2481
- export const filterSensitiveLog = (obj: DescribeRootFoldersRequest): any => ({
2482
- ...obj,
2483
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
2484
- });
2485
- }
2486
-
2487
- export interface DescribeRootFoldersResponse {
2488
- /**
2489
- * <p>The user's special folders.</p>
2490
- */
2491
- Folders?: FolderMetadata[];
2492
-
2493
- /**
2494
- * <p>The marker for the next set of results.</p>
2495
- */
2496
- Marker?: string;
2497
- }
2498
-
2499
- export namespace DescribeRootFoldersResponse {
2500
- /**
2501
- * @internal
2502
- */
2503
- export const filterSensitiveLog = (obj: DescribeRootFoldersResponse): any => ({
2504
- ...obj,
2505
- });
2506
- }
2507
-
2508
- export enum UserFilterType {
2509
- ACTIVE_PENDING = "ACTIVE_PENDING",
2510
- ALL = "ALL",
2511
- }
2512
-
2513
- export enum UserSortType {
2514
- FULL_NAME = "FULL_NAME",
2515
- STORAGE_LIMIT = "STORAGE_LIMIT",
2516
- STORAGE_USED = "STORAGE_USED",
2517
- USER_NAME = "USER_NAME",
2518
- USER_STATUS = "USER_STATUS",
2519
- }
2520
-
2521
- export interface DescribeUsersRequest {
2522
- /**
2523
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
2524
- */
2525
- AuthenticationToken?: string;
2526
-
2527
- /**
2528
- * <p>The ID of the organization.</p>
2529
- */
2530
- OrganizationId?: string;
2531
-
2532
- /**
2533
- * <p>The IDs of the users.</p>
2534
- */
2535
- UserIds?: string;
2536
-
2537
- /**
2538
- * <p>A query to filter users by user name.</p>
2539
- */
2540
- Query?: string;
2541
-
2542
- /**
2543
- * <p>The state of the users. Specify "ALL" to include inactive users.</p>
2544
- */
2545
- Include?: UserFilterType | string;
2546
-
2547
- /**
2548
- * <p>The order for the results.</p>
2549
- */
2550
- Order?: OrderType | string;
2551
-
2552
- /**
2553
- * <p>The sorting criteria.</p>
2554
- */
2555
- Sort?: UserSortType | string;
2556
-
2557
- /**
2558
- * <p>The marker for the next set of results. (You received this marker from a previous
2559
- * call.)</p>
2560
- */
2561
- Marker?: string;
2562
-
2563
- /**
2564
- * <p>The maximum number of items to return.</p>
2565
- */
2566
- Limit?: number;
2567
-
2568
- /**
2569
- * <p>A comma-separated list of values. Specify "STORAGE_METADATA" to include the user
2570
- * storage quota and utilization information.</p>
2571
- */
2572
- Fields?: string;
2573
- }
2574
-
2575
- export namespace DescribeUsersRequest {
2576
- /**
2577
- * @internal
2578
- */
2579
- export const filterSensitiveLog = (obj: DescribeUsersRequest): any => ({
2580
- ...obj,
2581
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
2582
- ...(obj.Query && { Query: SENSITIVE_STRING }),
2583
- });
2584
- }
2585
-
2586
- export interface DescribeUsersResponse {
2587
- /**
2588
- * <p>The users.</p>
2589
- */
2590
- Users?: User[];
2591
-
2592
- /**
2593
- * @deprecated
2594
- *
2595
- * <p>The total number of users included in the results.</p>
2596
- */
2597
- TotalNumberOfUsers?: number;
2598
-
2599
- /**
2600
- * <p>The marker to use when requesting the next set of results. If there are no
2601
- * additional results, the string is empty.</p>
2602
- */
2603
- Marker?: string;
2604
- }
2605
-
2606
- export namespace DescribeUsersResponse {
2607
- /**
2608
- * @internal
2609
- */
2610
- export const filterSensitiveLog = (obj: DescribeUsersResponse): any => ({
2611
- ...obj,
2612
- });
2613
- }
2614
-
2615
- /**
2616
- * <p>The response is too large to return. The request must include a filter to reduce the size of the response.</p>
2617
- */
2618
- export interface RequestedEntityTooLargeException extends __SmithyException, $MetadataBearer {
2619
- name: "RequestedEntityTooLargeException";
2620
- $fault: "client";
2621
- Message?: string;
2622
- }
2623
-
2624
- export namespace RequestedEntityTooLargeException {
2625
- /**
2626
- * @internal
2627
- */
2628
- export const filterSensitiveLog = (obj: RequestedEntityTooLargeException): any => ({
2629
- ...obj,
2630
- });
2631
- }
2632
-
2633
- export interface GetCurrentUserRequest {
2634
- /**
2635
- * <p>Amazon WorkDocs authentication token.</p>
2636
- */
2637
- AuthenticationToken: string | undefined;
2638
- }
2639
-
2640
- export namespace GetCurrentUserRequest {
2641
- /**
2642
- * @internal
2643
- */
2644
- export const filterSensitiveLog = (obj: GetCurrentUserRequest): any => ({
2645
- ...obj,
2646
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
2647
- });
2648
- }
2649
-
2650
- export interface GetCurrentUserResponse {
2651
- /**
2652
- * <p>Metadata of the user.</p>
2653
- */
2654
- User?: User;
2655
- }
2656
-
2657
- export namespace GetCurrentUserResponse {
2658
- /**
2659
- * @internal
2660
- */
2661
- export const filterSensitiveLog = (obj: GetCurrentUserResponse): any => ({
2662
- ...obj,
2663
- });
2664
- }
2665
-
2666
- export interface GetDocumentRequest {
2667
- /**
2668
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
2669
- */
2670
- AuthenticationToken?: string;
2671
-
2672
- /**
2673
- * <p>The ID of the document.</p>
2674
- */
2675
- DocumentId: string | undefined;
2676
-
2677
- /**
2678
- * <p>Set this to <code>TRUE</code> to include custom metadata in the response.</p>
2679
- */
2680
- IncludeCustomMetadata?: boolean;
2681
- }
2682
-
2683
- export namespace GetDocumentRequest {
2684
- /**
2685
- * @internal
2686
- */
2687
- export const filterSensitiveLog = (obj: GetDocumentRequest): any => ({
2688
- ...obj,
2689
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
2690
- });
2691
- }
2692
-
2693
- export interface GetDocumentResponse {
2694
- /**
2695
- * <p>The metadata details of the document.</p>
2696
- */
2697
- Metadata?: DocumentMetadata;
2698
-
2699
- /**
2700
- * <p>The custom metadata on the document.</p>
2701
- */
2702
- CustomMetadata?: { [key: string]: string };
2703
- }
2704
-
2705
- export namespace GetDocumentResponse {
2706
- /**
2707
- * @internal
2708
- */
2709
- export const filterSensitiveLog = (obj: GetDocumentResponse): any => ({
2710
- ...obj,
2711
- ...(obj.Metadata && { Metadata: DocumentMetadata.filterSensitiveLog(obj.Metadata) }),
2712
- });
2713
- }
2714
-
2715
- /**
2716
- * <p>The password is invalid.</p>
2717
- */
2718
- export interface InvalidPasswordException extends __SmithyException, $MetadataBearer {
2719
- name: "InvalidPasswordException";
2720
- $fault: "client";
2721
- Message?: string;
2722
- }
2723
-
2724
- export namespace InvalidPasswordException {
2725
- /**
2726
- * @internal
2727
- */
2728
- export const filterSensitiveLog = (obj: InvalidPasswordException): any => ({
2729
- ...obj,
2730
- });
2731
- }
2732
-
2733
- export interface GetDocumentPathRequest {
2734
- /**
2735
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
2736
- */
2737
- AuthenticationToken?: string;
2738
-
2739
- /**
2740
- * <p>The ID of the document.</p>
2741
- */
2742
- DocumentId: string | undefined;
2743
-
2744
- /**
2745
- * <p>The maximum number of levels in the hierarchy to return.</p>
2746
- */
2747
- Limit?: number;
2748
-
2749
- /**
2750
- * <p>A comma-separated list of values. Specify <code>NAME</code> to include the names of
2751
- * the parent folders.</p>
2752
- */
2753
- Fields?: string;
2754
-
2755
- /**
2756
- * <p>This value is not supported.</p>
2757
- */
2758
- Marker?: string;
2759
- }
2760
-
2761
- export namespace GetDocumentPathRequest {
2762
- /**
2763
- * @internal
2764
- */
2765
- export const filterSensitiveLog = (obj: GetDocumentPathRequest): any => ({
2766
- ...obj,
2767
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
2768
- });
2769
- }
2770
-
2771
- /**
2772
- * <p>Describes the resource path.</p>
2773
- */
2774
- export interface ResourcePathComponent {
2775
- /**
2776
- * <p>The ID of the resource path.</p>
2777
- */
2778
- Id?: string;
2779
-
2780
- /**
2781
- * <p>The name of the resource path.</p>
2782
- */
2783
- Name?: string;
2784
- }
2785
-
2786
- export namespace ResourcePathComponent {
2787
- /**
2788
- * @internal
2789
- */
2790
- export const filterSensitiveLog = (obj: ResourcePathComponent): any => ({
2791
- ...obj,
2792
- });
2793
- }
2794
-
2795
- /**
2796
- * <p>Describes the path information of a resource.</p>
2797
- */
2798
- export interface ResourcePath {
2799
- /**
2800
- * <p>The components of the resource path.</p>
2801
- */
2802
- Components?: ResourcePathComponent[];
2803
- }
2804
-
2805
- export namespace ResourcePath {
2806
- /**
2807
- * @internal
2808
- */
2809
- export const filterSensitiveLog = (obj: ResourcePath): any => ({
2810
- ...obj,
2811
- });
2812
- }
2813
-
2814
- export interface GetDocumentPathResponse {
2815
- /**
2816
- * <p>The path information.</p>
2817
- */
2818
- Path?: ResourcePath;
2819
- }
2820
-
2821
- export namespace GetDocumentPathResponse {
2822
- /**
2823
- * @internal
2824
- */
2825
- export const filterSensitiveLog = (obj: GetDocumentPathResponse): any => ({
2826
- ...obj,
2827
- });
2828
- }
2829
-
2830
- export interface GetDocumentVersionRequest {
2831
- /**
2832
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
2833
- */
2834
- AuthenticationToken?: string;
2835
-
2836
- /**
2837
- * <p>The ID of the document.</p>
2838
- */
2839
- DocumentId: string | undefined;
2840
-
2841
- /**
2842
- * <p>The version ID of the document.</p>
2843
- */
2844
- VersionId: string | undefined;
2845
-
2846
- /**
2847
- * <p>A comma-separated list of values. Specify "SOURCE" to include a URL for the source
2848
- * document.</p>
2849
- */
2850
- Fields?: string;
2851
-
2852
- /**
2853
- * <p>Set this to TRUE to include custom metadata in the response.</p>
2854
- */
2855
- IncludeCustomMetadata?: boolean;
2856
- }
2857
-
2858
- export namespace GetDocumentVersionRequest {
2859
- /**
2860
- * @internal
2861
- */
2862
- export const filterSensitiveLog = (obj: GetDocumentVersionRequest): any => ({
2863
- ...obj,
2864
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
2865
- });
2866
- }
2867
-
2868
- export interface GetDocumentVersionResponse {
2869
- /**
2870
- * <p>The version metadata.</p>
2871
- */
2872
- Metadata?: DocumentVersionMetadata;
2873
-
2874
- /**
2875
- * <p>The custom metadata on the document version.</p>
2876
- */
2877
- CustomMetadata?: { [key: string]: string };
2878
- }
2879
-
2880
- export namespace GetDocumentVersionResponse {
2881
- /**
2882
- * @internal
2883
- */
2884
- export const filterSensitiveLog = (obj: GetDocumentVersionResponse): any => ({
2885
- ...obj,
2886
- ...(obj.Metadata && { Metadata: DocumentVersionMetadata.filterSensitiveLog(obj.Metadata) }),
2887
- });
2888
- }
2889
-
2890
- export interface GetFolderRequest {
2891
- /**
2892
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
2893
- */
2894
- AuthenticationToken?: string;
2895
-
2896
- /**
2897
- * <p>The ID of the folder.</p>
2898
- */
2899
- FolderId: string | undefined;
2900
-
2901
- /**
2902
- * <p>Set to TRUE to include custom metadata in the response.</p>
2903
- */
2904
- IncludeCustomMetadata?: boolean;
2905
- }
2906
-
2907
- export namespace GetFolderRequest {
2908
- /**
2909
- * @internal
2910
- */
2911
- export const filterSensitiveLog = (obj: GetFolderRequest): any => ({
2912
- ...obj,
2913
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
2914
- });
2915
- }
2916
-
2917
- export interface GetFolderResponse {
2918
- /**
2919
- * <p>The metadata of the folder.</p>
2920
- */
2921
- Metadata?: FolderMetadata;
2922
-
2923
- /**
2924
- * <p>The custom metadata on the folder.</p>
2925
- */
2926
- CustomMetadata?: { [key: string]: string };
2927
- }
2928
-
2929
- export namespace GetFolderResponse {
2930
- /**
2931
- * @internal
2932
- */
2933
- export const filterSensitiveLog = (obj: GetFolderResponse): any => ({
2934
- ...obj,
2935
- });
2936
- }
2937
-
2938
- export interface GetFolderPathRequest {
2939
- /**
2940
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
2941
- */
2942
- AuthenticationToken?: string;
2943
-
2944
- /**
2945
- * <p>The ID of the folder.</p>
2946
- */
2947
- FolderId: string | undefined;
2948
-
2949
- /**
2950
- * <p>The maximum number of levels in the hierarchy to return.</p>
2951
- */
2952
- Limit?: number;
2953
-
2954
- /**
2955
- * <p>A comma-separated list of values. Specify "NAME" to include the names of the parent
2956
- * folders.</p>
2957
- */
2958
- Fields?: string;
2959
-
2960
- /**
2961
- * <p>This value is not supported.</p>
2962
- */
2963
- Marker?: string;
2964
- }
2965
-
2966
- export namespace GetFolderPathRequest {
2967
- /**
2968
- * @internal
2969
- */
2970
- export const filterSensitiveLog = (obj: GetFolderPathRequest): any => ({
2971
- ...obj,
2972
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
2973
- });
2974
- }
2975
-
2976
- export interface GetFolderPathResponse {
2977
- /**
2978
- * <p>The path information.</p>
2979
- */
2980
- Path?: ResourcePath;
2981
- }
2982
-
2983
- export namespace GetFolderPathResponse {
2984
- /**
2985
- * @internal
2986
- */
2987
- export const filterSensitiveLog = (obj: GetFolderPathResponse): any => ({
2988
- ...obj,
2989
- });
2990
- }
2991
-
2992
- export enum ResourceCollectionType {
2993
- SHARED_WITH_ME = "SHARED_WITH_ME",
2994
- }
2995
-
2996
- export interface GetResourcesRequest {
2997
- /**
2998
- * <p>The Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
2999
- */
3000
- AuthenticationToken?: string;
3001
-
3002
- /**
3003
- * <p>The user ID for the resource collection. This is a required field for accessing the
3004
- * API operation using IAM credentials.</p>
3005
- */
3006
- UserId?: string;
3007
-
3008
- /**
3009
- * <p>The collection type.</p>
3010
- */
3011
- CollectionType?: ResourceCollectionType | string;
3012
-
3013
- /**
3014
- * <p>The maximum number of resources to return.</p>
3015
- */
3016
- Limit?: number;
3017
-
3018
- /**
3019
- * <p>The marker for the next set of results. This marker was received from a previous call.</p>
3020
- */
3021
- Marker?: string;
3022
- }
3023
-
3024
- export namespace GetResourcesRequest {
3025
- /**
3026
- * @internal
3027
- */
3028
- export const filterSensitiveLog = (obj: GetResourcesRequest): any => ({
3029
- ...obj,
3030
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
3031
- });
3032
- }
3033
-
3034
- export interface GetResourcesResponse {
3035
- /**
3036
- * <p>The folders in the specified folder.</p>
3037
- */
3038
- Folders?: FolderMetadata[];
3039
-
3040
- /**
3041
- * <p>The documents in the specified collection.</p>
3042
- */
3043
- Documents?: DocumentMetadata[];
3044
-
3045
- /**
3046
- * <p>The marker to use when requesting the next set of results. If there are no additional results, the string is empty.</p>
3047
- */
3048
- Marker?: string;
3049
- }
3050
-
3051
- export namespace GetResourcesResponse {
3052
- /**
3053
- * @internal
3054
- */
3055
- export const filterSensitiveLog = (obj: GetResourcesResponse): any => ({
3056
- ...obj,
3057
- ...(obj.Documents && { Documents: obj.Documents.map((item) => DocumentMetadata.filterSensitiveLog(item)) }),
3058
- });
3059
- }
3060
-
3061
- /**
3062
- * <p>This exception is thrown when a valid checkout ID is not presented on document
3063
- * version upload calls for a document that has been checked out from Web client.</p>
3064
- */
3065
- export interface DraftUploadOutOfSyncException extends __SmithyException, $MetadataBearer {
3066
- name: "DraftUploadOutOfSyncException";
3067
- $fault: "client";
3068
- Message?: string;
3069
- }
3070
-
3071
- export namespace DraftUploadOutOfSyncException {
3072
- /**
3073
- * @internal
3074
- */
3075
- export const filterSensitiveLog = (obj: DraftUploadOutOfSyncException): any => ({
3076
- ...obj,
3077
- });
3078
- }
3079
-
3080
- export interface InitiateDocumentVersionUploadRequest {
3081
- /**
3082
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
3083
- */
3084
- AuthenticationToken?: string;
3085
-
3086
- /**
3087
- * <p>The ID of the document.</p>
3088
- */
3089
- Id?: string;
3090
-
3091
- /**
3092
- * <p>The name of the document.</p>
3093
- */
3094
- Name?: string;
3095
-
3096
- /**
3097
- * <p>The timestamp when the content of the document was originally created.</p>
3098
- */
3099
- ContentCreatedTimestamp?: Date;
3100
-
3101
- /**
3102
- * <p>The timestamp when the content of the document was modified.</p>
3103
- */
3104
- ContentModifiedTimestamp?: Date;
3105
-
3106
- /**
3107
- * <p>The content type of the document.</p>
3108
- */
3109
- ContentType?: string;
3110
-
3111
- /**
3112
- * <p>The size of the document, in bytes.</p>
3113
- */
3114
- DocumentSizeInBytes?: number;
3115
-
3116
- /**
3117
- * <p>The ID of the parent folder.</p>
3118
- */
3119
- ParentFolderId: string | undefined;
3120
- }
3121
-
3122
- export namespace InitiateDocumentVersionUploadRequest {
3123
- /**
3124
- * @internal
3125
- */
3126
- export const filterSensitiveLog = (obj: InitiateDocumentVersionUploadRequest): any => ({
3127
- ...obj,
3128
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
3129
- });
3130
- }
3131
-
3132
- /**
3133
- * <p>Describes the upload.</p>
3134
- */
3135
- export interface UploadMetadata {
3136
- /**
3137
- * <p>The URL of the upload.</p>
3138
- */
3139
- UploadUrl?: string;
3140
-
3141
- /**
3142
- * <p>The signed headers.</p>
3143
- */
3144
- SignedHeaders?: { [key: string]: string };
3145
- }
3146
-
3147
- export namespace UploadMetadata {
3148
- /**
3149
- * @internal
3150
- */
3151
- export const filterSensitiveLog = (obj: UploadMetadata): any => ({
3152
- ...obj,
3153
- ...(obj.UploadUrl && { UploadUrl: SENSITIVE_STRING }),
3154
- });
3155
- }
3156
-
3157
- export interface InitiateDocumentVersionUploadResponse {
3158
- /**
3159
- * <p>The document metadata.</p>
3160
- */
3161
- Metadata?: DocumentMetadata;
3162
-
3163
- /**
3164
- * <p>The upload metadata.</p>
3165
- */
3166
- UploadMetadata?: UploadMetadata;
3167
- }
3168
-
3169
- export namespace InitiateDocumentVersionUploadResponse {
3170
- /**
3171
- * @internal
3172
- */
3173
- export const filterSensitiveLog = (obj: InitiateDocumentVersionUploadResponse): any => ({
3174
- ...obj,
3175
- ...(obj.Metadata && { Metadata: DocumentMetadata.filterSensitiveLog(obj.Metadata) }),
3176
- ...(obj.UploadMetadata && { UploadMetadata: UploadMetadata.filterSensitiveLog(obj.UploadMetadata) }),
3177
- });
3178
- }
3179
-
3180
- /**
3181
- * <p>The resource is already checked out.</p>
3182
- */
3183
- export interface ResourceAlreadyCheckedOutException extends __SmithyException, $MetadataBearer {
3184
- name: "ResourceAlreadyCheckedOutException";
3185
- $fault: "client";
3186
- Message?: string;
3187
- }
3188
-
3189
- export namespace ResourceAlreadyCheckedOutException {
3190
- /**
3191
- * @internal
3192
- */
3193
- export const filterSensitiveLog = (obj: ResourceAlreadyCheckedOutException): any => ({
3194
- ...obj,
3195
- });
3196
- }
3197
-
3198
- /**
3199
- * <p>The storage limit has been exceeded.</p>
3200
- */
3201
- export interface StorageLimitExceededException extends __SmithyException, $MetadataBearer {
3202
- name: "StorageLimitExceededException";
3203
- $fault: "client";
3204
- Message?: string;
3205
- }
3206
-
3207
- export namespace StorageLimitExceededException {
3208
- /**
3209
- * @internal
3210
- */
3211
- export const filterSensitiveLog = (obj: StorageLimitExceededException): any => ({
3212
- ...obj,
3213
- });
3214
- }
3215
-
3216
- /**
3217
- * <p>The storage limit will be exceeded.</p>
3218
- */
3219
- export interface StorageLimitWillExceedException extends __SmithyException, $MetadataBearer {
3220
- name: "StorageLimitWillExceedException";
3221
- $fault: "client";
3222
- Message?: string;
3223
- }
3224
-
3225
- export namespace StorageLimitWillExceedException {
3226
- /**
3227
- * @internal
3228
- */
3229
- export const filterSensitiveLog = (obj: StorageLimitWillExceedException): any => ({
3230
- ...obj,
3231
- });
3232
- }
3233
-
3234
- export interface RemoveAllResourcePermissionsRequest {
3235
- /**
3236
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
3237
- */
3238
- AuthenticationToken?: string;
3239
-
3240
- /**
3241
- * <p>The ID of the resource.</p>
3242
- */
3243
- ResourceId: string | undefined;
3244
- }
3245
-
3246
- export namespace RemoveAllResourcePermissionsRequest {
3247
- /**
3248
- * @internal
3249
- */
3250
- export const filterSensitiveLog = (obj: RemoveAllResourcePermissionsRequest): any => ({
3251
- ...obj,
3252
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
3253
- });
3254
- }
3255
-
3256
- export interface RemoveResourcePermissionRequest {
3257
- /**
3258
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
3259
- */
3260
- AuthenticationToken?: string;
3261
-
3262
- /**
3263
- * <p>The ID of the resource.</p>
3264
- */
3265
- ResourceId: string | undefined;
3266
-
3267
- /**
3268
- * <p>The principal ID of the resource.</p>
3269
- */
3270
- PrincipalId: string | undefined;
3271
-
3272
- /**
3273
- * <p>The principal type of the resource.</p>
3274
- */
3275
- PrincipalType?: PrincipalType | string;
3276
- }
3277
-
3278
- export namespace RemoveResourcePermissionRequest {
3279
- /**
3280
- * @internal
3281
- */
3282
- export const filterSensitiveLog = (obj: RemoveResourcePermissionRequest): any => ({
3283
- ...obj,
3284
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
3285
- });
3286
- }
3287
-
3288
- export interface UpdateDocumentRequest {
3289
- /**
3290
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
3291
- */
3292
- AuthenticationToken?: string;
3293
-
3294
- /**
3295
- * <p>The ID of the document.</p>
3296
- */
3297
- DocumentId: string | undefined;
3298
-
3299
- /**
3300
- * <p>The name of the document.</p>
3301
- */
3302
- Name?: string;
3303
-
3304
- /**
3305
- * <p>The ID of the parent folder.</p>
3306
- */
3307
- ParentFolderId?: string;
3308
-
3309
- /**
3310
- * <p>The resource state of the document. Only ACTIVE and RECYCLED are
3311
- * supported.</p>
3312
- */
3313
- ResourceState?: ResourceStateType | string;
3314
- }
3315
-
3316
- export namespace UpdateDocumentRequest {
3317
- /**
3318
- * @internal
3319
- */
3320
- export const filterSensitiveLog = (obj: UpdateDocumentRequest): any => ({
3321
- ...obj,
3322
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
3323
- });
3324
- }
3325
-
3326
- /**
3327
- * <p>The operation is invalid.</p>
3328
- */
3329
- export interface InvalidOperationException extends __SmithyException, $MetadataBearer {
3330
- name: "InvalidOperationException";
3331
- $fault: "client";
3332
- Message?: string;
3333
- }
3334
-
3335
- export namespace InvalidOperationException {
3336
- /**
3337
- * @internal
3338
- */
3339
- export const filterSensitiveLog = (obj: InvalidOperationException): any => ({
3340
- ...obj,
3341
- });
3342
- }
3343
-
3344
- export enum DocumentVersionStatus {
3345
- ACTIVE = "ACTIVE",
3346
- }
3347
-
3348
- export interface UpdateDocumentVersionRequest {
3349
- /**
3350
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
3351
- */
3352
- AuthenticationToken?: string;
3353
-
3354
- /**
3355
- * <p>The ID of the document.</p>
3356
- */
3357
- DocumentId: string | undefined;
3358
-
3359
- /**
3360
- * <p>The version ID of the document.</p>
3361
- */
3362
- VersionId: string | undefined;
3363
-
3364
- /**
3365
- * <p>The status of the version.</p>
3366
- */
3367
- VersionStatus?: DocumentVersionStatus | string;
3368
- }
3369
-
3370
- export namespace UpdateDocumentVersionRequest {
3371
- /**
3372
- * @internal
3373
- */
3374
- export const filterSensitiveLog = (obj: UpdateDocumentVersionRequest): any => ({
3375
- ...obj,
3376
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
3377
- });
3378
- }
3379
-
3380
- export interface UpdateFolderRequest {
3381
- /**
3382
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
3383
- */
3384
- AuthenticationToken?: string;
3385
-
3386
- /**
3387
- * <p>The ID of the folder.</p>
3388
- */
3389
- FolderId: string | undefined;
3390
-
3391
- /**
3392
- * <p>The name of the folder.</p>
3393
- */
3394
- Name?: string;
3395
-
3396
- /**
3397
- * <p>The ID of the parent folder.</p>
3398
- */
3399
- ParentFolderId?: string;
3400
-
3401
- /**
3402
- * <p>The resource state of the folder. Only ACTIVE and RECYCLED are accepted values from
3403
- * the API.</p>
3404
- */
3405
- ResourceState?: ResourceStateType | string;
3406
- }
3407
-
3408
- export namespace UpdateFolderRequest {
3409
- /**
3410
- * @internal
3411
- */
3412
- export const filterSensitiveLog = (obj: UpdateFolderRequest): any => ({
3413
- ...obj,
3414
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
3415
- });
3416
- }
3417
-
3418
- /**
3419
- * <p>The last user in the organization is being deactivated.</p>
3420
- */
3421
- export interface DeactivatingLastSystemUserException extends __SmithyException, $MetadataBearer {
3422
- name: "DeactivatingLastSystemUserException";
3423
- $fault: "client";
3424
- Message?: string;
3425
- Code?: string;
3426
- }
3427
-
3428
- export namespace DeactivatingLastSystemUserException {
3429
- /**
3430
- * @internal
3431
- */
3432
- export const filterSensitiveLog = (obj: DeactivatingLastSystemUserException): any => ({
3433
- ...obj,
3434
- });
3435
- }
3436
-
3437
- /**
3438
- * <p>The user is undergoing transfer of ownership.</p>
3439
- */
3440
- export interface IllegalUserStateException extends __SmithyException, $MetadataBearer {
3441
- name: "IllegalUserStateException";
3442
- $fault: "client";
3443
- Message?: string;
3444
- }
3445
-
3446
- export namespace IllegalUserStateException {
3447
- /**
3448
- * @internal
3449
- */
3450
- export const filterSensitiveLog = (obj: IllegalUserStateException): any => ({
3451
- ...obj,
3452
- });
3453
- }
3454
-
3455
- export enum BooleanEnumType {
3456
- FALSE = "FALSE",
3457
- TRUE = "TRUE",
3458
- }
3459
-
3460
- export interface UpdateUserRequest {
3461
- /**
3462
- * <p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>
3463
- */
3464
- AuthenticationToken?: string;
3465
-
3466
- /**
3467
- * <p>The ID of the user.</p>
3468
- */
3469
- UserId: string | undefined;
3470
-
3471
- /**
3472
- * <p>The given name of the user.</p>
3473
- */
3474
- GivenName?: string;
3475
-
3476
- /**
3477
- * <p>The surname of the user.</p>
3478
- */
3479
- Surname?: string;
3480
-
3481
- /**
3482
- * <p>The type of the user.</p>
3483
- */
3484
- Type?: UserType | string;
3485
-
3486
- /**
3487
- * <p>The amount of storage for the user.</p>
3488
- */
3489
- StorageRule?: StorageRuleType;
3490
-
3491
- /**
3492
- * <p>The time zone ID of the user.</p>
3493
- */
3494
- TimeZoneId?: string;
3495
-
3496
- /**
3497
- * <p>The locale of the user.</p>
3498
- */
3499
- Locale?: LocaleType | string;
3500
-
3501
- /**
3502
- * <p>Boolean value to determine whether the user is granted Poweruser privileges.</p>
3503
- */
3504
- GrantPoweruserPrivileges?: BooleanEnumType | string;
3505
- }
3506
-
3507
- export namespace UpdateUserRequest {
3508
- /**
3509
- * @internal
3510
- */
3511
- export const filterSensitiveLog = (obj: UpdateUserRequest): any => ({
3512
- ...obj,
3513
- ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }),
3514
- });
3515
- }
3516
-
3517
- export interface UpdateUserResponse {
3518
- /**
3519
- * <p>The user information.</p>
3520
- */
3521
- User?: User;
3522
- }
3523
-
3524
- export namespace UpdateUserResponse {
3525
- /**
3526
- * @internal
3527
- */
3528
- export const filterSensitiveLog = (obj: UpdateUserResponse): any => ({
3529
- ...obj,
3530
- });
3531
- }