@aws-sdk/client-datasync 3.33.0 → 3.36.1

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 (403) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/{dist/cjs → dist-cjs}/DataSync.js +1 -11
  3. package/{dist/cjs → dist-cjs}/DataSyncClient.js +8 -23
  4. package/{dist/cjs → dist-cjs}/commands/CancelTaskExecutionCommand.js +2 -34
  5. package/dist-cjs/commands/CreateAgentCommand.js +36 -0
  6. package/{dist/cjs → dist-cjs}/commands/CreateLocationEfsCommand.js +2 -27
  7. package/{dist/cjs → dist-cjs}/commands/CreateLocationFsxWindowsCommand.js +2 -27
  8. package/{dist/cjs → dist-cjs}/commands/CreateLocationNfsCommand.js +2 -28
  9. package/{dist/cjs → dist-cjs}/commands/CreateLocationObjectStorageCommand.js +2 -28
  10. package/{dist/cjs → dist-cjs}/commands/CreateLocationS3Command.js +2 -33
  11. package/{dist/cjs → dist-cjs}/commands/CreateLocationSmbCommand.js +2 -28
  12. package/dist-cjs/commands/CreateTaskCommand.js +36 -0
  13. package/{dist/cjs → dist-cjs}/commands/DeleteAgentCommand.js +2 -30
  14. package/{dist/cjs → dist-cjs}/commands/DeleteLocationCommand.js +2 -27
  15. package/{dist/cjs → dist-cjs}/commands/DeleteTaskCommand.js +2 -27
  16. package/{dist/cjs → dist-cjs}/commands/DescribeAgentCommand.js +2 -29
  17. package/{dist/cjs → dist-cjs}/commands/DescribeLocationEfsCommand.js +2 -27
  18. package/{dist/cjs → dist-cjs}/commands/DescribeLocationFsxWindowsCommand.js +2 -28
  19. package/{dist/cjs → dist-cjs}/commands/DescribeLocationNfsCommand.js +2 -27
  20. package/{dist/cjs → dist-cjs}/commands/DescribeLocationObjectStorageCommand.js +2 -28
  21. package/{dist/cjs → dist-cjs}/commands/DescribeLocationS3Command.js +2 -27
  22. package/{dist/cjs → dist-cjs}/commands/DescribeLocationSmbCommand.js +2 -27
  23. package/{dist/cjs → dist-cjs}/commands/DescribeTaskCommand.js +2 -27
  24. package/{dist/cjs → dist-cjs}/commands/DescribeTaskExecutionCommand.js +2 -27
  25. package/dist-cjs/commands/ListAgentsCommand.js +36 -0
  26. package/{dist/cjs → dist-cjs}/commands/ListLocationsCommand.js +2 -30
  27. package/{dist/cjs → dist-cjs}/commands/ListTagsForResourceCommand.js +2 -27
  28. package/{dist/cjs → dist-cjs}/commands/ListTaskExecutionsCommand.js +2 -27
  29. package/{dist/cjs → dist-cjs}/commands/ListTasksCommand.js +2 -27
  30. package/{dist/cjs → dist-cjs}/commands/StartTaskExecutionCommand.js +2 -35
  31. package/{dist/cjs → dist-cjs}/commands/TagResourceCommand.js +2 -27
  32. package/{dist/cjs → dist-cjs}/commands/UntagResourceCommand.js +2 -27
  33. package/{dist/cjs → dist-cjs}/commands/UpdateAgentCommand.js +2 -27
  34. package/{dist/cjs → dist-cjs}/commands/UpdateLocationNfsCommand.js +2 -28
  35. package/{dist/cjs → dist-cjs}/commands/UpdateLocationObjectStorageCommand.js +2 -29
  36. package/{dist/cjs → dist-cjs}/commands/UpdateLocationSmbCommand.js +2 -29
  37. package/{dist/cjs → dist-cjs}/commands/UpdateTaskCommand.js +2 -27
  38. package/dist-cjs/commands/UpdateTaskExecutionCommand.js +36 -0
  39. package/{dist/cjs → dist-cjs}/endpoints.js +0 -1
  40. package/{dist/cjs → dist-cjs}/index.js +0 -1
  41. package/{dist/cjs → dist-cjs}/models/index.js +0 -1
  42. package/{dist/cjs → dist-cjs}/models/models_0.js +0 -268
  43. package/{dist/cjs → dist-cjs}/pagination/Interfaces.js +0 -1
  44. package/{dist/cjs → dist-cjs}/pagination/ListAgentsPaginator.js +1 -12
  45. package/{dist/cjs → dist-cjs}/pagination/ListLocationsPaginator.js +1 -12
  46. package/{dist/cjs → dist-cjs}/pagination/ListTagsForResourcePaginator.js +1 -12
  47. package/{dist/cjs → dist-cjs}/pagination/ListTaskExecutionsPaginator.js +1 -12
  48. package/{dist/cjs → dist-cjs}/pagination/ListTasksPaginator.js +1 -12
  49. package/{dist/cjs → dist-cjs}/protocols/Aws_json1_1.js +0 -6
  50. package/{dist/cjs → dist-cjs}/runtimeConfig.browser.js +1 -5
  51. package/{dist/cjs → dist-cjs}/runtimeConfig.js +1 -5
  52. package/{dist/cjs → dist-cjs}/runtimeConfig.native.js +0 -4
  53. package/{dist/cjs → dist-cjs}/runtimeConfig.shared.js +1 -5
  54. package/{dist/es → dist-es}/DataSync.js +2 -12
  55. package/{dist/es → dist-es}/DataSyncClient.js +2 -17
  56. package/{dist/es → dist-es}/commands/CancelTaskExecutionCommand.js +4 -37
  57. package/dist-es/commands/CreateAgentCommand.js +39 -0
  58. package/{dist/es → dist-es}/commands/CreateLocationEfsCommand.js +4 -30
  59. package/{dist/es → dist-es}/commands/CreateLocationFsxWindowsCommand.js +4 -30
  60. package/{dist/es → dist-es}/commands/CreateLocationNfsCommand.js +4 -31
  61. package/{dist/es → dist-es}/commands/CreateLocationObjectStorageCommand.js +4 -31
  62. package/{dist/es → dist-es}/commands/CreateLocationS3Command.js +4 -36
  63. package/{dist/es → dist-es}/commands/CreateLocationSmbCommand.js +4 -31
  64. package/dist-es/commands/CreateTaskCommand.js +39 -0
  65. package/{dist/es → dist-es}/commands/DeleteAgentCommand.js +4 -33
  66. package/{dist/es → dist-es}/commands/DeleteLocationCommand.js +4 -30
  67. package/{dist/es → dist-es}/commands/DeleteTaskCommand.js +4 -30
  68. package/{dist/es → dist-es}/commands/DescribeAgentCommand.js +4 -32
  69. package/{dist/es → dist-es}/commands/DescribeLocationEfsCommand.js +4 -30
  70. package/{dist/es → dist-es}/commands/DescribeLocationFsxWindowsCommand.js +4 -31
  71. package/{dist/es → dist-es}/commands/DescribeLocationNfsCommand.js +4 -30
  72. package/{dist/es → dist-es}/commands/DescribeLocationObjectStorageCommand.js +4 -31
  73. package/{dist/es → dist-es}/commands/DescribeLocationS3Command.js +4 -30
  74. package/{dist/es → dist-es}/commands/DescribeLocationSmbCommand.js +4 -30
  75. package/{dist/es → dist-es}/commands/DescribeTaskCommand.js +4 -30
  76. package/{dist/es → dist-es}/commands/DescribeTaskExecutionCommand.js +4 -30
  77. package/{dist/es → dist-es}/commands/ListAgentsCommand.js +4 -37
  78. package/{dist/es → dist-es}/commands/ListLocationsCommand.js +4 -33
  79. package/{dist/es → dist-es}/commands/ListTagsForResourceCommand.js +4 -30
  80. package/{dist/es → dist-es}/commands/ListTaskExecutionsCommand.js +4 -30
  81. package/{dist/es → dist-es}/commands/ListTasksCommand.js +4 -30
  82. package/{dist/es → dist-es}/commands/StartTaskExecutionCommand.js +4 -38
  83. package/{dist/es → dist-es}/commands/TagResourceCommand.js +4 -30
  84. package/{dist/es → dist-es}/commands/UntagResourceCommand.js +4 -30
  85. package/{dist/es → dist-es}/commands/UpdateAgentCommand.js +4 -30
  86. package/{dist/es → dist-es}/commands/UpdateLocationNfsCommand.js +4 -31
  87. package/{dist/es → dist-es}/commands/UpdateLocationObjectStorageCommand.js +4 -32
  88. package/{dist/es → dist-es}/commands/UpdateLocationSmbCommand.js +4 -32
  89. package/{dist/es → dist-es}/commands/UpdateTaskCommand.js +4 -30
  90. package/{dist/es → dist-es}/commands/UpdateTaskExecutionCommand.js +4 -39
  91. package/{dist/es → dist-es}/endpoints.js +1 -2
  92. package/{dist/types/index.d.ts → dist-es/index.js} +0 -0
  93. package/{dist/types/models/index.d.ts → dist-es/models/index.js} +0 -0
  94. package/{dist/es → dist-es}/models/models_0.js +0 -268
  95. package/dist-es/pagination/Interfaces.js +1 -0
  96. package/{dist/es → dist-es}/pagination/ListAgentsPaginator.js +17 -30
  97. package/{dist/es → dist-es}/pagination/ListLocationsPaginator.js +17 -30
  98. package/{dist/es → dist-es}/pagination/ListTagsForResourcePaginator.js +17 -30
  99. package/{dist/es → dist-es}/pagination/ListTaskExecutionsPaginator.js +17 -30
  100. package/{dist/es → dist-es}/pagination/ListTasksPaginator.js +17 -30
  101. package/{dist/es → dist-es}/protocols/Aws_json1_1.js +529 -535
  102. package/{dist/es → dist-es}/runtimeConfig.browser.js +1 -5
  103. package/{dist/es → dist-es}/runtimeConfig.js +1 -5
  104. package/{dist/es → dist-es}/runtimeConfig.native.js +0 -4
  105. package/{dist/es → dist-es}/runtimeConfig.shared.js +1 -5
  106. package/{dist/types → dist-types}/DataSync.d.ts +2 -2
  107. package/{dist/types → dist-types}/DataSyncClient.d.ts +8 -8
  108. package/{dist/types → dist-types}/commands/CancelTaskExecutionCommand.d.ts +2 -2
  109. package/{dist/types → dist-types}/commands/CreateAgentCommand.d.ts +2 -2
  110. package/{dist/types → dist-types}/commands/CreateLocationEfsCommand.d.ts +2 -2
  111. package/{dist/types → dist-types}/commands/CreateLocationFsxWindowsCommand.d.ts +2 -2
  112. package/{dist/types → dist-types}/commands/CreateLocationNfsCommand.d.ts +2 -2
  113. package/{dist/types → dist-types}/commands/CreateLocationObjectStorageCommand.d.ts +2 -2
  114. package/{dist/types → dist-types}/commands/CreateLocationS3Command.d.ts +2 -2
  115. package/{dist/types → dist-types}/commands/CreateLocationSmbCommand.d.ts +2 -2
  116. package/{dist/types → dist-types}/commands/CreateTaskCommand.d.ts +2 -2
  117. package/{dist/types → dist-types}/commands/DeleteAgentCommand.d.ts +2 -2
  118. package/{dist/types → dist-types}/commands/DeleteLocationCommand.d.ts +2 -2
  119. package/{dist/types → dist-types}/commands/DeleteTaskCommand.d.ts +2 -2
  120. package/{dist/types → dist-types}/commands/DescribeAgentCommand.d.ts +2 -2
  121. package/{dist/types → dist-types}/commands/DescribeLocationEfsCommand.d.ts +2 -2
  122. package/{dist/types → dist-types}/commands/DescribeLocationFsxWindowsCommand.d.ts +2 -2
  123. package/{dist/types → dist-types}/commands/DescribeLocationNfsCommand.d.ts +2 -2
  124. package/{dist/types → dist-types}/commands/DescribeLocationObjectStorageCommand.d.ts +2 -2
  125. package/{dist/types → dist-types}/commands/DescribeLocationS3Command.d.ts +2 -2
  126. package/{dist/types → dist-types}/commands/DescribeLocationSmbCommand.d.ts +2 -2
  127. package/{dist/types → dist-types}/commands/DescribeTaskCommand.d.ts +2 -2
  128. package/{dist/types → dist-types}/commands/DescribeTaskExecutionCommand.d.ts +2 -2
  129. package/{dist/types → dist-types}/commands/ListAgentsCommand.d.ts +2 -2
  130. package/{dist/types → dist-types}/commands/ListLocationsCommand.d.ts +2 -2
  131. package/{dist/types → dist-types}/commands/ListTagsForResourceCommand.d.ts +2 -2
  132. package/{dist/types → dist-types}/commands/ListTaskExecutionsCommand.d.ts +2 -2
  133. package/{dist/types → dist-types}/commands/ListTasksCommand.d.ts +2 -2
  134. package/{dist/types → dist-types}/commands/StartTaskExecutionCommand.d.ts +2 -2
  135. package/{dist/types → dist-types}/commands/TagResourceCommand.d.ts +2 -2
  136. package/{dist/types → dist-types}/commands/UntagResourceCommand.d.ts +2 -2
  137. package/{dist/types → dist-types}/commands/UpdateAgentCommand.d.ts +2 -2
  138. package/{dist/types → dist-types}/commands/UpdateLocationNfsCommand.d.ts +2 -2
  139. package/{dist/types → dist-types}/commands/UpdateLocationObjectStorageCommand.d.ts +2 -2
  140. package/{dist/types → dist-types}/commands/UpdateLocationSmbCommand.d.ts +2 -2
  141. package/{dist/types → dist-types}/commands/UpdateTaskCommand.d.ts +2 -2
  142. package/{dist/types → dist-types}/commands/UpdateTaskExecutionCommand.d.ts +2 -2
  143. package/{dist/types → dist-types}/endpoints.d.ts +0 -0
  144. package/{index.ts → dist-types/index.d.ts} +0 -0
  145. package/{models/index.ts → dist-types/models/index.d.ts} +0 -0
  146. package/{dist/types → dist-types}/models/models_0.d.ts +0 -0
  147. package/{dist/types → dist-types}/pagination/Interfaces.d.ts +1 -1
  148. package/{dist/types → dist-types}/pagination/ListAgentsPaginator.d.ts +1 -1
  149. package/{dist/types → dist-types}/pagination/ListLocationsPaginator.d.ts +1 -1
  150. package/{dist/types → dist-types}/pagination/ListTagsForResourcePaginator.d.ts +1 -1
  151. package/{dist/types → dist-types}/pagination/ListTaskExecutionsPaginator.d.ts +1 -1
  152. package/{dist/types → dist-types}/pagination/ListTasksPaginator.d.ts +1 -1
  153. package/{dist/types → dist-types}/protocols/Aws_json1_1.d.ts +2 -2
  154. package/{dist/types → dist-types}/runtimeConfig.browser.d.ts +0 -0
  155. package/{dist/types → dist-types}/runtimeConfig.d.ts +1 -1
  156. package/{dist/types → dist-types}/runtimeConfig.native.d.ts +0 -0
  157. package/{dist/types → dist-types}/runtimeConfig.shared.d.ts +0 -0
  158. package/{dist/types → dist-types}/ts3.4/DataSync.d.ts +38 -203
  159. package/{dist/types → dist-types}/ts3.4/DataSyncClient.d.ts +32 -103
  160. package/dist-types/ts3.4/commands/CancelTaskExecutionCommand.d.ts +17 -0
  161. package/dist-types/ts3.4/commands/CreateAgentCommand.d.ts +17 -0
  162. package/{dist/types → dist-types}/ts3.4/commands/CreateLocationEfsCommand.d.ts +4 -22
  163. package/{dist/types → dist-types}/ts3.4/commands/CreateLocationFsxWindowsCommand.d.ts +4 -22
  164. package/dist-types/ts3.4/commands/CreateLocationNfsCommand.d.ts +17 -0
  165. package/dist-types/ts3.4/commands/CreateLocationObjectStorageCommand.d.ts +17 -0
  166. package/dist-types/ts3.4/commands/CreateLocationS3Command.d.ts +17 -0
  167. package/dist-types/ts3.4/commands/CreateLocationSmbCommand.d.ts +17 -0
  168. package/dist-types/ts3.4/commands/CreateTaskCommand.d.ts +17 -0
  169. package/dist-types/ts3.4/commands/DeleteAgentCommand.d.ts +17 -0
  170. package/dist-types/ts3.4/commands/DeleteLocationCommand.d.ts +17 -0
  171. package/dist-types/ts3.4/commands/DeleteTaskCommand.d.ts +17 -0
  172. package/dist-types/ts3.4/commands/DescribeAgentCommand.d.ts +17 -0
  173. package/{dist/types → dist-types}/ts3.4/commands/DescribeLocationEfsCommand.d.ts +4 -22
  174. package/{dist/types → dist-types}/ts3.4/commands/DescribeLocationFsxWindowsCommand.d.ts +4 -23
  175. package/{dist/types → dist-types}/ts3.4/commands/DescribeLocationNfsCommand.d.ts +4 -22
  176. package/dist-types/ts3.4/commands/DescribeLocationObjectStorageCommand.d.ts +17 -0
  177. package/{dist/types → dist-types}/ts3.4/commands/DescribeLocationS3Command.d.ts +4 -22
  178. package/{dist/types → dist-types}/ts3.4/commands/DescribeLocationSmbCommand.d.ts +4 -22
  179. package/{dist/types → dist-types}/ts3.4/commands/DescribeTaskCommand.d.ts +4 -22
  180. package/{dist/types → dist-types}/ts3.4/commands/DescribeTaskExecutionCommand.d.ts +4 -22
  181. package/dist-types/ts3.4/commands/ListAgentsCommand.d.ts +17 -0
  182. package/dist-types/ts3.4/commands/ListLocationsCommand.d.ts +17 -0
  183. package/{dist/types → dist-types}/ts3.4/commands/ListTagsForResourceCommand.d.ts +4 -22
  184. package/{dist/types → dist-types}/ts3.4/commands/ListTaskExecutionsCommand.d.ts +4 -22
  185. package/dist-types/ts3.4/commands/ListTasksCommand.d.ts +17 -0
  186. package/dist-types/ts3.4/commands/StartTaskExecutionCommand.d.ts +17 -0
  187. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +17 -0
  188. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +17 -0
  189. package/dist-types/ts3.4/commands/UpdateAgentCommand.d.ts +17 -0
  190. package/dist-types/ts3.4/commands/UpdateLocationNfsCommand.d.ts +17 -0
  191. package/dist-types/ts3.4/commands/UpdateLocationObjectStorageCommand.d.ts +17 -0
  192. package/dist-types/ts3.4/commands/UpdateLocationSmbCommand.d.ts +17 -0
  193. package/dist-types/ts3.4/commands/UpdateTaskCommand.d.ts +17 -0
  194. package/dist-types/ts3.4/commands/UpdateTaskExecutionCommand.d.ts +17 -0
  195. package/{dist/types → dist-types}/ts3.4/endpoints.d.ts +0 -0
  196. package/{dist/types → dist-types}/ts3.4/index.d.ts +0 -0
  197. package/{dist/types → dist-types}/ts3.4/models/index.d.ts +0 -0
  198. package/dist-types/ts3.4/models/models_0.d.ts +1271 -0
  199. package/{dist/types → dist-types}/ts3.4/pagination/Interfaces.d.ts +1 -1
  200. package/{dist/types → dist-types}/ts3.4/pagination/ListAgentsPaginator.d.ts +1 -1
  201. package/{dist/types → dist-types}/ts3.4/pagination/ListLocationsPaginator.d.ts +1 -1
  202. package/{dist/types → dist-types}/ts3.4/pagination/ListTagsForResourcePaginator.d.ts +1 -1
  203. package/{dist/types → dist-types}/ts3.4/pagination/ListTaskExecutionsPaginator.d.ts +1 -1
  204. package/{dist/types → dist-types}/ts3.4/pagination/ListTasksPaginator.d.ts +1 -1
  205. package/{dist/types → dist-types}/ts3.4/protocols/Aws_json1_1.d.ts +2 -2
  206. package/{dist/types → dist-types}/ts3.4/runtimeConfig.browser.d.ts +1 -3
  207. package/{dist/types → dist-types}/ts3.4/runtimeConfig.d.ts +2 -4
  208. package/{dist/types → dist-types}/ts3.4/runtimeConfig.native.d.ts +1 -3
  209. package/{dist/types → dist-types}/ts3.4/runtimeConfig.shared.d.ts +1 -3
  210. package/package.json +52 -49
  211. package/DataSync.ts +0 -1302
  212. package/DataSyncClient.ts +0 -382
  213. package/commands/CancelTaskExecutionCommand.ts +0 -101
  214. package/commands/CreateAgentCommand.ts +0 -108
  215. package/commands/CreateLocationEfsCommand.ts +0 -94
  216. package/commands/CreateLocationFsxWindowsCommand.ts +0 -94
  217. package/commands/CreateLocationNfsCommand.ts +0 -95
  218. package/commands/CreateLocationObjectStorageCommand.ts +0 -100
  219. package/commands/CreateLocationS3Command.ts +0 -100
  220. package/commands/CreateLocationSmbCommand.ts +0 -95
  221. package/commands/CreateTaskCommand.ts +0 -112
  222. package/commands/DeleteAgentCommand.ts +0 -97
  223. package/commands/DeleteLocationCommand.ts +0 -94
  224. package/commands/DeleteTaskCommand.ts +0 -94
  225. package/commands/DescribeAgentCommand.ts +0 -96
  226. package/commands/DescribeLocationEfsCommand.ts +0 -94
  227. package/commands/DescribeLocationFsxWindowsCommand.ts +0 -98
  228. package/commands/DescribeLocationNfsCommand.ts +0 -94
  229. package/commands/DescribeLocationObjectStorageCommand.ts +0 -100
  230. package/commands/DescribeLocationS3Command.ts +0 -94
  231. package/commands/DescribeLocationSmbCommand.ts +0 -94
  232. package/commands/DescribeTaskCommand.ts +0 -94
  233. package/commands/DescribeTaskExecutionCommand.ts +0 -94
  234. package/commands/ListAgentsCommand.ts +0 -101
  235. package/commands/ListLocationsCommand.ts +0 -97
  236. package/commands/ListTagsForResourceCommand.ts +0 -94
  237. package/commands/ListTaskExecutionsCommand.ts +0 -94
  238. package/commands/ListTasksCommand.ts +0 -91
  239. package/commands/StartTaskExecutionCommand.ts +0 -102
  240. package/commands/TagResourceCommand.ts +0 -94
  241. package/commands/UntagResourceCommand.ts +0 -94
  242. package/commands/UpdateAgentCommand.ts +0 -94
  243. package/commands/UpdateLocationNfsCommand.ts +0 -95
  244. package/commands/UpdateLocationObjectStorageCommand.ts +0 -101
  245. package/commands/UpdateLocationSmbCommand.ts +0 -96
  246. package/commands/UpdateTaskCommand.ts +0 -94
  247. package/commands/UpdateTaskExecutionCommand.ts +0 -103
  248. package/dist/cjs/DataSync.js.map +0 -1
  249. package/dist/cjs/DataSyncClient.js.map +0 -1
  250. package/dist/cjs/commands/CancelTaskExecutionCommand.js.map +0 -1
  251. package/dist/cjs/commands/CreateAgentCommand.js +0 -75
  252. package/dist/cjs/commands/CreateAgentCommand.js.map +0 -1
  253. package/dist/cjs/commands/CreateLocationEfsCommand.js.map +0 -1
  254. package/dist/cjs/commands/CreateLocationFsxWindowsCommand.js.map +0 -1
  255. package/dist/cjs/commands/CreateLocationNfsCommand.js.map +0 -1
  256. package/dist/cjs/commands/CreateLocationObjectStorageCommand.js.map +0 -1
  257. package/dist/cjs/commands/CreateLocationS3Command.js.map +0 -1
  258. package/dist/cjs/commands/CreateLocationSmbCommand.js.map +0 -1
  259. package/dist/cjs/commands/CreateTaskCommand.js +0 -79
  260. package/dist/cjs/commands/CreateTaskCommand.js.map +0 -1
  261. package/dist/cjs/commands/DeleteAgentCommand.js.map +0 -1
  262. package/dist/cjs/commands/DeleteLocationCommand.js.map +0 -1
  263. package/dist/cjs/commands/DeleteTaskCommand.js.map +0 -1
  264. package/dist/cjs/commands/DescribeAgentCommand.js.map +0 -1
  265. package/dist/cjs/commands/DescribeLocationEfsCommand.js.map +0 -1
  266. package/dist/cjs/commands/DescribeLocationFsxWindowsCommand.js.map +0 -1
  267. package/dist/cjs/commands/DescribeLocationNfsCommand.js.map +0 -1
  268. package/dist/cjs/commands/DescribeLocationObjectStorageCommand.js.map +0 -1
  269. package/dist/cjs/commands/DescribeLocationS3Command.js.map +0 -1
  270. package/dist/cjs/commands/DescribeLocationSmbCommand.js.map +0 -1
  271. package/dist/cjs/commands/DescribeTaskCommand.js.map +0 -1
  272. package/dist/cjs/commands/DescribeTaskExecutionCommand.js.map +0 -1
  273. package/dist/cjs/commands/ListAgentsCommand.js +0 -68
  274. package/dist/cjs/commands/ListAgentsCommand.js.map +0 -1
  275. package/dist/cjs/commands/ListLocationsCommand.js.map +0 -1
  276. package/dist/cjs/commands/ListTagsForResourceCommand.js.map +0 -1
  277. package/dist/cjs/commands/ListTaskExecutionsCommand.js.map +0 -1
  278. package/dist/cjs/commands/ListTasksCommand.js.map +0 -1
  279. package/dist/cjs/commands/StartTaskExecutionCommand.js.map +0 -1
  280. package/dist/cjs/commands/TagResourceCommand.js.map +0 -1
  281. package/dist/cjs/commands/UntagResourceCommand.js.map +0 -1
  282. package/dist/cjs/commands/UpdateAgentCommand.js.map +0 -1
  283. package/dist/cjs/commands/UpdateLocationNfsCommand.js.map +0 -1
  284. package/dist/cjs/commands/UpdateLocationObjectStorageCommand.js.map +0 -1
  285. package/dist/cjs/commands/UpdateLocationSmbCommand.js.map +0 -1
  286. package/dist/cjs/commands/UpdateTaskCommand.js.map +0 -1
  287. package/dist/cjs/commands/UpdateTaskExecutionCommand.js +0 -70
  288. package/dist/cjs/commands/UpdateTaskExecutionCommand.js.map +0 -1
  289. package/dist/cjs/endpoints.js.map +0 -1
  290. package/dist/cjs/index.js.map +0 -1
  291. package/dist/cjs/models/index.js.map +0 -1
  292. package/dist/cjs/models/models_0.js.map +0 -1
  293. package/dist/cjs/package.json +0 -91
  294. package/dist/cjs/pagination/Interfaces.js.map +0 -1
  295. package/dist/cjs/pagination/ListAgentsPaginator.js.map +0 -1
  296. package/dist/cjs/pagination/ListLocationsPaginator.js.map +0 -1
  297. package/dist/cjs/pagination/ListTagsForResourcePaginator.js.map +0 -1
  298. package/dist/cjs/pagination/ListTaskExecutionsPaginator.js.map +0 -1
  299. package/dist/cjs/pagination/ListTasksPaginator.js.map +0 -1
  300. package/dist/cjs/protocols/Aws_json1_1.js.map +0 -1
  301. package/dist/cjs/runtimeConfig.browser.js.map +0 -1
  302. package/dist/cjs/runtimeConfig.js.map +0 -1
  303. package/dist/cjs/runtimeConfig.native.js.map +0 -1
  304. package/dist/cjs/runtimeConfig.shared.js.map +0 -1
  305. package/dist/es/DataSync.js.map +0 -1
  306. package/dist/es/DataSyncClient.js.map +0 -1
  307. package/dist/es/commands/CancelTaskExecutionCommand.js.map +0 -1
  308. package/dist/es/commands/CreateAgentCommand.js +0 -79
  309. package/dist/es/commands/CreateAgentCommand.js.map +0 -1
  310. package/dist/es/commands/CreateLocationEfsCommand.js.map +0 -1
  311. package/dist/es/commands/CreateLocationFsxWindowsCommand.js.map +0 -1
  312. package/dist/es/commands/CreateLocationNfsCommand.js.map +0 -1
  313. package/dist/es/commands/CreateLocationObjectStorageCommand.js.map +0 -1
  314. package/dist/es/commands/CreateLocationS3Command.js.map +0 -1
  315. package/dist/es/commands/CreateLocationSmbCommand.js.map +0 -1
  316. package/dist/es/commands/CreateTaskCommand.js +0 -83
  317. package/dist/es/commands/CreateTaskCommand.js.map +0 -1
  318. package/dist/es/commands/DeleteAgentCommand.js.map +0 -1
  319. package/dist/es/commands/DeleteLocationCommand.js.map +0 -1
  320. package/dist/es/commands/DeleteTaskCommand.js.map +0 -1
  321. package/dist/es/commands/DescribeAgentCommand.js.map +0 -1
  322. package/dist/es/commands/DescribeLocationEfsCommand.js.map +0 -1
  323. package/dist/es/commands/DescribeLocationFsxWindowsCommand.js.map +0 -1
  324. package/dist/es/commands/DescribeLocationNfsCommand.js.map +0 -1
  325. package/dist/es/commands/DescribeLocationObjectStorageCommand.js.map +0 -1
  326. package/dist/es/commands/DescribeLocationS3Command.js.map +0 -1
  327. package/dist/es/commands/DescribeLocationSmbCommand.js.map +0 -1
  328. package/dist/es/commands/DescribeTaskCommand.js.map +0 -1
  329. package/dist/es/commands/DescribeTaskExecutionCommand.js.map +0 -1
  330. package/dist/es/commands/ListAgentsCommand.js.map +0 -1
  331. package/dist/es/commands/ListLocationsCommand.js.map +0 -1
  332. package/dist/es/commands/ListTagsForResourceCommand.js.map +0 -1
  333. package/dist/es/commands/ListTaskExecutionsCommand.js.map +0 -1
  334. package/dist/es/commands/ListTasksCommand.js.map +0 -1
  335. package/dist/es/commands/StartTaskExecutionCommand.js.map +0 -1
  336. package/dist/es/commands/TagResourceCommand.js.map +0 -1
  337. package/dist/es/commands/UntagResourceCommand.js.map +0 -1
  338. package/dist/es/commands/UpdateAgentCommand.js.map +0 -1
  339. package/dist/es/commands/UpdateLocationNfsCommand.js.map +0 -1
  340. package/dist/es/commands/UpdateLocationObjectStorageCommand.js.map +0 -1
  341. package/dist/es/commands/UpdateLocationSmbCommand.js.map +0 -1
  342. package/dist/es/commands/UpdateTaskCommand.js.map +0 -1
  343. package/dist/es/commands/UpdateTaskExecutionCommand.js.map +0 -1
  344. package/dist/es/endpoints.js.map +0 -1
  345. package/dist/es/index.js +0 -45
  346. package/dist/es/index.js.map +0 -1
  347. package/dist/es/models/index.js +0 -2
  348. package/dist/es/models/index.js.map +0 -1
  349. package/dist/es/models/models_0.js.map +0 -1
  350. package/dist/es/package.json +0 -91
  351. package/dist/es/pagination/Interfaces.js +0 -2
  352. package/dist/es/pagination/Interfaces.js.map +0 -1
  353. package/dist/es/pagination/ListAgentsPaginator.js.map +0 -1
  354. package/dist/es/pagination/ListLocationsPaginator.js.map +0 -1
  355. package/dist/es/pagination/ListTagsForResourcePaginator.js.map +0 -1
  356. package/dist/es/pagination/ListTaskExecutionsPaginator.js.map +0 -1
  357. package/dist/es/pagination/ListTasksPaginator.js.map +0 -1
  358. package/dist/es/protocols/Aws_json1_1.js.map +0 -1
  359. package/dist/es/runtimeConfig.browser.js.map +0 -1
  360. package/dist/es/runtimeConfig.js.map +0 -1
  361. package/dist/es/runtimeConfig.native.js.map +0 -1
  362. package/dist/es/runtimeConfig.shared.js.map +0 -1
  363. package/dist/types/ts3.4/commands/CancelTaskExecutionCommand.d.ts +0 -42
  364. package/dist/types/ts3.4/commands/CreateAgentCommand.d.ts +0 -49
  365. package/dist/types/ts3.4/commands/CreateLocationNfsCommand.d.ts +0 -36
  366. package/dist/types/ts3.4/commands/CreateLocationObjectStorageCommand.d.ts +0 -36
  367. package/dist/types/ts3.4/commands/CreateLocationS3Command.d.ts +0 -41
  368. package/dist/types/ts3.4/commands/CreateLocationSmbCommand.d.ts +0 -36
  369. package/dist/types/ts3.4/commands/CreateTaskCommand.d.ts +0 -53
  370. package/dist/types/ts3.4/commands/DeleteAgentCommand.d.ts +0 -38
  371. package/dist/types/ts3.4/commands/DeleteLocationCommand.d.ts +0 -35
  372. package/dist/types/ts3.4/commands/DeleteTaskCommand.d.ts +0 -35
  373. package/dist/types/ts3.4/commands/DescribeAgentCommand.d.ts +0 -37
  374. package/dist/types/ts3.4/commands/DescribeLocationObjectStorageCommand.d.ts +0 -36
  375. package/dist/types/ts3.4/commands/ListAgentsCommand.d.ts +0 -42
  376. package/dist/types/ts3.4/commands/ListLocationsCommand.d.ts +0 -38
  377. package/dist/types/ts3.4/commands/ListTasksCommand.d.ts +0 -35
  378. package/dist/types/ts3.4/commands/StartTaskExecutionCommand.d.ts +0 -43
  379. package/dist/types/ts3.4/commands/TagResourceCommand.d.ts +0 -35
  380. package/dist/types/ts3.4/commands/UntagResourceCommand.d.ts +0 -35
  381. package/dist/types/ts3.4/commands/UpdateAgentCommand.d.ts +0 -35
  382. package/dist/types/ts3.4/commands/UpdateLocationNfsCommand.d.ts +0 -36
  383. package/dist/types/ts3.4/commands/UpdateLocationObjectStorageCommand.d.ts +0 -37
  384. package/dist/types/ts3.4/commands/UpdateLocationSmbCommand.d.ts +0 -37
  385. package/dist/types/ts3.4/commands/UpdateTaskCommand.d.ts +0 -35
  386. package/dist/types/ts3.4/commands/UpdateTaskExecutionCommand.d.ts +0 -44
  387. package/dist/types/ts3.4/models/models_0.d.ts +0 -2774
  388. package/endpoints.ts +0 -91
  389. package/jest.config.js +0 -4
  390. package/models/models_0.ts +0 -3336
  391. package/pagination/Interfaces.ts +0 -7
  392. package/pagination/ListAgentsPaginator.ts +0 -54
  393. package/pagination/ListLocationsPaginator.ts +0 -58
  394. package/pagination/ListTagsForResourcePaginator.ts +0 -58
  395. package/pagination/ListTaskExecutionsPaginator.ts +0 -58
  396. package/pagination/ListTasksPaginator.ts +0 -54
  397. package/protocols/Aws_json1_1.ts +0 -4257
  398. package/runtimeConfig.browser.ts +0 -40
  399. package/runtimeConfig.native.ts +0 -16
  400. package/runtimeConfig.shared.ts +0 -16
  401. package/runtimeConfig.ts +0 -45
  402. package/tsconfig.es.json +0 -12
  403. package/tsconfig.json +0 -32
@@ -1,2774 +0,0 @@
1
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
- export declare enum AgentStatus {
3
- OFFLINE = "OFFLINE",
4
- ONLINE = "ONLINE"
5
- }
6
- /**
7
- * <p>Represents a single entry in a list of agents. <code>AgentListEntry</code> returns an
8
- * array that contains a list of agents when the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_ListAgents.html">ListAgents</a>
9
- * operation is
10
- * called.</p>
11
- */
12
- export interface AgentListEntry {
13
- /**
14
- * <p>The Amazon Resource Name (ARN) of the agent.</p>
15
- */
16
- AgentArn?: string;
17
- /**
18
- * <p>The name of the agent.</p>
19
- */
20
- Name?: string;
21
- /**
22
- * <p>The status of the agent.</p>
23
- */
24
- Status?: AgentStatus | string;
25
- }
26
- export declare namespace AgentListEntry {
27
- /**
28
- * @internal
29
- */
30
- const filterSensitiveLog: (obj: AgentListEntry) => any;
31
- }
32
- export declare enum Atime {
33
- BEST_EFFORT = "BEST_EFFORT",
34
- NONE = "NONE"
35
- }
36
- /**
37
- * <p>CancelTaskExecutionRequest</p>
38
- */
39
- export interface CancelTaskExecutionRequest {
40
- /**
41
- * <p>The Amazon Resource Name (ARN) of the task execution to cancel.</p>
42
- */
43
- TaskExecutionArn: string | undefined;
44
- }
45
- export declare namespace CancelTaskExecutionRequest {
46
- /**
47
- * @internal
48
- */
49
- const filterSensitiveLog: (obj: CancelTaskExecutionRequest) => any;
50
- }
51
- export interface CancelTaskExecutionResponse {
52
- }
53
- export declare namespace CancelTaskExecutionResponse {
54
- /**
55
- * @internal
56
- */
57
- const filterSensitiveLog: (obj: CancelTaskExecutionResponse) => any;
58
- }
59
- /**
60
- * <p>This exception is thrown when an error occurs in the DataSync service.</p>
61
- */
62
- export interface InternalException extends __SmithyException, $MetadataBearer {
63
- name: "InternalException";
64
- $fault: "server";
65
- message?: string;
66
- errorCode?: string;
67
- }
68
- export declare namespace InternalException {
69
- /**
70
- * @internal
71
- */
72
- const filterSensitiveLog: (obj: InternalException) => any;
73
- }
74
- /**
75
- * <p>This exception is thrown when the client submits a malformed request.</p>
76
- */
77
- export interface InvalidRequestException extends __SmithyException, $MetadataBearer {
78
- name: "InvalidRequestException";
79
- $fault: "client";
80
- message?: string;
81
- errorCode?: string;
82
- }
83
- export declare namespace InvalidRequestException {
84
- /**
85
- * @internal
86
- */
87
- const filterSensitiveLog: (obj: InvalidRequestException) => any;
88
- }
89
- /**
90
- * <p>Represents a single entry in a list of AWS resource tags. <code>TagListEntry</code>
91
- * returns an array that contains a list of tasks when the
92
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTagsForResource.html">ListTagsForResource</a>
93
- * operation is called.</p>
94
- */
95
- export interface TagListEntry {
96
- /**
97
- * <p>The key for an Amazon Web Services resource tag.</p>
98
- */
99
- Key: string | undefined;
100
- /**
101
- * <p>The value for an Amazon Web Services resource tag.</p>
102
- */
103
- Value?: string;
104
- }
105
- export declare namespace TagListEntry {
106
- /**
107
- * @internal
108
- */
109
- const filterSensitiveLog: (obj: TagListEntry) => any;
110
- }
111
- /**
112
- * <p>CreateAgentRequest</p>
113
- */
114
- export interface CreateAgentRequest {
115
- /**
116
- * <p>Your agent activation key. You can get the activation key either by sending an HTTP GET
117
- * request with redirects that enable you to get the agent IP address (port 80). Alternatively,
118
- * you can get it from the DataSync console.</p>
119
- * <p>The redirect URL returned in the response provides you the activation key for your
120
- * agent in the query string parameter <code>activationKey</code>. It might also include other
121
- * activation-related parameters; however, these are merely defaults. The arguments you pass to
122
- * this API call determine the actual configuration of your agent.</p>
123
- *
124
- *
125
- * <p>For more information, see Activating an Agent in the <i>DataSync
126
- * User Guide.</i>
127
- * </p>
128
- */
129
- ActivationKey: string | undefined;
130
- /**
131
- * <p>The name you configured for your agent. This value is a text reference that is used to
132
- * identify the agent in the console.</p>
133
- */
134
- AgentName?: string;
135
- /**
136
- * <p>The key-value pair that represents the tag that you want to associate with the agent.
137
- * The value can be an empty string. This value helps you manage, filter, and search for your
138
- * agents.</p>
139
- * <note>
140
- * <p>Valid characters for key and value are letters, spaces, and numbers representable in
141
- * UTF-8 format, and the following special characters: + - = . _ : / @. </p>
142
- * </note>
143
- */
144
- Tags?: TagListEntry[];
145
- /**
146
- * <p>The ID of the VPC (virtual private cloud) endpoint that the agent has access to. This is
147
- * the client-side VPC endpoint, also called a PrivateLink. If you don't have a PrivateLink VPC
148
- * endpoint, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html#create-endpoint-service">Creating a VPC Endpoint Service Configuration</a> in the Amazon VPC User Guide.</p>
149
- * <p>VPC endpoint ID looks like this: <code>vpce-01234d5aff67890e1</code>.</p>
150
- */
151
- VpcEndpointId?: string;
152
- /**
153
- * <p>The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic
154
- * network interfaces for each data transfer task. The agent that runs a task must be private.
155
- * When you start a task that is associated with an agent created in a VPC, or one that has
156
- * access to an IP address in a VPC, then the task is also private. In this case, DataSync
157
- * creates four network interfaces for each task in your subnet. For a data transfer to work, the
158
- * agent must be able to route to all these four network interfaces.</p>
159
- */
160
- SubnetArns?: string[];
161
- /**
162
- * <p>The ARNs of the security groups used to protect your data transfer task subnets. See <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_Ec2Config.html#DataSync-Type-Ec2Config-SecurityGroupArns">SecurityGroupArns</a>.</p>
163
- */
164
- SecurityGroupArns?: string[];
165
- }
166
- export declare namespace CreateAgentRequest {
167
- /**
168
- * @internal
169
- */
170
- const filterSensitiveLog: (obj: CreateAgentRequest) => any;
171
- }
172
- /**
173
- * <p>CreateAgentResponse</p>
174
- */
175
- export interface CreateAgentResponse {
176
- /**
177
- * <p>The Amazon Resource Name (ARN) of the agent. Use the <code>ListAgents</code> operation
178
- * to return a list of agents for your account and Amazon Web Services Region.</p>
179
- */
180
- AgentArn?: string;
181
- }
182
- export declare namespace CreateAgentResponse {
183
- /**
184
- * @internal
185
- */
186
- const filterSensitiveLog: (obj: CreateAgentResponse) => any;
187
- }
188
- /**
189
- * <p>The subnet and the security group that DataSync uses to access target EFS file system.
190
- * The subnet must have at least one mount target for that file system. The security group that
191
- * you provide needs to be able to communicate with the security group on the mount target in the
192
- * subnet specified. </p>
193
- */
194
- export interface Ec2Config {
195
- /**
196
- * <p>The ARN of the subnet and the security group that DataSync uses to access the target
197
- * EFS file system.</p>
198
- */
199
- SubnetArn: string | undefined;
200
- /**
201
- * <p>The Amazon Resource Names (ARNs) of the security groups that are configured for the
202
- * Amazon EC2 resource.</p>
203
- */
204
- SecurityGroupArns: string[] | undefined;
205
- }
206
- export declare namespace Ec2Config {
207
- /**
208
- * @internal
209
- */
210
- const filterSensitiveLog: (obj: Ec2Config) => any;
211
- }
212
- /**
213
- * <p>CreateLocationEfsRequest</p>
214
- */
215
- export interface CreateLocationEfsRequest {
216
- /**
217
- * <p>A subdirectory in the location’s path. This subdirectory in the EFS file system is used
218
- * to read data from the EFS source location or write data to the EFS destination. By default,
219
- * DataSync uses the root directory.</p>
220
- * <note>
221
- * <p>
222
- * <code>Subdirectory</code> must be specified with forward slashes. For example,
223
- * <code>/path/to/folder</code>.</p>
224
- * </note>
225
- */
226
- Subdirectory?: string;
227
- /**
228
- * <p>The Amazon Resource Name (ARN) for the Amazon EFS file system.</p>
229
- */
230
- EfsFilesystemArn: string | undefined;
231
- /**
232
- * <p>The subnet and security group that the Amazon EFS file system uses. The security group
233
- * that you provide needs to be able to communicate with the security group on the mount target
234
- * in the subnet specified.</p>
235
- * <p>The exact relationship between security group M (of the mount target) and security
236
- * group S (which you provide for DataSync to use at this stage) is as follows: </p>
237
- * <ul>
238
- * <li>
239
- * <p> Security group M (which you associate with the mount target) must allow inbound
240
- * access for the Transmission Control Protocol (TCP) on the NFS port (2049) from security
241
- * group S. You can enable inbound connections either by IP address (CIDR range) or security
242
- * group. </p>
243
- * </li>
244
- * <li>
245
- * <p>Security group S (provided to DataSync to access EFS) should have a rule that
246
- * enables outbound connections to the NFS port on one of the file system’s mount targets.
247
- * You can enable outbound connections either by IP address (CIDR range) or security
248
- * group.</p>
249
- *
250
- * <p>For information about security groups and mount targets, see Security
251
- * Groups for Amazon EC2 Instances and Mount Targets in the <i>Amazon EFS User
252
- * Guide.</i>
253
- * </p>
254
- * </li>
255
- * </ul>
256
- */
257
- Ec2Config: Ec2Config | undefined;
258
- /**
259
- * <p>The key-value pair that represents a tag that you want to add to the resource. The
260
- * value can be an empty string. This value helps you manage, filter, and search for your
261
- * resources. We recommend that you create a name tag for your location.</p>
262
- */
263
- Tags?: TagListEntry[];
264
- }
265
- export declare namespace CreateLocationEfsRequest {
266
- /**
267
- * @internal
268
- */
269
- const filterSensitiveLog: (obj: CreateLocationEfsRequest) => any;
270
- }
271
- /**
272
- * <p>CreateLocationEfs</p>
273
- */
274
- export interface CreateLocationEfsResponse {
275
- /**
276
- * <p>The Amazon Resource Name (ARN) of the Amazon EFS file system location that is
277
- * created.</p>
278
- */
279
- LocationArn?: string;
280
- }
281
- export declare namespace CreateLocationEfsResponse {
282
- /**
283
- * @internal
284
- */
285
- const filterSensitiveLog: (obj: CreateLocationEfsResponse) => any;
286
- }
287
- export interface CreateLocationFsxWindowsRequest {
288
- /**
289
- * <p>A subdirectory in the location’s path. This subdirectory in the Amazon FSx for Windows
290
- * File Server file system is used to read data from the Amazon FSx for Windows File Server
291
- * source location or write data to the FSx for Windows File Server destination.</p>
292
- */
293
- Subdirectory?: string;
294
- /**
295
- * <p>The Amazon Resource Name (ARN) for the FSx for Windows File Server file system.</p>
296
- */
297
- FsxFilesystemArn: string | undefined;
298
- /**
299
- * <p>The Amazon Resource Names (ARNs) of the security groups that are to use to configure the
300
- * FSx for Windows File Server file system.</p>
301
- */
302
- SecurityGroupArns: string[] | undefined;
303
- /**
304
- * <p>The key-value pair that represents a tag that you want to add to the resource. The
305
- * value can be an empty string. This value helps you manage, filter, and search for your
306
- * resources. We recommend that you create a name tag for your location.</p>
307
- */
308
- Tags?: TagListEntry[];
309
- /**
310
- * <p>The user who has the permissions to access files and folders in the FSx for Windows File
311
- * Server file system.</p>
312
- * <p>For information about choosing a user name that ensures sufficient permissions to files,
313
- * folders, and metadata, see <a href="create-fsx-location.html#FSxWuser">user</a>.</p>
314
- */
315
- User: string | undefined;
316
- /**
317
- * <p>The name of the Windows domain that the FSx for Windows File Server belongs to.</p>
318
- */
319
- Domain?: string;
320
- /**
321
- * <p>The password of the user who has the permissions to access files and folders in the FSx
322
- * for Windows File Server file system.</p>
323
- */
324
- Password: string | undefined;
325
- }
326
- export declare namespace CreateLocationFsxWindowsRequest {
327
- /**
328
- * @internal
329
- */
330
- const filterSensitiveLog: (obj: CreateLocationFsxWindowsRequest) => any;
331
- }
332
- export interface CreateLocationFsxWindowsResponse {
333
- /**
334
- * <p>The Amazon Resource Name (ARN) of the FSx for Windows File Server file system location
335
- * that is created.</p>
336
- */
337
- LocationArn?: string;
338
- }
339
- export declare namespace CreateLocationFsxWindowsResponse {
340
- /**
341
- * @internal
342
- */
343
- const filterSensitiveLog: (obj: CreateLocationFsxWindowsResponse) => any;
344
- }
345
- export declare enum NfsVersion {
346
- AUTOMATIC = "AUTOMATIC",
347
- NFS3 = "NFS3",
348
- NFS4_0 = "NFS4_0",
349
- NFS4_1 = "NFS4_1"
350
- }
351
- /**
352
- * <p>Represents the mount options that are available for DataSync to access an NFS
353
- * location.</p>
354
- */
355
- export interface NfsMountOptions {
356
- /**
357
- * <p>The specific NFS version that you want DataSync to use to mount your NFS share. If the
358
- * server refuses to use the version specified, the sync will fail. If you don't specify a
359
- * version, DataSync defaults to <code>AUTOMATIC</code>. That is, DataSync automatically
360
- * selects a version based on negotiation with the NFS server.</p>
361
- *
362
- * <p>You can specify the following NFS versions:</p>
363
- * <ul>
364
- * <li>
365
- * <p>
366
- * <b>
367
- * <a href="https://tools.ietf.org/html/rfc1813">NFSv3</a>
368
- * </b> - stateless protocol version that allows for asynchronous
369
- * writes on the server.</p>
370
- * </li>
371
- * <li>
372
- * <p>
373
- * <b>
374
- * <a href="https://tools.ietf.org/html/rfc3530">NFSv4.0</a>
375
- * </b> - stateful, firewall-friendly protocol version that supports
376
- * delegations and pseudo filesystems.</p>
377
- * </li>
378
- * <li>
379
- * <p>
380
- * <b>
381
- * <a href="https://tools.ietf.org/html/rfc5661">NFSv4.1</a>
382
- * </b> - stateful protocol version that supports sessions,
383
- * directory delegations, and parallel data processing. Version 4.1 also includes all
384
- * features available in version 4.0.</p>
385
- * </li>
386
- * </ul>
387
- */
388
- Version?: NfsVersion | string;
389
- }
390
- export declare namespace NfsMountOptions {
391
- /**
392
- * @internal
393
- */
394
- const filterSensitiveLog: (obj: NfsMountOptions) => any;
395
- }
396
- /**
397
- * <p>A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS)
398
- * location.</p>
399
- */
400
- export interface OnPremConfig {
401
- /**
402
- * <p>ARNs of the agents to use for an NFS location.</p>
403
- */
404
- AgentArns: string[] | undefined;
405
- }
406
- export declare namespace OnPremConfig {
407
- /**
408
- * @internal
409
- */
410
- const filterSensitiveLog: (obj: OnPremConfig) => any;
411
- }
412
- /**
413
- * <p>CreateLocationNfsRequest</p>
414
- */
415
- export interface CreateLocationNfsRequest {
416
- /**
417
- * <p>The subdirectory in the NFS file system that is used to read data from the NFS source
418
- * location or write data to the NFS destination. The NFS path should be a path that's
419
- * exported by the NFS server, or a subdirectory of that path. The path should be such that it
420
- * can be mounted by other NFS clients in your network. </p>
421
- * <p>To see all the paths exported by your NFS server, run "<code>showmount -e
422
- * nfs-server-name</code>" from an NFS client that has access to your server. You can specify
423
- * any directory that appears in the results, and any subdirectory of that directory. Ensure that
424
- * the NFS export is accessible without Kerberos authentication. </p>
425
- * <p>To transfer all the data in the folder you specified, DataSync needs to have
426
- * permissions to read all the data. To ensure this, either configure the NFS export with
427
- * <code>no_root_squash,</code> or ensure that the permissions for all of the files that you
428
- * want DataSync allow read access for all users. Doing either enables the agent to read the
429
- * files. For the agent to access directories, you must additionally enable all execute
430
- * access.</p>
431
- * <p>If you are copying data to or from your Snowcone device, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone">NFS Server on Snowcone</a> for more information.</p>
432
- *
433
- * <p>For information about NFS export configuration, see 18.7. The /etc/exports
434
- * Configuration File in the Red Hat Enterprise Linux documentation.</p>
435
- */
436
- Subdirectory: string | undefined;
437
- /**
438
- * <p>The name of the NFS server. This value is the IP address or Domain Name Service (DNS)
439
- * name of the NFS server. An agent that is installed on-premises uses this host name to mount
440
- * the NFS server in a network. </p>
441
- * <p>If you are copying data to or from your Snowcone device, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone">NFS Server on Snowcone</a> for more information.</p>
442
- * <note>
443
- * <p>This name must either be DNS-compliant or must be an IP version 4 (IPv4)
444
- * address.</p>
445
- * </note>
446
- */
447
- ServerHostname: string | undefined;
448
- /**
449
- * <p>Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to
450
- * an NFS server. </p>
451
- * <p>If you are copying data to or from your Snowcone device, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone">NFS Server on Snowcone</a> for more information.</p>
452
- */
453
- OnPremConfig: OnPremConfig | undefined;
454
- /**
455
- * <p>The NFS mount options that DataSync can use to mount your NFS share.</p>
456
- */
457
- MountOptions?: NfsMountOptions;
458
- /**
459
- * <p>The key-value pair that represents the tag that you want to add to the location. The
460
- * value can be an empty string. We recommend using tags to name your resources.</p>
461
- */
462
- Tags?: TagListEntry[];
463
- }
464
- export declare namespace CreateLocationNfsRequest {
465
- /**
466
- * @internal
467
- */
468
- const filterSensitiveLog: (obj: CreateLocationNfsRequest) => any;
469
- }
470
- /**
471
- * <p>CreateLocationNfsResponse</p>
472
- */
473
- export interface CreateLocationNfsResponse {
474
- /**
475
- * <p>The Amazon Resource Name (ARN) of the source NFS file system location that is
476
- * created.</p>
477
- */
478
- LocationArn?: string;
479
- }
480
- export declare namespace CreateLocationNfsResponse {
481
- /**
482
- * @internal
483
- */
484
- const filterSensitiveLog: (obj: CreateLocationNfsResponse) => any;
485
- }
486
- export declare enum ObjectStorageServerProtocol {
487
- HTTP = "HTTP",
488
- HTTPS = "HTTPS"
489
- }
490
- /**
491
- * <p>CreateLocationObjectStorageRequest</p>
492
- */
493
- export interface CreateLocationObjectStorageRequest {
494
- /**
495
- * <p>The name of the self-managed object storage server. This value is the
496
- * IP address or Domain Name Service (DNS) name of the object storage server.
497
- * An agent uses this host name to mount the object storage server in a network. </p>
498
- */
499
- ServerHostname: string | undefined;
500
- /**
501
- * <p>The port that your self-managed object storage server accepts inbound network traffic on.
502
- * The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can
503
- * specify a custom port if your self-managed object storage server requires one.</p>
504
- */
505
- ServerPort?: number;
506
- /**
507
- * <p>The protocol that the object storage server uses to communicate.
508
- * Valid values are HTTP or HTTPS.</p>
509
- */
510
- ServerProtocol?: ObjectStorageServerProtocol | string;
511
- /**
512
- * <p>The subdirectory in the self-managed object storage server that is used
513
- * to read data from.</p>
514
- */
515
- Subdirectory?: string;
516
- /**
517
- * <p>The bucket on the self-managed object storage server that is used
518
- * to read data from.</p>
519
- */
520
- BucketName: string | undefined;
521
- /**
522
- * <p>Optional. The access key is used if credentials are required to access the self-managed
523
- * object storage server. If your object storage requires a user name and password to
524
- * authenticate, use <code>AccessKey</code> and <code>SecretKey</code> to provide the user name
525
- * and password, respectively.</p>
526
- */
527
- AccessKey?: string;
528
- /**
529
- * <p>Optional. The secret key is used if credentials are required to access the self-managed
530
- * object storage server. If your object storage requires a user name and password to
531
- * authenticate, use <code>AccessKey</code> and <code>SecretKey</code> to provide the user name
532
- * and password, respectively.</p>
533
- */
534
- SecretKey?: string;
535
- /**
536
- * <p>The Amazon Resource Name (ARN) of the agents associated with the
537
- * self-managed object storage server location.</p>
538
- */
539
- AgentArns: string[] | undefined;
540
- /**
541
- * <p>The key-value pair that represents the tag that you want to add to the location. The
542
- * value can be an empty string. We recommend using tags to name your resources.</p>
543
- */
544
- Tags?: TagListEntry[];
545
- }
546
- export declare namespace CreateLocationObjectStorageRequest {
547
- /**
548
- * @internal
549
- */
550
- const filterSensitiveLog: (obj: CreateLocationObjectStorageRequest) => any;
551
- }
552
- /**
553
- * <p>CreateLocationObjectStorageResponse</p>
554
- */
555
- export interface CreateLocationObjectStorageResponse {
556
- /**
557
- * <p>The Amazon Resource Name (ARN) of the agents associated with the
558
- * self-managed object storage server location.</p>
559
- */
560
- LocationArn?: string;
561
- }
562
- export declare namespace CreateLocationObjectStorageResponse {
563
- /**
564
- * @internal
565
- */
566
- const filterSensitiveLog: (obj: CreateLocationObjectStorageResponse) => any;
567
- }
568
- /**
569
- * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
570
- * that is used to access an Amazon S3 bucket.</p>
571
- *
572
- * <p>For detailed information about using such a role, see Creating a Location for
573
- * Amazon S3 in the <i>DataSync User Guide</i>.</p>
574
- */
575
- export interface S3Config {
576
- /**
577
- * <p>The Amazon S3 bucket to access. This bucket is used as a parameter in the
578
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateLocationS3.html">CreateLocationS3</a>
579
- * operation. </p>
580
- */
581
- BucketAccessRoleArn: string | undefined;
582
- }
583
- export declare namespace S3Config {
584
- /**
585
- * @internal
586
- */
587
- const filterSensitiveLog: (obj: S3Config) => any;
588
- }
589
- export declare enum S3StorageClass {
590
- DEEP_ARCHIVE = "DEEP_ARCHIVE",
591
- GLACIER = "GLACIER",
592
- INTELLIGENT_TIERING = "INTELLIGENT_TIERING",
593
- ONEZONE_IA = "ONEZONE_IA",
594
- OUTPOSTS = "OUTPOSTS",
595
- STANDARD = "STANDARD",
596
- STANDARD_IA = "STANDARD_IA"
597
- }
598
- /**
599
- * <p>CreateLocationS3Request</p>
600
- */
601
- export interface CreateLocationS3Request {
602
- /**
603
- * <p>A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read
604
- * data from the S3 source location or write data to the S3 destination.</p>
605
- */
606
- Subdirectory?: string;
607
- /**
608
- * <p>The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost, this must be an
609
- * access point ARN.</p>
610
- */
611
- S3BucketArn: string | undefined;
612
- /**
613
- * <p>The Amazon S3 storage class that you want to store your files in when this location is
614
- * used as a task destination. For buckets in Amazon Web Services Regions, the storage class defaults to Standard.
615
- * For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.</p>
616
- *
617
- * <p>For more information about S3 storage classes, see <a href="http://aws.amazon.com/s3/storage-classes/">Amazon S3 Storage Classes</a>. Some storage classes have behaviors that
618
- * can affect your S3 storage cost. For detailed information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Considerations when working with S3 storage classes in DataSync</a>.</p>
619
- */
620
- S3StorageClass?: S3StorageClass | string;
621
- /**
622
- * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
623
- * that is used to access an Amazon S3 bucket.</p>
624
- *
625
- * <p>For detailed information about using such a role, see Creating a Location for
626
- * Amazon S3 in the <i>DataSync User Guide</i>.</p>
627
- */
628
- S3Config: S3Config | undefined;
629
- /**
630
- * <p>If you are using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of
631
- * the DataSync agents deployed on your Outpost. For more information about launching a DataSync
632
- * agent on an Amazon Web Services Outpost, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent">Deploy your DataSync agent on Outposts</a>.</p>
633
- */
634
- AgentArns?: string[];
635
- /**
636
- * <p>The key-value pair that represents the tag that you want to add to the location. The
637
- * value can be an empty string. We recommend using tags to name your resources.</p>
638
- */
639
- Tags?: TagListEntry[];
640
- }
641
- export declare namespace CreateLocationS3Request {
642
- /**
643
- * @internal
644
- */
645
- const filterSensitiveLog: (obj: CreateLocationS3Request) => any;
646
- }
647
- /**
648
- * <p>CreateLocationS3Response</p>
649
- */
650
- export interface CreateLocationS3Response {
651
- /**
652
- * <p>The Amazon Resource Name (ARN) of the source Amazon S3 bucket location that is
653
- * created.</p>
654
- */
655
- LocationArn?: string;
656
- }
657
- export declare namespace CreateLocationS3Response {
658
- /**
659
- * @internal
660
- */
661
- const filterSensitiveLog: (obj: CreateLocationS3Response) => any;
662
- }
663
- export declare enum SmbVersion {
664
- AUTOMATIC = "AUTOMATIC",
665
- SMB2 = "SMB2",
666
- SMB3 = "SMB3"
667
- }
668
- /**
669
- * <p>Represents the mount options that are available for DataSync to access an SMB
670
- * location.</p>
671
- */
672
- export interface SmbMountOptions {
673
- /**
674
- * <p>The specific SMB version that you want DataSync to use to mount your SMB share. If you
675
- * don't specify a version, DataSync defaults to <code>AUTOMATIC</code>. That is, DataSync
676
- * automatically selects a version based on negotiation with the SMB server.</p>
677
- */
678
- Version?: SmbVersion | string;
679
- }
680
- export declare namespace SmbMountOptions {
681
- /**
682
- * @internal
683
- */
684
- const filterSensitiveLog: (obj: SmbMountOptions) => any;
685
- }
686
- /**
687
- * <p>CreateLocationSmbRequest</p>
688
- */
689
- export interface CreateLocationSmbRequest {
690
- /**
691
- * <p>The subdirectory in the SMB file system that is used to read data from the SMB source
692
- * location or write data to the SMB destination. The SMB path should be a path that's
693
- * exported by the SMB server, or a subdirectory of that path. The path should be such that it
694
- * can be mounted by other SMB clients in your network.</p>
695
- * <note>
696
- * <p>
697
- * <code>Subdirectory</code> must be specified with forward slashes. For example,
698
- * <code>/path/to/folder</code>.</p>
699
- * </note>
700
- *
701
- * <p>To transfer all the data in the folder you specified, DataSync needs to have permissions
702
- * to mount the SMB share, as well as to access all the data in that share. To ensure this,
703
- * either ensure that the user/password specified belongs to the user who can mount the share,
704
- * and who has the appropriate permissions for all of the files and directories that you want
705
- * DataSync to access, or use credentials of a member of the Backup Operators group to mount
706
- * the share. Doing either enables the agent to access the data. For the agent to access
707
- * directories, you must additionally enable all execute access.</p>
708
- */
709
- Subdirectory: string | undefined;
710
- /**
711
- * <p>The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name
712
- * of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB
713
- * server in a network.</p>
714
- * <note>
715
- * <p>This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.</p>
716
- * </note>
717
- */
718
- ServerHostname: string | undefined;
719
- /**
720
- * <p>The user who can mount the share, has the permissions to access files and folders in the
721
- * SMB share.</p>
722
- *
723
- * <p>For information about choosing a user name that ensures sufficient permissions to files,
724
- * folders, and metadata, see <a href="create-smb-location.html#SMBuser">user</a>.</p>
725
- */
726
- User: string | undefined;
727
- /**
728
- * <p>The name of the Windows domain that the SMB server belongs to.</p>
729
- */
730
- Domain?: string;
731
- /**
732
- * <p>The password of the user who can mount the share, has the permissions to access files and
733
- * folders in the SMB share.</p>
734
- */
735
- Password: string | undefined;
736
- /**
737
- * <p>The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB)
738
- * location. </p>
739
- */
740
- AgentArns: string[] | undefined;
741
- /**
742
- * <p>The mount options used by DataSync to access the SMB server.</p>
743
- */
744
- MountOptions?: SmbMountOptions;
745
- /**
746
- * <p>The key-value pair that represents the tag that you want to add to the location. The value
747
- * can be an empty string. We recommend using tags to name your resources.</p>
748
- */
749
- Tags?: TagListEntry[];
750
- }
751
- export declare namespace CreateLocationSmbRequest {
752
- /**
753
- * @internal
754
- */
755
- const filterSensitiveLog: (obj: CreateLocationSmbRequest) => any;
756
- }
757
- /**
758
- * <p>CreateLocationSmbResponse</p>
759
- */
760
- export interface CreateLocationSmbResponse {
761
- /**
762
- * <p>The Amazon Resource Name (ARN) of the source SMB file system location that is
763
- * created.</p>
764
- */
765
- LocationArn?: string;
766
- }
767
- export declare namespace CreateLocationSmbResponse {
768
- /**
769
- * @internal
770
- */
771
- const filterSensitiveLog: (obj: CreateLocationSmbResponse) => any;
772
- }
773
- export declare enum FilterType {
774
- SIMPLE_PATTERN = "SIMPLE_PATTERN"
775
- }
776
- /**
777
- * <p>Specifies which files, folders, and objects to include or exclude when transferring files
778
- * from source to destination.</p>
779
- */
780
- export interface FilterRule {
781
- /**
782
- * <p>The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN rule
783
- * type.</p>
784
- */
785
- FilterType?: FilterType | string;
786
- /**
787
- * <p>A single filter string that consists of the patterns to include or exclude. The patterns
788
- * are delimited by "|" (that is, a pipe), for example: <code>/folder1|/folder2</code>
789
- * </p>
790
- * <p>
791
- * </p>
792
- */
793
- Value?: string;
794
- }
795
- export declare namespace FilterRule {
796
- /**
797
- * @internal
798
- */
799
- const filterSensitiveLog: (obj: FilterRule) => any;
800
- }
801
- export declare enum Gid {
802
- BOTH = "BOTH",
803
- INT_VALUE = "INT_VALUE",
804
- NAME = "NAME",
805
- NONE = "NONE"
806
- }
807
- export declare enum LogLevel {
808
- BASIC = "BASIC",
809
- OFF = "OFF",
810
- TRANSFER = "TRANSFER"
811
- }
812
- export declare enum Mtime {
813
- NONE = "NONE",
814
- PRESERVE = "PRESERVE"
815
- }
816
- export declare enum OverwriteMode {
817
- ALWAYS = "ALWAYS",
818
- NEVER = "NEVER"
819
- }
820
- export declare enum PosixPermissions {
821
- NONE = "NONE",
822
- PRESERVE = "PRESERVE"
823
- }
824
- export declare enum PreserveDeletedFiles {
825
- PRESERVE = "PRESERVE",
826
- REMOVE = "REMOVE"
827
- }
828
- export declare enum PreserveDevices {
829
- NONE = "NONE",
830
- PRESERVE = "PRESERVE"
831
- }
832
- export declare enum SmbSecurityDescriptorCopyFlags {
833
- NONE = "NONE",
834
- OWNER_DACL = "OWNER_DACL",
835
- OWNER_DACL_SACL = "OWNER_DACL_SACL"
836
- }
837
- export declare enum TaskQueueing {
838
- DISABLED = "DISABLED",
839
- ENABLED = "ENABLED"
840
- }
841
- export declare enum TransferMode {
842
- ALL = "ALL",
843
- CHANGED = "CHANGED"
844
- }
845
- export declare enum Uid {
846
- BOTH = "BOTH",
847
- INT_VALUE = "INT_VALUE",
848
- NAME = "NAME",
849
- NONE = "NONE"
850
- }
851
- export declare enum VerifyMode {
852
- NONE = "NONE",
853
- ONLY_FILES_TRANSFERRED = "ONLY_FILES_TRANSFERRED",
854
- POINT_IN_TIME_CONSISTENT = "POINT_IN_TIME_CONSISTENT"
855
- }
856
- /**
857
- * <p>Represents the options that are available to control the behavior of a
858
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>
859
- * operation. Behavior includes preserving metadata such as user
860
- * ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination,
861
- * data integrity verification, and so on.</p>
862
- * <p>A task has a set of default options associated with it. If you don't specify an option
863
- * in <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>,
864
- * the default value is used. You can override the
865
- * defaults options on each task execution by specifying an overriding <code>Options</code> value
866
- * to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
867
- */
868
- export interface Options {
869
- /**
870
- * <p>A value that determines whether a data integrity verification should be performed at
871
- * the end of a task execution after all data and metadata have been transferred.
872
- * For more information, see
873
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html">Configure task settings</a>.
874
- * </p>
875
- * <p>Default value: POINT_IN_TIME_CONSISTENT.</p>
876
- * <p>ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.
877
- * </p>
878
- *
879
- * <p>POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination
880
- * at the end of the transfer
881
- * to verify that source and destination are fully
882
- * synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier
883
- * Deep Archive storage classes.</p>
884
- * <p>NONE: No additional verification is done at the end of the
885
- * transfer, but all data transmissions are integrity-checked with
886
- * checksum verification during the transfer.</p>
887
- */
888
- VerifyMode?: VerifyMode | string;
889
- /**
890
- * <p>A value that determines whether files at the destination should be overwritten or
891
- * preserved when copying files. If set to <code>NEVER</code> a destination file will not be
892
- * replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to
893
- * protect against overwriting those changes. </p>
894
- * <p>Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see
895
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Considerations when working with Amazon S3 storage classes in DataSync </a>
896
- * in the <i>DataSync
897
- * User Guide</i>.</p>
898
- */
899
- OverwriteMode?: OverwriteMode | string;
900
- /**
901
- * <p>A file metadata value that shows the last time a file was accessed (that is, when the
902
- * file was read or written to). If you set <code>Atime</code> to BEST_EFFORT, DataSync
903
- * attempts to preserve the original <code>Atime</code> attribute on all source files (that is,
904
- * the version before the PREPARING phase). However, <code>Atime</code>'s behavior is not
905
- * fully standard across platforms, so DataSync can only do this on a best-effort basis. </p>
906
- * <p>Default value: BEST_EFFORT.</p>
907
- * <p>BEST_EFFORT: Attempt to preserve the per-file <code>Atime</code> value
908
- * (recommended).</p>
909
- * <p>NONE: Ignore <code>Atime</code>.</p>
910
- * <note>
911
- * <p>If <code>Atime</code> is set to BEST_EFFORT, <code>Mtime</code> must be set to PRESERVE. </p>
912
- * <p>If <code>Atime</code> is set to NONE, <code>Mtime</code> must also be NONE. </p>
913
- * </note>
914
- */
915
- Atime?: Atime | string;
916
- /**
917
- * <p>A value that indicates the last time that a file was modified (that is, a file was
918
- * written to) before the PREPARING phase. This option is required for cases when you need to run
919
- * the same task more than one time. </p>
920
- * <p>Default value: PRESERVE. </p>
921
- * <p>PRESERVE: Preserve original <code>Mtime</code> (recommended)</p>
922
- * <p> NONE: Ignore <code>Mtime</code>. </p>
923
- * <note>
924
- * <p>If <code>Mtime</code> is set to PRESERVE, <code>Atime</code> must be set to
925
- * BEST_EFFORT.</p>
926
- * <p>If <code>Mtime</code> is set to NONE, <code>Atime</code> must also be set to NONE.
927
- * </p>
928
- * </note>
929
- */
930
- Mtime?: Mtime | string;
931
- /**
932
- * <p>The POSIX user ID (UID) of the file's owner. This option should only be set for NFS,
933
- * EFS, and S3 locations. To learn more about what metadata is copied by DataSync, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied">Metadata Copied by DataSync</a>.</p>
934
- * <p>Default value: INT_VALUE. This preserves the integer value of the ID.</p>
935
- * <p>INT_VALUE: Preserve the integer value of UID and group ID (GID)
936
- * (recommended).</p>
937
- * <p>NONE: Ignore UID and GID. </p>
938
- */
939
- Uid?: Uid | string;
940
- /**
941
- * <p>The POSIX group ID (GID) of the file's owners. This option should only be set for
942
- * NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync,
943
- * see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied">Metadata Copied by DataSync</a>. </p>
944
- * <p>Default value: INT_VALUE. This preserves the integer value of the ID.</p>
945
- * <p>INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).</p>
946
- * <p>NONE: Ignore UID and GID. </p>
947
- */
948
- Gid?: Gid | string;
949
- /**
950
- * <p>A value that specifies whether files in the destination that don't exist in the source
951
- * file system should be preserved. This option can affect your storage cost.
952
- * If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed
953
- * information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Considerations when working with Amazon S3 storage classes in DataSync </a> in the <i>DataSync User
954
- * Guide</i>.</p>
955
- * <p>Default value: PRESERVE.</p>
956
- * <p>PRESERVE: Ignore such destination files (recommended). </p>
957
- * <p>REMOVE: Delete destination files that aren’t present in the source.</p>
958
- */
959
- PreserveDeletedFiles?: PreserveDeletedFiles | string;
960
- /**
961
- * <p>A value that determines whether DataSync should preserve the metadata of block
962
- * and character devices in the source file system, and re-create the files with that device name
963
- * and metadata on the destination. DataSync does not copy the contents of such devices, only the
964
- * name and metadata. </p>
965
- * <note>
966
- * <p>DataSync can't sync the actual contents of such devices, because they are
967
- * nonterminal and don't return an end-of-file (EOF) marker.</p>
968
- * </note>
969
- * <p>Default value: NONE.</p>
970
- * <p>NONE: Ignore special devices (recommended). </p>
971
- * <p>PRESERVE: Preserve character and block device metadata. This option isn't currently
972
- * supported for Amazon EFS. </p>
973
- */
974
- PreserveDevices?: PreserveDevices | string;
975
- /**
976
- * <p>A value that determines which users or groups can access a file for a specific purpose
977
- * such as reading, writing, or execution of the file. This option should only be set for NFS,
978
- * EFS, and S3 locations. For more information about what metadata is copied by DataSync, see
979
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied">Metadata Copied by DataSync</a>. </p>
980
- * <p>Default value: PRESERVE.</p>
981
- * <p>PRESERVE: Preserve POSIX-style permissions (recommended).</p>
982
- * <p>NONE: Ignore permissions. </p>
983
- * <note>
984
- * <p>DataSync can preserve extant permissions of a source location.</p>
985
- * </note>
986
- */
987
- PosixPermissions?: PosixPermissions | string;
988
- /**
989
- * <p>A value that limits the bandwidth used by DataSync. For example, if you want
990
- * DataSync to use a maximum of 1 MB, set this value to <code>1048576</code>
991
- * (<code>=1024*1024</code>).</p>
992
- */
993
- BytesPerSecond?: number;
994
- /**
995
- * <p>A value that determines whether tasks should be queued before executing the tasks. If set
996
- * to <code>ENABLED</code>, the tasks will be queued. The default is <code>ENABLED</code>.</p>
997
- * <p>If you use the same agent to run multiple tasks, you can enable the tasks to run in
998
- * series. For more information, see
999
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#queue-task-execution">Queueing task executions</a>.</p>
1000
- */
1001
- TaskQueueing?: TaskQueueing | string;
1002
- /**
1003
- * <p>A value that determines the type of logs that DataSync publishes to a log stream in the
1004
- * Amazon CloudWatch log group that you provide. For more information about providing a log group
1005
- * for DataSync, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn">CloudWatchLogGroupArn</a>. If set to <code>OFF</code>, no logs are published.
1006
- * <code>BASIC</code> publishes logs on errors for individual files transferred, and
1007
- * <code>TRANSFER</code> publishes logs for every file or object that is transferred and
1008
- * integrity checked.</p>
1009
- */
1010
- LogLevel?: LogLevel | string;
1011
- /**
1012
- * <p>A value that determines whether DataSync transfers only the data and metadata that differ between the source
1013
- * and the destination location, or whether DataSync transfers all the content from the source, without comparing to
1014
- * the destination location. </p>
1015
- * <p>CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the
1016
- * destination location.</p>
1017
- * <p>ALL: DataSync copies all source location content to the destination, without comparing to existing content on
1018
- * the destination.</p>
1019
- */
1020
- TransferMode?: TransferMode | string;
1021
- /**
1022
- * <p>A value that determines which components of the SMB security descriptor are copied from source
1023
- * to destination objects.
1024
- * </p>
1025
- * <p>This value is only used for transfers
1026
- * between SMB and Amazon FSx for Windows File Server locations, or between two Amazon FSx for Windows File
1027
- * Server locations. For more information about how
1028
- * DataSync handles metadata, see
1029
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html">How DataSync Handles Metadata and Special Files</a>.
1030
- * </p>
1031
- * <p>Default value: OWNER_DACL.</p>
1032
- *
1033
- * <p>
1034
- * <b>OWNER_DACL</b>: For each copied object, DataSync copies the following metadata:</p>
1035
- * <ul>
1036
- * <li>
1037
- * <p>Object owner.</p>
1038
- * </li>
1039
- * <li>
1040
- * <p>NTFS discretionary access control lists (DACLs), which determine whether to
1041
- * grant access to an object.</p>
1042
- * </li>
1043
- * </ul>
1044
- * <p>When choosing this option, DataSync does NOT copy the NTFS system access control lists
1045
- * (SACLs), which are used by administrators to log attempts to access a secured object.</p>
1046
- *
1047
- * <p>
1048
- * <b>OWNER_DACL_SACL</b>: For each copied object, DataSync copies the following metadata:</p>
1049
- * <ul>
1050
- * <li>
1051
- * <p>Object owner.</p>
1052
- * </li>
1053
- * <li>
1054
- * <p>NTFS discretionary access control lists (DACLs), which determine whether to
1055
- * grant access to an object.</p>
1056
- * </li>
1057
- * <li>
1058
- * <p>NTFS system access control lists (SACLs), which are used by administrators
1059
- * to log attempts to access a secured object.</p>
1060
- * </li>
1061
- * </ul>
1062
- * <p>Copying SACLs requires granting additional permissions to the Windows user that DataSync
1063
- * uses to access your SMB location. For information about choosing a user that ensures
1064
- * sufficient permissions to files, folders, and metadata, see <a href="create-smb-location.html#SMBuser">user</a>.</p>
1065
- *
1066
- * <p>
1067
- * <b>NONE</b>: None of the SMB security descriptor components
1068
- * are copied. Destination objects are owned by the user that was provided for accessing the
1069
- * destination location. DACLs and SACLs are set based on the destination server’s configuration.
1070
- * </p>
1071
- */
1072
- SecurityDescriptorCopyFlags?: SmbSecurityDescriptorCopyFlags | string;
1073
- }
1074
- export declare namespace Options {
1075
- /**
1076
- * @internal
1077
- */
1078
- const filterSensitiveLog: (obj: Options) => any;
1079
- }
1080
- /**
1081
- * <p>Specifies the schedule you want your task to use for repeated executions. For more
1082
- * information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html">Schedule Expressions for Rules</a>.</p>
1083
- */
1084
- export interface TaskSchedule {
1085
- /**
1086
- * <p>A cron expression that specifies when DataSync initiates a scheduled transfer from a
1087
- * source to a destination location. </p>
1088
- */
1089
- ScheduleExpression: string | undefined;
1090
- }
1091
- export declare namespace TaskSchedule {
1092
- /**
1093
- * @internal
1094
- */
1095
- const filterSensitiveLog: (obj: TaskSchedule) => any;
1096
- }
1097
- /**
1098
- * <p>CreateTaskRequest</p>
1099
- */
1100
- export interface CreateTaskRequest {
1101
- /**
1102
- * <p>The Amazon Resource Name (ARN) of the source location for the task.</p>
1103
- */
1104
- SourceLocationArn: string | undefined;
1105
- /**
1106
- * <p>The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location. </p>
1107
- */
1108
- DestinationLocationArn: string | undefined;
1109
- /**
1110
- * <p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to
1111
- * monitor and log events in the task. </p>
1112
- */
1113
- CloudWatchLogGroupArn?: string;
1114
- /**
1115
- * <p>The name of a task. This value is a text reference that is used to identify the task in
1116
- * the console. </p>
1117
- */
1118
- Name?: string;
1119
- /**
1120
- * <p>The set of configuration options that control the behavior of a single execution of the
1121
- * task that occurs when you call <code>StartTaskExecution</code>. You can configure these
1122
- * options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data
1123
- * integrity verification, and so on.</p>
1124
- * <p>For each individual task execution, you can override these options by specifying the
1125
- * <code>OverrideOptions</code> before starting the task execution. For more information, see
1126
- * the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a> operation. </p>
1127
- */
1128
- Options?: Options;
1129
- /**
1130
- * <p>A list of filter rules that determines which files to exclude from a task. The list should
1131
- * contain a single filter string that consists of the patterns to exclude. The patterns are
1132
- * delimited by "|" (that is, a pipe), for example, <code>"/folder1|/folder2"</code>. </p>
1133
- * <p>
1134
- * </p>
1135
- */
1136
- Excludes?: FilterRule[];
1137
- /**
1138
- * <p>Specifies a schedule used to periodically transfer files from a source to a destination
1139
- * location. The schedule should be specified in UTC time. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html">Scheduling your task</a>.</p>
1140
- */
1141
- Schedule?: TaskSchedule;
1142
- /**
1143
- * <p>The key-value pair that represents the tag that you want to add to the resource. The
1144
- * value can be an empty string. </p>
1145
- */
1146
- Tags?: TagListEntry[];
1147
- /**
1148
- * <p>A list of filter rules that determines which files to include when running a task. The
1149
- * pattern should contain a single filter string that consists of the patterns to include. The
1150
- * patterns are delimited by "|" (that is, a pipe). For example:
1151
- * <code>"/folder1|/folder2</code>"</p>
1152
- */
1153
- Includes?: FilterRule[];
1154
- }
1155
- export declare namespace CreateTaskRequest {
1156
- /**
1157
- * @internal
1158
- */
1159
- const filterSensitiveLog: (obj: CreateTaskRequest) => any;
1160
- }
1161
- /**
1162
- * <p>CreateTaskResponse</p>
1163
- */
1164
- export interface CreateTaskResponse {
1165
- /**
1166
- * <p>The Amazon Resource Name (ARN) of the task.</p>
1167
- */
1168
- TaskArn?: string;
1169
- }
1170
- export declare namespace CreateTaskResponse {
1171
- /**
1172
- * @internal
1173
- */
1174
- const filterSensitiveLog: (obj: CreateTaskResponse) => any;
1175
- }
1176
- /**
1177
- * <p>DeleteAgentRequest</p>
1178
- */
1179
- export interface DeleteAgentRequest {
1180
- /**
1181
- * <p>The Amazon Resource Name (ARN) of the agent to delete. Use the <code>ListAgents</code>
1182
- * operation to return a list of agents for your account and Amazon Web Services Region.</p>
1183
- */
1184
- AgentArn: string | undefined;
1185
- }
1186
- export declare namespace DeleteAgentRequest {
1187
- /**
1188
- * @internal
1189
- */
1190
- const filterSensitiveLog: (obj: DeleteAgentRequest) => any;
1191
- }
1192
- export interface DeleteAgentResponse {
1193
- }
1194
- export declare namespace DeleteAgentResponse {
1195
- /**
1196
- * @internal
1197
- */
1198
- const filterSensitiveLog: (obj: DeleteAgentResponse) => any;
1199
- }
1200
- /**
1201
- * <p>DeleteLocation</p>
1202
- */
1203
- export interface DeleteLocationRequest {
1204
- /**
1205
- * <p>The Amazon Resource Name (ARN) of the location to delete.</p>
1206
- */
1207
- LocationArn: string | undefined;
1208
- }
1209
- export declare namespace DeleteLocationRequest {
1210
- /**
1211
- * @internal
1212
- */
1213
- const filterSensitiveLog: (obj: DeleteLocationRequest) => any;
1214
- }
1215
- export interface DeleteLocationResponse {
1216
- }
1217
- export declare namespace DeleteLocationResponse {
1218
- /**
1219
- * @internal
1220
- */
1221
- const filterSensitiveLog: (obj: DeleteLocationResponse) => any;
1222
- }
1223
- /**
1224
- * <p>DeleteTask</p>
1225
- */
1226
- export interface DeleteTaskRequest {
1227
- /**
1228
- * <p>The Amazon Resource Name (ARN) of the task to delete.</p>
1229
- */
1230
- TaskArn: string | undefined;
1231
- }
1232
- export declare namespace DeleteTaskRequest {
1233
- /**
1234
- * @internal
1235
- */
1236
- const filterSensitiveLog: (obj: DeleteTaskRequest) => any;
1237
- }
1238
- export interface DeleteTaskResponse {
1239
- }
1240
- export declare namespace DeleteTaskResponse {
1241
- /**
1242
- * @internal
1243
- */
1244
- const filterSensitiveLog: (obj: DeleteTaskResponse) => any;
1245
- }
1246
- /**
1247
- * <p>DescribeAgent</p>
1248
- */
1249
- export interface DescribeAgentRequest {
1250
- /**
1251
- * <p>The Amazon Resource Name (ARN) of the agent to describe.</p>
1252
- */
1253
- AgentArn: string | undefined;
1254
- }
1255
- export declare namespace DescribeAgentRequest {
1256
- /**
1257
- * @internal
1258
- */
1259
- const filterSensitiveLog: (obj: DescribeAgentRequest) => any;
1260
- }
1261
- export declare enum EndpointType {
1262
- FIPS = "FIPS",
1263
- PRIVATE_LINK = "PRIVATE_LINK",
1264
- PUBLIC = "PUBLIC"
1265
- }
1266
- /**
1267
- * <p>The VPC endpoint, subnet, and security group that an agent uses to access IP addresses in
1268
- * a VPC (Virtual Private Cloud).</p>
1269
- */
1270
- export interface PrivateLinkConfig {
1271
- /**
1272
- * <p>The ID of the VPC endpoint that is configured for an agent. An agent that is configured
1273
- * with a VPC endpoint will not be accessible over the public internet.</p>
1274
- */
1275
- VpcEndpointId?: string;
1276
- /**
1277
- * <p>The private endpoint that is configured for an agent that has access to IP addresses in a
1278
- * <a href="https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html">PrivateLink</a>. An agent that is configured with this endpoint will not be accessible
1279
- * over the public internet.</p>
1280
- */
1281
- PrivateLinkEndpoint?: string;
1282
- /**
1283
- * <p>The Amazon Resource Names (ARNs) of the subnets that are configured for an agent activated
1284
- * in a VPC or an agent that has access to a VPC endpoint.</p>
1285
- */
1286
- SubnetArns?: string[];
1287
- /**
1288
- * <p>The Amazon Resource Names (ARNs) of the security groups that are configured for the EC2
1289
- * resource that hosts an agent activated in a VPC or an agent that has access to a VPC
1290
- * endpoint.</p>
1291
- */
1292
- SecurityGroupArns?: string[];
1293
- }
1294
- export declare namespace PrivateLinkConfig {
1295
- /**
1296
- * @internal
1297
- */
1298
- const filterSensitiveLog: (obj: PrivateLinkConfig) => any;
1299
- }
1300
- /**
1301
- * <p>DescribeAgentResponse</p>
1302
- */
1303
- export interface DescribeAgentResponse {
1304
- /**
1305
- * <p>The Amazon Resource Name (ARN) of the agent.</p>
1306
- */
1307
- AgentArn?: string;
1308
- /**
1309
- * <p>The name of the agent.</p>
1310
- */
1311
- Name?: string;
1312
- /**
1313
- * <p>The status of the agent. If the status is ONLINE, then the agent is configured properly
1314
- * and is available to use. The Running status is the normal running status for an agent. If the
1315
- * status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When
1316
- * the issue that caused the unhealthy state is resolved, the agent returns to ONLINE
1317
- * status.</p>
1318
- */
1319
- Status?: AgentStatus | string;
1320
- /**
1321
- * <p>The time that the agent last connected to DataSync.</p>
1322
- */
1323
- LastConnectionTime?: Date;
1324
- /**
1325
- * <p>The time that the agent was activated (that is, created in your account).</p>
1326
- */
1327
- CreationTime?: Date;
1328
- /**
1329
- * <p>The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint,
1330
- * the agent is not accessible over the public internet. </p>
1331
- */
1332
- EndpointType?: EndpointType | string;
1333
- /**
1334
- * <p>The subnet and the security group that DataSync used to access a VPC endpoint.</p>
1335
- */
1336
- PrivateLinkConfig?: PrivateLinkConfig;
1337
- }
1338
- export declare namespace DescribeAgentResponse {
1339
- /**
1340
- * @internal
1341
- */
1342
- const filterSensitiveLog: (obj: DescribeAgentResponse) => any;
1343
- }
1344
- /**
1345
- * <p>DescribeLocationEfsRequest</p>
1346
- */
1347
- export interface DescribeLocationEfsRequest {
1348
- /**
1349
- * <p>The Amazon Resource Name (ARN) of the EFS location to describe.</p>
1350
- */
1351
- LocationArn: string | undefined;
1352
- }
1353
- export declare namespace DescribeLocationEfsRequest {
1354
- /**
1355
- * @internal
1356
- */
1357
- const filterSensitiveLog: (obj: DescribeLocationEfsRequest) => any;
1358
- }
1359
- /**
1360
- * <p>DescribeLocationEfsResponse</p>
1361
- */
1362
- export interface DescribeLocationEfsResponse {
1363
- /**
1364
- * <p>The Amazon Resource Name (ARN) of the EFS location that was described.</p>
1365
- */
1366
- LocationArn?: string;
1367
- /**
1368
- * <p>The URL of the EFS location that was described.</p>
1369
- */
1370
- LocationUri?: string;
1371
- /**
1372
- * <p>The subnet and the security group that DataSync uses to access target EFS file system.
1373
- * The subnet must have at least one mount target for that file system. The security group that
1374
- * you provide needs to be able to communicate with the security group on the mount target in the
1375
- * subnet specified. </p>
1376
- */
1377
- Ec2Config?: Ec2Config;
1378
- /**
1379
- * <p>The time that the EFS location was created.</p>
1380
- */
1381
- CreationTime?: Date;
1382
- }
1383
- export declare namespace DescribeLocationEfsResponse {
1384
- /**
1385
- * @internal
1386
- */
1387
- const filterSensitiveLog: (obj: DescribeLocationEfsResponse) => any;
1388
- }
1389
- export interface DescribeLocationFsxWindowsRequest {
1390
- /**
1391
- * <p>The Amazon Resource Name (ARN) of the FSx for Windows File Server location to
1392
- * describe.</p>
1393
- */
1394
- LocationArn: string | undefined;
1395
- }
1396
- export declare namespace DescribeLocationFsxWindowsRequest {
1397
- /**
1398
- * @internal
1399
- */
1400
- const filterSensitiveLog: (obj: DescribeLocationFsxWindowsRequest) => any;
1401
- }
1402
- export interface DescribeLocationFsxWindowsResponse {
1403
- /**
1404
- * <p>The Amazon Resource Name (ARN) of the FSx for Windows File Server location that was
1405
- * described.</p>
1406
- */
1407
- LocationArn?: string;
1408
- /**
1409
- * <p>The URL of the FSx for Windows File Server location that was described.</p>
1410
- */
1411
- LocationUri?: string;
1412
- /**
1413
- * <p>The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx
1414
- * for Windows File Server file system.</p>
1415
- */
1416
- SecurityGroupArns?: string[];
1417
- /**
1418
- * <p>The time that the FSx for Windows File Server location was created.</p>
1419
- */
1420
- CreationTime?: Date;
1421
- /**
1422
- * <p>The user who has the permissions to access files and folders in the FSx for Windows File
1423
- * Server file system.</p>
1424
- */
1425
- User?: string;
1426
- /**
1427
- * <p>The name of the Windows domain that the FSx for Windows File Server belongs to.</p>
1428
- */
1429
- Domain?: string;
1430
- }
1431
- export declare namespace DescribeLocationFsxWindowsResponse {
1432
- /**
1433
- * @internal
1434
- */
1435
- const filterSensitiveLog: (obj: DescribeLocationFsxWindowsResponse) => any;
1436
- }
1437
- /**
1438
- * <p>DescribeLocationNfsRequest</p>
1439
- */
1440
- export interface DescribeLocationNfsRequest {
1441
- /**
1442
- * <p>The Amazon Resource Name (ARN) of the NFS location to describe.</p>
1443
- */
1444
- LocationArn: string | undefined;
1445
- }
1446
- export declare namespace DescribeLocationNfsRequest {
1447
- /**
1448
- * @internal
1449
- */
1450
- const filterSensitiveLog: (obj: DescribeLocationNfsRequest) => any;
1451
- }
1452
- /**
1453
- * <p>DescribeLocationNfsResponse</p>
1454
- */
1455
- export interface DescribeLocationNfsResponse {
1456
- /**
1457
- * <p>The Amazon Resource Name (ARN) of the NFS location that was described.</p>
1458
- */
1459
- LocationArn?: string;
1460
- /**
1461
- * <p>The URL of the source NFS location that was described.</p>
1462
- */
1463
- LocationUri?: string;
1464
- /**
1465
- * <p>A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS)
1466
- * location.</p>
1467
- */
1468
- OnPremConfig?: OnPremConfig;
1469
- /**
1470
- * <p>The NFS mount options that DataSync used to mount your NFS share.</p>
1471
- */
1472
- MountOptions?: NfsMountOptions;
1473
- /**
1474
- * <p>The time that the NFS location was created.</p>
1475
- */
1476
- CreationTime?: Date;
1477
- }
1478
- export declare namespace DescribeLocationNfsResponse {
1479
- /**
1480
- * @internal
1481
- */
1482
- const filterSensitiveLog: (obj: DescribeLocationNfsResponse) => any;
1483
- }
1484
- /**
1485
- * <p>DescribeLocationObjectStorageRequest</p>
1486
- */
1487
- export interface DescribeLocationObjectStorageRequest {
1488
- /**
1489
- * <p>The Amazon Resource Name (ARN) of the self-managed object storage server location that was described.</p>
1490
- */
1491
- LocationArn: string | undefined;
1492
- }
1493
- export declare namespace DescribeLocationObjectStorageRequest {
1494
- /**
1495
- * @internal
1496
- */
1497
- const filterSensitiveLog: (obj: DescribeLocationObjectStorageRequest) => any;
1498
- }
1499
- /**
1500
- * <p>DescribeLocationObjectStorageResponse</p>
1501
- */
1502
- export interface DescribeLocationObjectStorageResponse {
1503
- /**
1504
- * <p>The Amazon Resource Name (ARN) of the self-managed object storage server location to describe.</p>
1505
- */
1506
- LocationArn?: string;
1507
- /**
1508
- * <p>The URL of the source self-managed object storage server location that was described.</p>
1509
- */
1510
- LocationUri?: string;
1511
- /**
1512
- * <p>Optional. The access key is used if credentials are required to access the self-managed
1513
- * object storage server. If your object storage requires a user name and password to
1514
- * authenticate, use <code>AccessKey</code> and <code>SecretKey</code> to provide the user name
1515
- * and password, respectively.</p>
1516
- */
1517
- AccessKey?: string;
1518
- /**
1519
- * <p>The port that your self-managed object storage server accepts inbound network traffic on.
1520
- * The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS).</p>
1521
- */
1522
- ServerPort?: number;
1523
- /**
1524
- * <p>The protocol that the object storage server uses to communicate.
1525
- * Valid values are HTTP or HTTPS.</p>
1526
- */
1527
- ServerProtocol?: ObjectStorageServerProtocol | string;
1528
- /**
1529
- * <p>The Amazon Resource Name (ARN) of the agents associated with the
1530
- * self-managed object storage server location.</p>
1531
- */
1532
- AgentArns?: string[];
1533
- /**
1534
- * <p>The time that the self-managed object storage server agent was created.</p>
1535
- */
1536
- CreationTime?: Date;
1537
- }
1538
- export declare namespace DescribeLocationObjectStorageResponse {
1539
- /**
1540
- * @internal
1541
- */
1542
- const filterSensitiveLog: (obj: DescribeLocationObjectStorageResponse) => any;
1543
- }
1544
- /**
1545
- * <p>DescribeLocationS3Request</p>
1546
- */
1547
- export interface DescribeLocationS3Request {
1548
- /**
1549
- * <p>The Amazon Resource Name (ARN) of the Amazon S3 bucket location to describe.</p>
1550
- */
1551
- LocationArn: string | undefined;
1552
- }
1553
- export declare namespace DescribeLocationS3Request {
1554
- /**
1555
- * @internal
1556
- */
1557
- const filterSensitiveLog: (obj: DescribeLocationS3Request) => any;
1558
- }
1559
- /**
1560
- * <p>DescribeLocationS3Response</p>
1561
- */
1562
- export interface DescribeLocationS3Response {
1563
- /**
1564
- * <p>The Amazon Resource Name (ARN) of the Amazon S3 bucket or access point.</p>
1565
- */
1566
- LocationArn?: string;
1567
- /**
1568
- * <p>The URL of the Amazon S3 location that was described.</p>
1569
- */
1570
- LocationUri?: string;
1571
- /**
1572
- * <p>The Amazon S3 storage class that you chose to store your files in when this location is
1573
- * used as a task destination. For more information about S3 storage classes, see <a href="http://aws.amazon.com/s3/storage-classes/">Amazon S3 Storage Classes</a>. Some storage
1574
- * classes have behaviors that can affect your S3 storage cost. For detailed information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Considerations when
1575
- * working with S3 storage classes in DataSync</a>.</p>
1576
- */
1577
- S3StorageClass?: S3StorageClass | string;
1578
- /**
1579
- * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
1580
- * that is used to access an Amazon S3 bucket.</p>
1581
- *
1582
- * <p>For detailed information about using such a role, see Creating a Location for
1583
- * Amazon S3 in the <i>DataSync User Guide</i>.</p>
1584
- */
1585
- S3Config?: S3Config;
1586
- /**
1587
- * <p>If you are using DataSync on an Amazon Web Services Outpost, the Amazon Resource Name (ARNs) of the EC2
1588
- * agents deployed on your Outpost. For more information about launching a DataSync agent on an
1589
- * Amazon Web Services Outpost, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent">Deploy your DataSync agent on Outposts</a>.</p>
1590
- */
1591
- AgentArns?: string[];
1592
- /**
1593
- * <p>The time that the Amazon S3 bucket location was created.</p>
1594
- */
1595
- CreationTime?: Date;
1596
- }
1597
- export declare namespace DescribeLocationS3Response {
1598
- /**
1599
- * @internal
1600
- */
1601
- const filterSensitiveLog: (obj: DescribeLocationS3Response) => any;
1602
- }
1603
- /**
1604
- * <p>DescribeLocationSmbRequest</p>
1605
- */
1606
- export interface DescribeLocationSmbRequest {
1607
- /**
1608
- * <p>The Amazon Resource Name (ARN) of the SMB location to describe.</p>
1609
- */
1610
- LocationArn: string | undefined;
1611
- }
1612
- export declare namespace DescribeLocationSmbRequest {
1613
- /**
1614
- * @internal
1615
- */
1616
- const filterSensitiveLog: (obj: DescribeLocationSmbRequest) => any;
1617
- }
1618
- /**
1619
- * <p>DescribeLocationSmbResponse</p>
1620
- */
1621
- export interface DescribeLocationSmbResponse {
1622
- /**
1623
- * <p>The Amazon Resource Name (ARN) of the SMB location that was described.</p>
1624
- */
1625
- LocationArn?: string;
1626
- /**
1627
- * <p>The URL of the source SMB location that was described.</p>
1628
- */
1629
- LocationUri?: string;
1630
- /**
1631
- * <p>The Amazon Resource Name (ARN) of the source SMB file system location that is
1632
- * created.</p>
1633
- */
1634
- AgentArns?: string[];
1635
- /**
1636
- * <p>The user who can mount the share, has the permissions to access files and folders in the
1637
- * SMB share.</p>
1638
- */
1639
- User?: string;
1640
- /**
1641
- * <p>The name of the Windows domain that the SMB server belongs to.</p>
1642
- */
1643
- Domain?: string;
1644
- /**
1645
- * <p>The mount options that are available for DataSync to use to access an SMB location.</p>
1646
- */
1647
- MountOptions?: SmbMountOptions;
1648
- /**
1649
- * <p>The time that the SMB location was created.</p>
1650
- */
1651
- CreationTime?: Date;
1652
- }
1653
- export declare namespace DescribeLocationSmbResponse {
1654
- /**
1655
- * @internal
1656
- */
1657
- const filterSensitiveLog: (obj: DescribeLocationSmbResponse) => any;
1658
- }
1659
- /**
1660
- * <p>DescribeTaskRequest</p>
1661
- */
1662
- export interface DescribeTaskRequest {
1663
- /**
1664
- * <p>The Amazon Resource Name (ARN) of the task to describe.</p>
1665
- */
1666
- TaskArn: string | undefined;
1667
- }
1668
- export declare namespace DescribeTaskRequest {
1669
- /**
1670
- * @internal
1671
- */
1672
- const filterSensitiveLog: (obj: DescribeTaskRequest) => any;
1673
- }
1674
- export declare enum TaskStatus {
1675
- AVAILABLE = "AVAILABLE",
1676
- CREATING = "CREATING",
1677
- QUEUED = "QUEUED",
1678
- RUNNING = "RUNNING",
1679
- UNAVAILABLE = "UNAVAILABLE"
1680
- }
1681
- /**
1682
- * <p>DescribeTaskResponse</p>
1683
- */
1684
- export interface DescribeTaskResponse {
1685
- /**
1686
- * <p>The Amazon Resource Name (ARN) of the task that was described.</p>
1687
- */
1688
- TaskArn?: string;
1689
- /**
1690
- * <p>The status of the task that was described.</p>
1691
- *
1692
- *
1693
- * <p>For detailed information about task execution statuses, see Understanding
1694
- * Task Statuses in the <i>DataSync User Guide</i>.</p>
1695
- */
1696
- Status?: TaskStatus | string;
1697
- /**
1698
- * <p>The name of the task that was described.</p>
1699
- */
1700
- Name?: string;
1701
- /**
1702
- * <p>The Amazon Resource Name (ARN) of the task execution that is syncing files.</p>
1703
- */
1704
- CurrentTaskExecutionArn?: string;
1705
- /**
1706
- * <p>The Amazon Resource Name (ARN) of the source file system's location.</p>
1707
- */
1708
- SourceLocationArn?: string;
1709
- /**
1710
- * <p>The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location.</p>
1711
- */
1712
- DestinationLocationArn?: string;
1713
- /**
1714
- * <p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to
1715
- * monitor and log events in the task.</p>
1716
- *
1717
- *
1718
- * <p>For more information on these groups, see Working with Log Groups and Log
1719
- * Streams in the <i>Amazon CloudWatch User Guide</i>.</p>
1720
- */
1721
- CloudWatchLogGroupArn?: string;
1722
- /**
1723
- * <p>The Amazon Resource Name (ARN) of the source ENIs (Elastic Network Interface) that was
1724
- * created for your subnet.</p>
1725
- */
1726
- SourceNetworkInterfaceArns?: string[];
1727
- /**
1728
- * <p>The Amazon Resource Name (ARN) of the destination ENIs (Elastic Network Interface) that
1729
- * was created for your subnet.</p>
1730
- */
1731
- DestinationNetworkInterfaceArns?: string[];
1732
- /**
1733
- * <p>The set of configuration options that control the behavior of a single execution of the
1734
- * task that occurs when you call <code>StartTaskExecution</code>. You can configure these
1735
- * options to preserve metadata such as user ID (UID) and group (GID), file permissions, data
1736
- * integrity verification, and so on.</p>
1737
- * <p>For each individual task execution, you can override these options by specifying the
1738
- * overriding <code>OverrideOptions</code> value to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a> operation. </p>
1739
- */
1740
- Options?: Options;
1741
- /**
1742
- * <p>A list of filter rules that determines which files to exclude from a task. The list should
1743
- * contain a single filter string that consists of the patterns to exclude. The patterns are
1744
- * delimited by "|" (that is, a pipe), for example: <code>"/folder1|/folder2"</code>
1745
- * </p>
1746
- * <p>
1747
- * </p>
1748
- */
1749
- Excludes?: FilterRule[];
1750
- /**
1751
- * <p>The schedule used to periodically transfer files from a source to a destination location.</p>
1752
- */
1753
- Schedule?: TaskSchedule;
1754
- /**
1755
- * <p>Errors that DataSync encountered during execution of the task. You can use this
1756
- * error code to help troubleshoot issues.</p>
1757
- */
1758
- ErrorCode?: string;
1759
- /**
1760
- * <p>Detailed description of an error that was encountered during the task execution. You
1761
- * can use this information to help troubleshoot issues. </p>
1762
- */
1763
- ErrorDetail?: string;
1764
- /**
1765
- * <p>The time that the task was created.</p>
1766
- */
1767
- CreationTime?: Date;
1768
- /**
1769
- * <p>A list of filter rules that determines which files to include when running a task. The
1770
- * pattern should contain a single filter string that consists of the patterns to include. The
1771
- * patterns are delimited by "|" (that is, a pipe). For example:
1772
- * <code>"/folder1|/folder2</code>"</p>
1773
- */
1774
- Includes?: FilterRule[];
1775
- }
1776
- export declare namespace DescribeTaskResponse {
1777
- /**
1778
- * @internal
1779
- */
1780
- const filterSensitiveLog: (obj: DescribeTaskResponse) => any;
1781
- }
1782
- /**
1783
- * <p>DescribeTaskExecutionRequest</p>
1784
- */
1785
- export interface DescribeTaskExecutionRequest {
1786
- /**
1787
- * <p>The Amazon Resource Name (ARN) of the task that is being executed.</p>
1788
- */
1789
- TaskExecutionArn: string | undefined;
1790
- }
1791
- export declare namespace DescribeTaskExecutionRequest {
1792
- /**
1793
- * @internal
1794
- */
1795
- const filterSensitiveLog: (obj: DescribeTaskExecutionRequest) => any;
1796
- }
1797
- export declare enum PhaseStatus {
1798
- ERROR = "ERROR",
1799
- PENDING = "PENDING",
1800
- SUCCESS = "SUCCESS"
1801
- }
1802
- /**
1803
- * <p>Describes the detailed result of a <code>TaskExecution</code> operation. This result
1804
- * includes the time in milliseconds spent in each phase, the status of the task execution, and
1805
- * the errors encountered.</p>
1806
- */
1807
- export interface TaskExecutionResultDetail {
1808
- /**
1809
- * <p>The total time in milliseconds that DataSync spent in the PREPARING phase.
1810
- * </p>
1811
- */
1812
- PrepareDuration?: number;
1813
- /**
1814
- * <p>The status of the PREPARING phase.</p>
1815
- */
1816
- PrepareStatus?: PhaseStatus | string;
1817
- /**
1818
- * <p>The total time in milliseconds that DataSync took to transfer the file from the source to the destination location.</p>
1819
- */
1820
- TotalDuration?: number;
1821
- /**
1822
- * <p>The total time in milliseconds that DataSync spent in the TRANSFERRING
1823
- * phase.</p>
1824
- */
1825
- TransferDuration?: number;
1826
- /**
1827
- * <p>The status of the TRANSFERRING phase.</p>
1828
- */
1829
- TransferStatus?: PhaseStatus | string;
1830
- /**
1831
- * <p>The total time in milliseconds that DataSync spent in the VERIFYING
1832
- * phase.</p>
1833
- */
1834
- VerifyDuration?: number;
1835
- /**
1836
- * <p>The status of the VERIFYING phase.</p>
1837
- */
1838
- VerifyStatus?: PhaseStatus | string;
1839
- /**
1840
- * <p>Errors that DataSync encountered during execution of the task. You can use this
1841
- * error code to help troubleshoot issues.</p>
1842
- */
1843
- ErrorCode?: string;
1844
- /**
1845
- * <p>Detailed description of an error that was encountered during the task execution. You
1846
- * can use this information to help troubleshoot issues. </p>
1847
- */
1848
- ErrorDetail?: string;
1849
- }
1850
- export declare namespace TaskExecutionResultDetail {
1851
- /**
1852
- * @internal
1853
- */
1854
- const filterSensitiveLog: (obj: TaskExecutionResultDetail) => any;
1855
- }
1856
- export declare enum TaskExecutionStatus {
1857
- ERROR = "ERROR",
1858
- LAUNCHING = "LAUNCHING",
1859
- PREPARING = "PREPARING",
1860
- QUEUED = "QUEUED",
1861
- SUCCESS = "SUCCESS",
1862
- TRANSFERRING = "TRANSFERRING",
1863
- VERIFYING = "VERIFYING"
1864
- }
1865
- /**
1866
- * <p>DescribeTaskExecutionResponse</p>
1867
- */
1868
- export interface DescribeTaskExecutionResponse {
1869
- /**
1870
- * <p>The Amazon Resource Name (ARN) of the task execution that was described.
1871
- * <code>TaskExecutionArn</code> is hierarchical and includes <code>TaskArn</code> for the task
1872
- * that was executed. </p>
1873
- * <p>For example, a <code>TaskExecution</code> value with the ARN
1874
- * <code>arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b</code>
1875
- * executed the task with the ARN
1876
- * <code>arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2</code>. </p>
1877
- */
1878
- TaskExecutionArn?: string;
1879
- /**
1880
- * <p>The status of the task execution. </p>
1881
- *
1882
- *
1883
- * <p>For detailed information about task execution statuses, see Understanding
1884
- * Task Statuses in the <i>DataSync User Guide.</i>
1885
- * </p>
1886
- */
1887
- Status?: TaskExecutionStatus | string;
1888
- /**
1889
- * <p>Represents the options that are available to control the behavior of a
1890
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>
1891
- * operation. Behavior includes preserving metadata such as user
1892
- * ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination,
1893
- * data integrity verification, and so on.</p>
1894
- * <p>A task has a set of default options associated with it. If you don't specify an option
1895
- * in <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>,
1896
- * the default value is used. You can override the
1897
- * defaults options on each task execution by specifying an overriding <code>Options</code> value
1898
- * to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
1899
- */
1900
- Options?: Options;
1901
- /**
1902
- * <p>A list of filter rules that determines which files to exclude from a task. The list should
1903
- * contain a single filter string that consists of the patterns to exclude. The patterns are
1904
- * delimited by "|" (that is, a pipe), for example: <code>"/folder1|/folder2"</code>
1905
- * </p>
1906
- * <p>
1907
- * </p>
1908
- */
1909
- Excludes?: FilterRule[];
1910
- /**
1911
- * <p>A list of filter rules that determines which files to include when running a task. The
1912
- * list should contain a single filter string that consists of the patterns to include. The
1913
- * patterns are delimited by "|" (that is, a pipe), for example: <code>"/folder1|/folder2"</code>
1914
- * </p>
1915
- * <p>
1916
- * </p>
1917
- */
1918
- Includes?: FilterRule[];
1919
- /**
1920
- * <p>The time that the task execution was started.</p>
1921
- */
1922
- StartTime?: Date;
1923
- /**
1924
- * <p>The expected number of files that is to be transferred over the network. This value is
1925
- * calculated during the PREPARING phase, before the TRANSFERRING phase. This value is the
1926
- * expected number of files to be transferred. It's calculated based on comparing the
1927
- * content of the source and destination locations and finding the delta that needs to be
1928
- * transferred. </p>
1929
- */
1930
- EstimatedFilesToTransfer?: number;
1931
- /**
1932
- * <p>The estimated physical number of bytes that is to be transferred over the
1933
- * network.</p>
1934
- */
1935
- EstimatedBytesToTransfer?: number;
1936
- /**
1937
- * <p>The actual number of files that was transferred over the network. This value is
1938
- * calculated and updated on an ongoing basis during the TRANSFERRING phase. It's updated
1939
- * periodically when each file is read from the source and sent over the network. </p>
1940
- * <p>If failures occur during a transfer, this value can be less than
1941
- * <code>EstimatedFilesToTransfer</code>. This value can also be greater than
1942
- * <code>EstimatedFilesTransferred</code> in some cases. This element is
1943
- * implementation-specific for some location types, so don't use it as an indicator for a correct
1944
- * file number or to monitor your task execution.</p>
1945
- */
1946
- FilesTransferred?: number;
1947
- /**
1948
- * <p>The number of logical bytes written to the destination Amazon Web Services storage resource.</p>
1949
- */
1950
- BytesWritten?: number;
1951
- /**
1952
- * <p>The physical number of bytes transferred over the network.</p>
1953
- */
1954
- BytesTransferred?: number;
1955
- /**
1956
- * <p>The result of the task execution.</p>
1957
- */
1958
- Result?: TaskExecutionResultDetail;
1959
- }
1960
- export declare namespace DescribeTaskExecutionResponse {
1961
- /**
1962
- * @internal
1963
- */
1964
- const filterSensitiveLog: (obj: DescribeTaskExecutionResponse) => any;
1965
- }
1966
- /**
1967
- * <p>ListAgentsRequest</p>
1968
- */
1969
- export interface ListAgentsRequest {
1970
- /**
1971
- * <p>The maximum number of agents to list.</p>
1972
- */
1973
- MaxResults?: number;
1974
- /**
1975
- * <p>An opaque string that indicates the position at which to begin the next list of
1976
- * agents.</p>
1977
- */
1978
- NextToken?: string;
1979
- }
1980
- export declare namespace ListAgentsRequest {
1981
- /**
1982
- * @internal
1983
- */
1984
- const filterSensitiveLog: (obj: ListAgentsRequest) => any;
1985
- }
1986
- /**
1987
- * <p>ListAgentsResponse</p>
1988
- */
1989
- export interface ListAgentsResponse {
1990
- /**
1991
- * <p>A list of agents in your account.</p>
1992
- */
1993
- Agents?: AgentListEntry[];
1994
- /**
1995
- * <p>An opaque string that indicates the position at which to begin returning the next list
1996
- * of agents.</p>
1997
- */
1998
- NextToken?: string;
1999
- }
2000
- export declare namespace ListAgentsResponse {
2001
- /**
2002
- * @internal
2003
- */
2004
- const filterSensitiveLog: (obj: ListAgentsResponse) => any;
2005
- }
2006
- export declare enum LocationFilterName {
2007
- CreationTime = "CreationTime",
2008
- LocationType = "LocationType",
2009
- LocationUri = "LocationUri"
2010
- }
2011
- export declare enum Operator {
2012
- BEGINS_WITH = "BeginsWith",
2013
- CONTAINS = "Contains",
2014
- EQ = "Equals",
2015
- GE = "GreaterThanOrEqual",
2016
- GT = "GreaterThan",
2017
- IN = "In",
2018
- LE = "LessThanOrEqual",
2019
- LT = "LessThan",
2020
- NE = "NotEquals",
2021
- NOT_CONTAINS = "NotContains"
2022
- }
2023
- /**
2024
- * <p>You can use API filters to narrow down the list of resources returned by <code>ListLocations</code>.
2025
- * For example, to retrieve all your Amazon S3 locations, you can use <code>ListLocations</code> with
2026
- * filter name <code>LocationType S3</code> and <code>Operator Equals</code>.</p>
2027
- */
2028
- export interface LocationFilter {
2029
- /**
2030
- * <p>The name of the filter being used. Each API call supports a list of filters that are available
2031
- * for it (for example, <code>LocationType</code> for <code>ListLocations</code>).</p>
2032
- */
2033
- Name: LocationFilterName | string | undefined;
2034
- /**
2035
- * <p>The values that you want to filter for. For example, you might want to display only Amazon S3
2036
- * locations.</p>
2037
- */
2038
- Values: string[] | undefined;
2039
- /**
2040
- * <p>The operator that is used to compare filter values (for example, <code>Equals</code> or
2041
- * <code>Contains</code>). For more about API filtering operators, see
2042
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html">API filters for ListTasks and ListLocations</a>.</p>
2043
- */
2044
- Operator: Operator | string | undefined;
2045
- }
2046
- export declare namespace LocationFilter {
2047
- /**
2048
- * @internal
2049
- */
2050
- const filterSensitiveLog: (obj: LocationFilter) => any;
2051
- }
2052
- /**
2053
- * <p>ListLocationsRequest</p>
2054
- */
2055
- export interface ListLocationsRequest {
2056
- /**
2057
- * <p>The maximum number of locations to return.</p>
2058
- */
2059
- MaxResults?: number;
2060
- /**
2061
- * <p>An opaque string that indicates the position at which to begin the next list of
2062
- * locations.</p>
2063
- */
2064
- NextToken?: string;
2065
- /**
2066
- * <p>You can use API filters to narrow down the list of resources returned by <code>ListLocations</code>.
2067
- * For example, to retrieve all tasks on a specific source location, you can use <code>ListLocations</code>
2068
- * with filter name <code>LocationType S3</code> and <code>Operator Equals</code>.</p>
2069
- */
2070
- Filters?: LocationFilter[];
2071
- }
2072
- export declare namespace ListLocationsRequest {
2073
- /**
2074
- * @internal
2075
- */
2076
- const filterSensitiveLog: (obj: ListLocationsRequest) => any;
2077
- }
2078
- /**
2079
- * <p>Represents a single entry in a list of locations. <code>LocationListEntry</code>
2080
- * returns an array that contains a list of locations when the
2081
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html">ListLocations</a>
2082
- * operation is called.</p>
2083
- */
2084
- export interface LocationListEntry {
2085
- /**
2086
- * <p>The Amazon Resource Name (ARN) of the location. For Network File System (NFS) or Amazon
2087
- * EFS, the location is the export path. For Amazon S3, the location is the prefix path that you
2088
- * want to mount and use as the root of the location.</p>
2089
- */
2090
- LocationArn?: string;
2091
- /**
2092
- * <p>Represents a list of URLs of a location. <code>LocationUri</code> returns an array that
2093
- * contains a list of locations when the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html">ListLocations</a> operation is
2094
- * called.</p>
2095
- * <p>Format: <code>TYPE://GLOBAL_ID/SUBDIR</code>.</p>
2096
- * <p>TYPE designates the type of location. Valid values: NFS | EFS | S3.</p>
2097
- * <p>GLOBAL_ID is the globally unique identifier of the resource that backs the location. An
2098
- * example for EFS is <code>us-east-2.fs-abcd1234</code>. An example for Amazon S3 is the bucket
2099
- * name, such as <code>myBucket</code>. An example for NFS is a valid IPv4 address or a host name
2100
- * compliant with Domain Name Service (DNS).</p>
2101
- * <p>SUBDIR is a valid file system path, delimited by forward slashes as is the *nix
2102
- * convention. For NFS and Amazon EFS, it's the export path to mount the location. For
2103
- * Amazon S3, it's the prefix path that you mount to and treat as the root of the
2104
- * location.</p>
2105
- * <p></p>
2106
- */
2107
- LocationUri?: string;
2108
- }
2109
- export declare namespace LocationListEntry {
2110
- /**
2111
- * @internal
2112
- */
2113
- const filterSensitiveLog: (obj: LocationListEntry) => any;
2114
- }
2115
- /**
2116
- * <p>ListLocationsResponse</p>
2117
- */
2118
- export interface ListLocationsResponse {
2119
- /**
2120
- * <p>An array that contains a list of locations.</p>
2121
- */
2122
- Locations?: LocationListEntry[];
2123
- /**
2124
- * <p>An opaque string that indicates the position at which to begin returning the next list
2125
- * of locations.</p>
2126
- */
2127
- NextToken?: string;
2128
- }
2129
- export declare namespace ListLocationsResponse {
2130
- /**
2131
- * @internal
2132
- */
2133
- const filterSensitiveLog: (obj: ListLocationsResponse) => any;
2134
- }
2135
- /**
2136
- * <p>ListTagsForResourceRequest</p>
2137
- */
2138
- export interface ListTagsForResourceRequest {
2139
- /**
2140
- * <p>The Amazon Resource Name (ARN) of the resource whose tags to list.</p>
2141
- */
2142
- ResourceArn: string | undefined;
2143
- /**
2144
- * <p>The maximum number of locations to return.</p>
2145
- */
2146
- MaxResults?: number;
2147
- /**
2148
- * <p>An opaque string that indicates the position at which to begin the next list of
2149
- * locations.</p>
2150
- */
2151
- NextToken?: string;
2152
- }
2153
- export declare namespace ListTagsForResourceRequest {
2154
- /**
2155
- * @internal
2156
- */
2157
- const filterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
2158
- }
2159
- /**
2160
- * <p>ListTagsForResourceResponse</p>
2161
- */
2162
- export interface ListTagsForResourceResponse {
2163
- /**
2164
- * <p>Array of resource tags.</p>
2165
- */
2166
- Tags?: TagListEntry[];
2167
- /**
2168
- * <p>An opaque string that indicates the position at which to begin returning the next list
2169
- * of resource tags.</p>
2170
- */
2171
- NextToken?: string;
2172
- }
2173
- export declare namespace ListTagsForResourceResponse {
2174
- /**
2175
- * @internal
2176
- */
2177
- const filterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
2178
- }
2179
- /**
2180
- * <p>ListTaskExecutions</p>
2181
- */
2182
- export interface ListTaskExecutionsRequest {
2183
- /**
2184
- * <p>The Amazon Resource Name (ARN) of the task whose tasks you want to list.</p>
2185
- */
2186
- TaskArn?: string;
2187
- /**
2188
- * <p>The maximum number of executed tasks to list.</p>
2189
- */
2190
- MaxResults?: number;
2191
- /**
2192
- * <p>An opaque string that indicates the position at which to begin the next list of the
2193
- * executed tasks.</p>
2194
- */
2195
- NextToken?: string;
2196
- }
2197
- export declare namespace ListTaskExecutionsRequest {
2198
- /**
2199
- * @internal
2200
- */
2201
- const filterSensitiveLog: (obj: ListTaskExecutionsRequest) => any;
2202
- }
2203
- /**
2204
- * <p>Represents a single entry in a list of task executions.
2205
- * <code>TaskExecutionListEntry</code> returns an array that contains a list of specific
2206
- * invocations of a task when the
2207
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTaskExecutions.html">ListTaskExecutions</a>
2208
- * operation is called.</p>
2209
- */
2210
- export interface TaskExecutionListEntry {
2211
- /**
2212
- * <p>The Amazon Resource Name (ARN) of the task that was executed.</p>
2213
- */
2214
- TaskExecutionArn?: string;
2215
- /**
2216
- * <p>The status of a task execution.</p>
2217
- */
2218
- Status?: TaskExecutionStatus | string;
2219
- }
2220
- export declare namespace TaskExecutionListEntry {
2221
- /**
2222
- * @internal
2223
- */
2224
- const filterSensitiveLog: (obj: TaskExecutionListEntry) => any;
2225
- }
2226
- /**
2227
- * <p>ListTaskExecutionsResponse</p>
2228
- */
2229
- export interface ListTaskExecutionsResponse {
2230
- /**
2231
- * <p>A list of executed tasks.</p>
2232
- */
2233
- TaskExecutions?: TaskExecutionListEntry[];
2234
- /**
2235
- * <p>An opaque string that indicates the position at which to begin returning the next list
2236
- * of executed tasks.</p>
2237
- */
2238
- NextToken?: string;
2239
- }
2240
- export declare namespace ListTaskExecutionsResponse {
2241
- /**
2242
- * @internal
2243
- */
2244
- const filterSensitiveLog: (obj: ListTaskExecutionsResponse) => any;
2245
- }
2246
- export declare enum TaskFilterName {
2247
- CreationTime = "CreationTime",
2248
- LocationId = "LocationId"
2249
- }
2250
- /**
2251
- * <p>You can use API filters to narrow down the list of resources returned by <code>ListTasks</code>.
2252
- * For example, to retrieve all tasks on a source location, you can use <code>ListTasks</code>
2253
- * with filter name <code>LocationId</code> and <code>Operator Equals</code> with the ARN for the
2254
- * location.</p>
2255
- */
2256
- export interface TaskFilter {
2257
- /**
2258
- * <p>The name of the filter being used. Each API call supports a list of filters that are available
2259
- * for it. For example, <code>LocationId</code> for <code>ListTasks</code>.</p>
2260
- */
2261
- Name: TaskFilterName | string | undefined;
2262
- /**
2263
- * <p>The values that you want to filter for. For example, you might want to display only tasks
2264
- * for a specific destination location.</p>
2265
- */
2266
- Values: string[] | undefined;
2267
- /**
2268
- * <p>The operator that is used to compare filter values (for example, <code>Equals</code> or
2269
- * <code>Contains</code>). For more about API filtering operators, see
2270
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html">API filters for ListTasks and ListLocations</a>.</p>
2271
- */
2272
- Operator: Operator | string | undefined;
2273
- }
2274
- export declare namespace TaskFilter {
2275
- /**
2276
- * @internal
2277
- */
2278
- const filterSensitiveLog: (obj: TaskFilter) => any;
2279
- }
2280
- /**
2281
- * <p>ListTasksRequest</p>
2282
- */
2283
- export interface ListTasksRequest {
2284
- /**
2285
- * <p>The maximum number of tasks to return.</p>
2286
- */
2287
- MaxResults?: number;
2288
- /**
2289
- * <p>An opaque string that indicates the position at which to begin the next list of
2290
- * tasks.</p>
2291
- */
2292
- NextToken?: string;
2293
- /**
2294
- * <p>You can use API filters to narrow down the list of resources returned by <code>ListTasks</code>.
2295
- * For example, to retrieve all tasks on a specific source location, you can use <code>ListTasks</code>
2296
- * with filter name <code>LocationId</code> and <code>Operator Equals</code> with the ARN for the
2297
- * location.</p>
2298
- */
2299
- Filters?: TaskFilter[];
2300
- }
2301
- export declare namespace ListTasksRequest {
2302
- /**
2303
- * @internal
2304
- */
2305
- const filterSensitiveLog: (obj: ListTasksRequest) => any;
2306
- }
2307
- /**
2308
- * <p>Represents a single entry in a list of tasks. <code>TaskListEntry</code> returns an
2309
- * array that contains a list of tasks when the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTasks.html">ListTasks</a> operation is called.
2310
- * A task includes the source and destination file systems to sync and the options to use for the
2311
- * tasks.</p>
2312
- */
2313
- export interface TaskListEntry {
2314
- /**
2315
- * <p>The Amazon Resource Name (ARN) of the task.</p>
2316
- */
2317
- TaskArn?: string;
2318
- /**
2319
- * <p>The status of the task.</p>
2320
- */
2321
- Status?: TaskStatus | string;
2322
- /**
2323
- * <p>The name of the task.</p>
2324
- */
2325
- Name?: string;
2326
- }
2327
- export declare namespace TaskListEntry {
2328
- /**
2329
- * @internal
2330
- */
2331
- const filterSensitiveLog: (obj: TaskListEntry) => any;
2332
- }
2333
- /**
2334
- * <p>ListTasksResponse</p>
2335
- */
2336
- export interface ListTasksResponse {
2337
- /**
2338
- * <p>A list of all the tasks that are returned.</p>
2339
- */
2340
- Tasks?: TaskListEntry[];
2341
- /**
2342
- * <p>An opaque string that indicates the position at which to begin returning the next list
2343
- * of tasks.</p>
2344
- */
2345
- NextToken?: string;
2346
- }
2347
- export declare namespace ListTasksResponse {
2348
- /**
2349
- * @internal
2350
- */
2351
- const filterSensitiveLog: (obj: ListTasksResponse) => any;
2352
- }
2353
- /**
2354
- * <p>StartTaskExecutionRequest</p>
2355
- */
2356
- export interface StartTaskExecutionRequest {
2357
- /**
2358
- * <p>The Amazon Resource Name (ARN) of the task to start.</p>
2359
- */
2360
- TaskArn: string | undefined;
2361
- /**
2362
- * <p>Represents the options that are available to control the behavior of a
2363
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>
2364
- * operation. Behavior includes preserving metadata such as user
2365
- * ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination,
2366
- * data integrity verification, and so on.</p>
2367
- * <p>A task has a set of default options associated with it. If you don't specify an option
2368
- * in <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>,
2369
- * the default value is used. You can override the
2370
- * defaults options on each task execution by specifying an overriding <code>Options</code> value
2371
- * to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
2372
- */
2373
- OverrideOptions?: Options;
2374
- /**
2375
- * <p>A list of filter rules that determines which files to include when running a task. The
2376
- * pattern should contain a single filter string that consists of the patterns to include. The
2377
- * patterns are delimited by "|" (that is, a pipe). For example: <code>"/folder1|/folder2"</code>
2378
- * </p>
2379
- *
2380
- * <p>
2381
- * </p>
2382
- */
2383
- Includes?: FilterRule[];
2384
- /**
2385
- * <p>A list of filter rules that determines which files to exclude from a task. The list
2386
- * should contain a single filter string that consists of the patterns to exclude. The
2387
- * patterns are delimited by "|" (that is, a pipe), for example,
2388
- * <code>"/folder1|/folder2"</code>. </p>
2389
- */
2390
- Excludes?: FilterRule[];
2391
- }
2392
- export declare namespace StartTaskExecutionRequest {
2393
- /**
2394
- * @internal
2395
- */
2396
- const filterSensitiveLog: (obj: StartTaskExecutionRequest) => any;
2397
- }
2398
- /**
2399
- * <p>StartTaskExecutionResponse</p>
2400
- */
2401
- export interface StartTaskExecutionResponse {
2402
- /**
2403
- * <p>The Amazon Resource Name (ARN) of the specific task execution that was
2404
- * started.</p>
2405
- */
2406
- TaskExecutionArn?: string;
2407
- }
2408
- export declare namespace StartTaskExecutionResponse {
2409
- /**
2410
- * @internal
2411
- */
2412
- const filterSensitiveLog: (obj: StartTaskExecutionResponse) => any;
2413
- }
2414
- /**
2415
- * <p>TagResourceRequest</p>
2416
- */
2417
- export interface TagResourceRequest {
2418
- /**
2419
- * <p>The Amazon Resource Name (ARN) of the resource to apply the tag to.</p>
2420
- */
2421
- ResourceArn: string | undefined;
2422
- /**
2423
- * <p>The tags to apply.</p>
2424
- */
2425
- Tags: TagListEntry[] | undefined;
2426
- }
2427
- export declare namespace TagResourceRequest {
2428
- /**
2429
- * @internal
2430
- */
2431
- const filterSensitiveLog: (obj: TagResourceRequest) => any;
2432
- }
2433
- export interface TagResourceResponse {
2434
- }
2435
- export declare namespace TagResourceResponse {
2436
- /**
2437
- * @internal
2438
- */
2439
- const filterSensitiveLog: (obj: TagResourceResponse) => any;
2440
- }
2441
- /**
2442
- * <p>UntagResourceRequest</p>
2443
- */
2444
- export interface UntagResourceRequest {
2445
- /**
2446
- * <p>The Amazon Resource Name (ARN) of the resource to remove the tag from.</p>
2447
- */
2448
- ResourceArn: string | undefined;
2449
- /**
2450
- * <p>The keys in the key-value pair in the tag to remove.</p>
2451
- */
2452
- Keys: string[] | undefined;
2453
- }
2454
- export declare namespace UntagResourceRequest {
2455
- /**
2456
- * @internal
2457
- */
2458
- const filterSensitiveLog: (obj: UntagResourceRequest) => any;
2459
- }
2460
- export interface UntagResourceResponse {
2461
- }
2462
- export declare namespace UntagResourceResponse {
2463
- /**
2464
- * @internal
2465
- */
2466
- const filterSensitiveLog: (obj: UntagResourceResponse) => any;
2467
- }
2468
- /**
2469
- * <p>UpdateAgentRequest</p>
2470
- */
2471
- export interface UpdateAgentRequest {
2472
- /**
2473
- * <p>The Amazon Resource Name (ARN) of the agent to update.</p>
2474
- */
2475
- AgentArn: string | undefined;
2476
- /**
2477
- * <p>The name that you want to use to configure the agent.</p>
2478
- */
2479
- Name?: string;
2480
- }
2481
- export declare namespace UpdateAgentRequest {
2482
- /**
2483
- * @internal
2484
- */
2485
- const filterSensitiveLog: (obj: UpdateAgentRequest) => any;
2486
- }
2487
- export interface UpdateAgentResponse {
2488
- }
2489
- export declare namespace UpdateAgentResponse {
2490
- /**
2491
- * @internal
2492
- */
2493
- const filterSensitiveLog: (obj: UpdateAgentResponse) => any;
2494
- }
2495
- export interface UpdateLocationNfsRequest {
2496
- /**
2497
- * <p>The Amazon Resource Name (ARN) of the NFS location to update.</p>
2498
- */
2499
- LocationArn: string | undefined;
2500
- /**
2501
- * <p>The subdirectory in the NFS file system that is used to read data from the NFS source
2502
- * location or write data to the NFS destination. The NFS path should be a path that's
2503
- * exported by the NFS server, or a subdirectory of that path. The path should be such that it
2504
- * can be mounted by other NFS clients in your network.</p>
2505
- *
2506
- * <p>To see all the paths exported by your NFS server, run "<code>showmount -e
2507
- * nfs-server-name</code>" from an NFS client that has access to your server. You can specify
2508
- * any directory that appears in the results, and any subdirectory of that directory. Ensure that
2509
- * the NFS export is accessible without Kerberos authentication. </p>
2510
- * <p>To transfer all the data in the folder that you specified, DataSync must have
2511
- * permissions to read all the data. To ensure this, either configure the NFS export with
2512
- * <code>no_root_squash</code>, or ensure that the files you want DataSync to
2513
- * access have permissions that allow read access for all users. Doing either option enables the
2514
- * agent to read the files. For the agent to access directories, you must additionally enable all
2515
- * execute access.</p>
2516
- * <p>If you are copying data to or from your Snowcone device, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone">NFS Server on Snowcone</a> for more information.</p>
2517
- *
2518
- * <p>For information about NFS export configuration, see 18.7. The /etc/exports
2519
- * Configuration File in the Red Hat Enterprise Linux documentation.</p>
2520
- */
2521
- Subdirectory?: string;
2522
- /**
2523
- * <p>A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS)
2524
- * location.</p>
2525
- */
2526
- OnPremConfig?: OnPremConfig;
2527
- /**
2528
- * <p>Represents the mount options that are available for DataSync to access an NFS
2529
- * location.</p>
2530
- */
2531
- MountOptions?: NfsMountOptions;
2532
- }
2533
- export declare namespace UpdateLocationNfsRequest {
2534
- /**
2535
- * @internal
2536
- */
2537
- const filterSensitiveLog: (obj: UpdateLocationNfsRequest) => any;
2538
- }
2539
- export interface UpdateLocationNfsResponse {
2540
- }
2541
- export declare namespace UpdateLocationNfsResponse {
2542
- /**
2543
- * @internal
2544
- */
2545
- const filterSensitiveLog: (obj: UpdateLocationNfsResponse) => any;
2546
- }
2547
- export interface UpdateLocationObjectStorageRequest {
2548
- /**
2549
- * <p>The Amazon Resource Name (ARN) of the self-managed object storage server location to be updated.</p>
2550
- */
2551
- LocationArn: string | undefined;
2552
- /**
2553
- * <p>The port that your self-managed object storage server accepts inbound network traffic on.
2554
- * The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can
2555
- * specify a custom port if your self-managed object storage server requires one.</p>
2556
- */
2557
- ServerPort?: number;
2558
- /**
2559
- * <p>The protocol that the object storage server uses to communicate. Valid values are
2560
- * <code>HTTP</code> or <code>HTTPS</code>.</p>
2561
- */
2562
- ServerProtocol?: ObjectStorageServerProtocol | string;
2563
- /**
2564
- * <p>The subdirectory in the self-managed object storage server that is used
2565
- * to read data from.</p>
2566
- */
2567
- Subdirectory?: string;
2568
- /**
2569
- * <p>Optional. The access key is used if credentials are required to access the self-managed
2570
- * object storage server. If your object storage requires a user name and password to
2571
- * authenticate, use <code>AccessKey</code> and <code>SecretKey</code> to provide the user name
2572
- * and password, respectively.</p>
2573
- */
2574
- AccessKey?: string;
2575
- /**
2576
- * <p>Optional. The secret key is used if credentials are required to access the self-managed
2577
- * object storage server. If your object storage requires a user name and password to
2578
- * authenticate, use <code>AccessKey</code> and <code>SecretKey</code> to provide the user name
2579
- * and password, respectively.</p>
2580
- */
2581
- SecretKey?: string;
2582
- /**
2583
- * <p>The Amazon Resource Name (ARN) of the agents associated with the
2584
- * self-managed object storage server location.</p>
2585
- */
2586
- AgentArns?: string[];
2587
- }
2588
- export declare namespace UpdateLocationObjectStorageRequest {
2589
- /**
2590
- * @internal
2591
- */
2592
- const filterSensitiveLog: (obj: UpdateLocationObjectStorageRequest) => any;
2593
- }
2594
- export interface UpdateLocationObjectStorageResponse {
2595
- }
2596
- export declare namespace UpdateLocationObjectStorageResponse {
2597
- /**
2598
- * @internal
2599
- */
2600
- const filterSensitiveLog: (obj: UpdateLocationObjectStorageResponse) => any;
2601
- }
2602
- export interface UpdateLocationSmbRequest {
2603
- /**
2604
- * <p>The Amazon Resource Name (ARN) of the SMB location to update.</p>
2605
- */
2606
- LocationArn: string | undefined;
2607
- /**
2608
- * <p>The subdirectory in the SMB file system that is used to read data from the SMB source
2609
- * location or write data to the SMB destination. The SMB path should be a path that's
2610
- * exported by the SMB server, or a subdirectory of that path. The path should be such that it
2611
- * can be mounted by other SMB clients in your network.</p>
2612
- * <note>
2613
- * <p>
2614
- * <code>Subdirectory</code> must be specified with forward slashes. For example,
2615
- * <code>/path/to/folder</code>.</p>
2616
- * </note>
2617
- *
2618
- * <p>To transfer all the data in the folder that you specified, DataSync must have
2619
- * permissions to mount the SMB share and to access all the data in that share. To ensure this,
2620
- * do either of the following:</p>
2621
- * <ul>
2622
- * <li>
2623
- * <p>Ensure that the user/password specified belongs to the user who can mount the share
2624
- * and who has the appropriate permissions for all of the files and directories that you want
2625
- * DataSync to access.</p>
2626
- * </li>
2627
- * <li>
2628
- * <p>Use credentials of a member of the Backup Operators group to mount the share. </p>
2629
- * </li>
2630
- * </ul>
2631
- * <p>Doing either of these options enables the agent to access the data. For the agent to
2632
- * access directories, you must also enable all execute access.</p>
2633
- */
2634
- Subdirectory?: string;
2635
- /**
2636
- * <p>The user who can mount the share has the permissions to access files and folders in the
2637
- * SMB share.</p>
2638
- */
2639
- User?: string;
2640
- /**
2641
- * <p>The name of the Windows domain that the SMB server belongs to.</p>
2642
- */
2643
- Domain?: string;
2644
- /**
2645
- * <p>The password of the user who can mount the share has the permissions to access files and
2646
- * folders in the SMB share.</p>
2647
- */
2648
- Password?: string;
2649
- /**
2650
- * <p>The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB)
2651
- * location.</p>
2652
- */
2653
- AgentArns?: string[];
2654
- /**
2655
- * <p>Represents the mount options that are available for DataSync to access an SMB
2656
- * location.</p>
2657
- */
2658
- MountOptions?: SmbMountOptions;
2659
- }
2660
- export declare namespace UpdateLocationSmbRequest {
2661
- /**
2662
- * @internal
2663
- */
2664
- const filterSensitiveLog: (obj: UpdateLocationSmbRequest) => any;
2665
- }
2666
- export interface UpdateLocationSmbResponse {
2667
- }
2668
- export declare namespace UpdateLocationSmbResponse {
2669
- /**
2670
- * @internal
2671
- */
2672
- const filterSensitiveLog: (obj: UpdateLocationSmbResponse) => any;
2673
- }
2674
- /**
2675
- * <p>UpdateTaskResponse</p>
2676
- */
2677
- export interface UpdateTaskRequest {
2678
- /**
2679
- * <p>The Amazon Resource Name (ARN) of the resource name of the task to update.</p>
2680
- */
2681
- TaskArn: string | undefined;
2682
- /**
2683
- * <p>Represents the options that are available to control the behavior of a
2684
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>
2685
- * operation. Behavior includes preserving metadata such as user
2686
- * ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination,
2687
- * data integrity verification, and so on.</p>
2688
- * <p>A task has a set of default options associated with it. If you don't specify an option
2689
- * in <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>,
2690
- * the default value is used. You can override the
2691
- * defaults options on each task execution by specifying an overriding <code>Options</code> value
2692
- * to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
2693
- */
2694
- Options?: Options;
2695
- /**
2696
- * <p>A list of filter rules that determines which files to exclude from a task. The list should
2697
- * contain a single filter string that consists of the patterns to exclude. The patterns are
2698
- * delimited by "|" (that is, a pipe), for example: <code>"/folder1|/folder2"</code>
2699
- * </p>
2700
- * <p>
2701
- * </p>
2702
- */
2703
- Excludes?: FilterRule[];
2704
- /**
2705
- * <p>Specifies a schedule used to periodically transfer files from a source to a destination
2706
- * location. You can configure your task to execute hourly, daily, weekly or on specific days of
2707
- * the week. You control when in the day or hour you want the task to execute. The time you
2708
- * specify is UTC time. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html">Scheduling your task</a>.</p>
2709
- */
2710
- Schedule?: TaskSchedule;
2711
- /**
2712
- * <p>The name of the task to update.</p>
2713
- */
2714
- Name?: string;
2715
- /**
2716
- * <p>The Amazon Resource Name (ARN) of the resource name of the CloudWatch
2717
- * LogGroup.</p>
2718
- */
2719
- CloudWatchLogGroupArn?: string;
2720
- /**
2721
- * <p>A list of filter rules that determines which files to include when running a task. The
2722
- * pattern should contain a single filter string that consists of the patterns to include. The
2723
- * patterns are delimited by "|" (that is, a pipe). For example:
2724
- * <code>"/folder1|/folder2</code>"</p>
2725
- */
2726
- Includes?: FilterRule[];
2727
- }
2728
- export declare namespace UpdateTaskRequest {
2729
- /**
2730
- * @internal
2731
- */
2732
- const filterSensitiveLog: (obj: UpdateTaskRequest) => any;
2733
- }
2734
- export interface UpdateTaskResponse {
2735
- }
2736
- export declare namespace UpdateTaskResponse {
2737
- /**
2738
- * @internal
2739
- */
2740
- const filterSensitiveLog: (obj: UpdateTaskResponse) => any;
2741
- }
2742
- export interface UpdateTaskExecutionRequest {
2743
- /**
2744
- * <p>The Amazon Resource Name (ARN) of the specific task execution that is being updated. </p>
2745
- */
2746
- TaskExecutionArn: string | undefined;
2747
- /**
2748
- * <p>Represents the options that are available to control the behavior of a
2749
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>
2750
- * operation. Behavior includes preserving metadata such as user
2751
- * ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination,
2752
- * data integrity verification, and so on.</p>
2753
- * <p>A task has a set of default options associated with it. If you don't specify an option
2754
- * in <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>,
2755
- * the default value is used. You can override the
2756
- * defaults options on each task execution by specifying an overriding <code>Options</code> value
2757
- * to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
2758
- */
2759
- Options: Options | undefined;
2760
- }
2761
- export declare namespace UpdateTaskExecutionRequest {
2762
- /**
2763
- * @internal
2764
- */
2765
- const filterSensitiveLog: (obj: UpdateTaskExecutionRequest) => any;
2766
- }
2767
- export interface UpdateTaskExecutionResponse {
2768
- }
2769
- export declare namespace UpdateTaskExecutionResponse {
2770
- /**
2771
- * @internal
2772
- */
2773
- const filterSensitiveLog: (obj: UpdateTaskExecutionResponse) => any;
2774
- }