@aws-sdk/client-transfer 3.34.0 → 3.37.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (400) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/{dist/cjs → dist-cjs}/Transfer.js +1 -13
  3. package/dist-cjs/TransferClient.js +35 -0
  4. package/{dist/cjs → dist-cjs}/commands/CreateAccessCommand.js +2 -32
  5. package/{dist/cjs → dist-cjs}/commands/CreateServerCommand.js +2 -30
  6. package/{dist/cjs → dist-cjs}/commands/CreateUserCommand.js +2 -33
  7. package/{dist/cjs → dist-cjs}/commands/CreateWorkflowCommand.js +2 -30
  8. package/{dist/cjs → dist-cjs}/commands/DeleteAccessCommand.js +2 -28
  9. package/{dist/cjs → dist-cjs}/commands/DeleteServerCommand.js +2 -29
  10. package/{dist/cjs → dist-cjs}/commands/DeleteSshPublicKeyCommand.js +2 -27
  11. package/{dist/cjs → dist-cjs}/commands/DeleteUserCommand.js +2 -33
  12. package/{dist/cjs → dist-cjs}/commands/DeleteWorkflowCommand.js +2 -27
  13. package/{dist/cjs → dist-cjs}/commands/DescribeAccessCommand.js +2 -32
  14. package/{dist/cjs → dist-cjs}/commands/DescribeExecutionCommand.js +2 -27
  15. package/{dist/cjs → dist-cjs}/commands/DescribeSecurityPolicyCommand.js +2 -30
  16. package/{dist/cjs → dist-cjs}/commands/DescribeServerCommand.js +2 -32
  17. package/{dist/cjs → dist-cjs}/commands/DescribeUserCommand.js +2 -31
  18. package/{dist/cjs → dist-cjs}/commands/DescribeWorkflowCommand.js +2 -27
  19. package/{dist/cjs → dist-cjs}/commands/ImportSshPublicKeyCommand.js +2 -32
  20. package/{dist/cjs → dist-cjs}/commands/ListAccessesCommand.js +2 -27
  21. package/{dist/cjs → dist-cjs}/commands/ListExecutionsCommand.js +2 -27
  22. package/{dist/cjs → dist-cjs}/commands/ListSecurityPoliciesCommand.js +2 -28
  23. package/{dist/cjs → dist-cjs}/commands/ListServersCommand.js +2 -28
  24. package/{dist/cjs → dist-cjs}/commands/ListTagsForResourceCommand.js +2 -28
  25. package/{dist/cjs → dist-cjs}/commands/ListUsersCommand.js +2 -28
  26. package/{dist/cjs → dist-cjs}/commands/ListWorkflowsCommand.js +2 -27
  27. package/{dist/cjs → dist-cjs}/commands/SendWorkflowStepStateCommand.js +2 -31
  28. package/{dist/cjs → dist-cjs}/commands/StartServerCommand.js +2 -35
  29. package/dist-cjs/commands/StopServerCommand.js +36 -0
  30. package/{dist/cjs → dist-cjs}/commands/TagResourceCommand.js +2 -30
  31. package/dist-cjs/commands/TestIdentityProviderCommand.js +36 -0
  32. package/{dist/cjs → dist-cjs}/commands/UntagResourceCommand.js +2 -30
  33. package/{dist/cjs → dist-cjs}/commands/UpdateAccessCommand.js +2 -28
  34. package/{dist/cjs → dist-cjs}/commands/UpdateServerCommand.js +2 -31
  35. package/{dist/cjs → dist-cjs}/commands/UpdateUserCommand.js +2 -32
  36. package/{dist/cjs → dist-cjs}/endpoints.js +1 -2
  37. package/{dist/cjs → dist-cjs}/index.js +0 -1
  38. package/{dist/cjs → dist-cjs}/models/index.js +0 -1
  39. package/{dist/cjs → dist-cjs}/models/models_0.js +0 -304
  40. package/{dist/cjs → dist-cjs}/pagination/Interfaces.js +0 -1
  41. package/{dist/cjs → dist-cjs}/pagination/ListAccessesPaginator.js +1 -12
  42. package/{dist/cjs → dist-cjs}/pagination/ListExecutionsPaginator.js +1 -12
  43. package/{dist/cjs → dist-cjs}/pagination/ListSecurityPoliciesPaginator.js +1 -12
  44. package/{dist/cjs → dist-cjs}/pagination/ListServersPaginator.js +1 -12
  45. package/{dist/cjs → dist-cjs}/pagination/ListTagsForResourcePaginator.js +1 -12
  46. package/{dist/cjs → dist-cjs}/pagination/ListUsersPaginator.js +1 -12
  47. package/{dist/cjs → dist-cjs}/pagination/ListWorkflowsPaginator.js +1 -12
  48. package/{dist/cjs → dist-cjs}/protocols/Aws_json1_1.js +0 -6
  49. package/{dist/cjs → dist-cjs}/runtimeConfig.browser.js +1 -5
  50. package/{dist/cjs → dist-cjs}/runtimeConfig.js +1 -5
  51. package/{dist/cjs → dist-cjs}/runtimeConfig.native.js +0 -4
  52. package/{dist/cjs → dist-cjs}/runtimeConfig.shared.js +1 -5
  53. package/{dist/es → dist-es}/Transfer.js +1 -2
  54. package/{dist/es → dist-es}/TransferClient.js +1 -2
  55. package/{dist/es → dist-es}/commands/CreateAccessCommand.js +2 -3
  56. package/{dist/es → dist-es}/commands/CreateServerCommand.js +2 -3
  57. package/{dist/es → dist-es}/commands/CreateUserCommand.js +2 -3
  58. package/{dist/es → dist-es}/commands/CreateWorkflowCommand.js +2 -3
  59. package/{dist/es → dist-es}/commands/DeleteAccessCommand.js +2 -3
  60. package/{dist/es → dist-es}/commands/DeleteServerCommand.js +2 -3
  61. package/{dist/es → dist-es}/commands/DeleteSshPublicKeyCommand.js +2 -3
  62. package/{dist/es → dist-es}/commands/DeleteUserCommand.js +2 -3
  63. package/{dist/es → dist-es}/commands/DeleteWorkflowCommand.js +2 -3
  64. package/{dist/es → dist-es}/commands/DescribeAccessCommand.js +2 -3
  65. package/{dist/es → dist-es}/commands/DescribeExecutionCommand.js +2 -3
  66. package/{dist/es → dist-es}/commands/DescribeSecurityPolicyCommand.js +2 -3
  67. package/{dist/es → dist-es}/commands/DescribeServerCommand.js +2 -3
  68. package/{dist/es → dist-es}/commands/DescribeUserCommand.js +2 -3
  69. package/{dist/es → dist-es}/commands/DescribeWorkflowCommand.js +2 -3
  70. package/{dist/es → dist-es}/commands/ImportSshPublicKeyCommand.js +2 -3
  71. package/{dist/es → dist-es}/commands/ListAccessesCommand.js +2 -3
  72. package/{dist/es → dist-es}/commands/ListExecutionsCommand.js +2 -3
  73. package/{dist/es → dist-es}/commands/ListSecurityPoliciesCommand.js +2 -3
  74. package/{dist/es → dist-es}/commands/ListServersCommand.js +2 -3
  75. package/{dist/es → dist-es}/commands/ListTagsForResourceCommand.js +2 -3
  76. package/{dist/es → dist-es}/commands/ListUsersCommand.js +2 -3
  77. package/{dist/es → dist-es}/commands/ListWorkflowsCommand.js +2 -3
  78. package/{dist/es → dist-es}/commands/SendWorkflowStepStateCommand.js +2 -3
  79. package/{dist/es → dist-es}/commands/StartServerCommand.js +2 -3
  80. package/{dist/es → dist-es}/commands/StopServerCommand.js +2 -3
  81. package/{dist/es → dist-es}/commands/TagResourceCommand.js +2 -3
  82. package/{dist/es → dist-es}/commands/TestIdentityProviderCommand.js +2 -3
  83. package/{dist/es → dist-es}/commands/UntagResourceCommand.js +2 -3
  84. package/{dist/es → dist-es}/commands/UpdateAccessCommand.js +2 -3
  85. package/{dist/es → dist-es}/commands/UpdateServerCommand.js +2 -3
  86. package/{dist/es → dist-es}/commands/UpdateUserCommand.js +2 -3
  87. package/{dist/es → dist-es}/endpoints.js +1 -2
  88. package/{dist/types/index.d.ts → dist-es/index.js} +0 -0
  89. package/{dist/types/models/index.d.ts → dist-es/models/index.js} +0 -0
  90. package/{dist/es → dist-es}/models/models_0.js +0 -1
  91. package/dist-es/pagination/Interfaces.js +1 -0
  92. package/{dist/es → dist-es}/pagination/ListAccessesPaginator.js +1 -2
  93. package/{dist/es → dist-es}/pagination/ListExecutionsPaginator.js +1 -2
  94. package/{dist/es → dist-es}/pagination/ListSecurityPoliciesPaginator.js +1 -2
  95. package/{dist/es → dist-es}/pagination/ListServersPaginator.js +1 -2
  96. package/{dist/es → dist-es}/pagination/ListTagsForResourcePaginator.js +1 -2
  97. package/{dist/es → dist-es}/pagination/ListUsersPaginator.js +1 -2
  98. package/{dist/es → dist-es}/pagination/ListWorkflowsPaginator.js +1 -2
  99. package/{dist/es → dist-es}/protocols/Aws_json1_1.js +0 -1
  100. package/{dist/es → dist-es}/runtimeConfig.browser.js +1 -2
  101. package/{dist/es → dist-es}/runtimeConfig.js +1 -2
  102. package/{dist/es → dist-es}/runtimeConfig.native.js +0 -1
  103. package/{dist/es → dist-es}/runtimeConfig.shared.js +1 -2
  104. package/{dist/types → dist-types}/Transfer.d.ts +2 -2
  105. package/{dist/types → dist-types}/TransferClient.d.ts +8 -8
  106. package/{dist/types → dist-types}/commands/CreateAccessCommand.d.ts +3 -3
  107. package/{dist/types → dist-types}/commands/CreateServerCommand.d.ts +3 -3
  108. package/{dist/types → dist-types}/commands/CreateUserCommand.d.ts +3 -3
  109. package/{dist/types → dist-types}/commands/CreateWorkflowCommand.d.ts +3 -3
  110. package/{dist/types → dist-types}/commands/DeleteAccessCommand.d.ts +3 -3
  111. package/{dist/types → dist-types}/commands/DeleteServerCommand.d.ts +3 -3
  112. package/{dist/types → dist-types}/commands/DeleteSshPublicKeyCommand.d.ts +3 -3
  113. package/{dist/types → dist-types}/commands/DeleteUserCommand.d.ts +3 -3
  114. package/{dist/types → dist-types}/commands/DeleteWorkflowCommand.d.ts +3 -3
  115. package/{dist/types → dist-types}/commands/DescribeAccessCommand.d.ts +3 -3
  116. package/{dist/types → dist-types}/commands/DescribeExecutionCommand.d.ts +3 -3
  117. package/{dist/types → dist-types}/commands/DescribeSecurityPolicyCommand.d.ts +3 -3
  118. package/{dist/types → dist-types}/commands/DescribeServerCommand.d.ts +3 -3
  119. package/{dist/types → dist-types}/commands/DescribeUserCommand.d.ts +3 -3
  120. package/{dist/types → dist-types}/commands/DescribeWorkflowCommand.d.ts +3 -3
  121. package/{dist/types → dist-types}/commands/ImportSshPublicKeyCommand.d.ts +3 -3
  122. package/{dist/types → dist-types}/commands/ListAccessesCommand.d.ts +3 -3
  123. package/{dist/types → dist-types}/commands/ListExecutionsCommand.d.ts +3 -3
  124. package/{dist/types → dist-types}/commands/ListSecurityPoliciesCommand.d.ts +3 -3
  125. package/{dist/types → dist-types}/commands/ListServersCommand.d.ts +3 -3
  126. package/{dist/types → dist-types}/commands/ListTagsForResourceCommand.d.ts +3 -3
  127. package/{dist/types → dist-types}/commands/ListUsersCommand.d.ts +3 -3
  128. package/{dist/types → dist-types}/commands/ListWorkflowsCommand.d.ts +3 -3
  129. package/{dist/types → dist-types}/commands/SendWorkflowStepStateCommand.d.ts +3 -3
  130. package/{dist/types → dist-types}/commands/StartServerCommand.d.ts +3 -3
  131. package/{dist/types → dist-types}/commands/StopServerCommand.d.ts +3 -3
  132. package/{dist/types → dist-types}/commands/TagResourceCommand.d.ts +3 -3
  133. package/{dist/types → dist-types}/commands/TestIdentityProviderCommand.d.ts +3 -3
  134. package/{dist/types → dist-types}/commands/UntagResourceCommand.d.ts +3 -3
  135. package/{dist/types → dist-types}/commands/UpdateAccessCommand.d.ts +3 -3
  136. package/{dist/types → dist-types}/commands/UpdateServerCommand.d.ts +3 -3
  137. package/{dist/types → dist-types}/commands/UpdateUserCommand.d.ts +3 -3
  138. package/{dist/types → dist-types}/endpoints.d.ts +0 -0
  139. package/{index.ts → dist-types/index.d.ts} +0 -0
  140. package/{models/index.ts → dist-types/models/index.d.ts} +0 -0
  141. package/{dist/types → dist-types}/models/models_0.d.ts +37 -34
  142. package/{dist/types → dist-types}/pagination/Interfaces.d.ts +1 -1
  143. package/{dist/types → dist-types}/pagination/ListAccessesPaginator.d.ts +1 -1
  144. package/{dist/types → dist-types}/pagination/ListExecutionsPaginator.d.ts +1 -1
  145. package/{dist/types → dist-types}/pagination/ListSecurityPoliciesPaginator.d.ts +1 -1
  146. package/{dist/types → dist-types}/pagination/ListServersPaginator.d.ts +1 -1
  147. package/{dist/types → dist-types}/pagination/ListTagsForResourcePaginator.d.ts +1 -1
  148. package/{dist/types → dist-types}/pagination/ListUsersPaginator.d.ts +1 -1
  149. package/{dist/types → dist-types}/pagination/ListWorkflowsPaginator.d.ts +1 -1
  150. package/{dist/types → dist-types}/protocols/Aws_json1_1.d.ts +2 -2
  151. package/{dist/types → dist-types}/runtimeConfig.browser.d.ts +0 -0
  152. package/{dist/types → dist-types}/runtimeConfig.d.ts +1 -1
  153. package/{dist/types → dist-types}/runtimeConfig.native.d.ts +0 -0
  154. package/{dist/types → dist-types}/runtimeConfig.shared.d.ts +0 -0
  155. package/{dist/types → dist-types}/ts3.4/Transfer.d.ts +35 -241
  156. package/{dist/types → dist-types}/ts3.4/TransferClient.d.ts +32 -105
  157. package/dist-types/ts3.4/commands/CreateAccessCommand.d.ts +17 -0
  158. package/dist-types/ts3.4/commands/CreateServerCommand.d.ts +17 -0
  159. package/dist-types/ts3.4/commands/CreateUserCommand.d.ts +17 -0
  160. package/dist-types/ts3.4/commands/CreateWorkflowCommand.d.ts +17 -0
  161. package/dist-types/ts3.4/commands/DeleteAccessCommand.d.ts +17 -0
  162. package/dist-types/ts3.4/commands/DeleteServerCommand.d.ts +17 -0
  163. package/dist-types/ts3.4/commands/DeleteSshPublicKeyCommand.d.ts +17 -0
  164. package/dist-types/ts3.4/commands/DeleteUserCommand.d.ts +17 -0
  165. package/dist-types/ts3.4/commands/DeleteWorkflowCommand.d.ts +17 -0
  166. package/dist-types/ts3.4/commands/DescribeAccessCommand.d.ts +17 -0
  167. package/dist-types/ts3.4/commands/DescribeExecutionCommand.d.ts +17 -0
  168. package/dist-types/ts3.4/commands/DescribeSecurityPolicyCommand.d.ts +17 -0
  169. package/dist-types/ts3.4/commands/DescribeServerCommand.d.ts +17 -0
  170. package/dist-types/ts3.4/commands/DescribeUserCommand.d.ts +17 -0
  171. package/{dist/types → dist-types}/ts3.4/commands/DescribeWorkflowCommand.d.ts +5 -23
  172. package/dist-types/ts3.4/commands/ImportSshPublicKeyCommand.d.ts +17 -0
  173. package/dist-types/ts3.4/commands/ListAccessesCommand.d.ts +17 -0
  174. package/dist-types/ts3.4/commands/ListExecutionsCommand.d.ts +17 -0
  175. package/dist-types/ts3.4/commands/ListSecurityPoliciesCommand.d.ts +17 -0
  176. package/dist-types/ts3.4/commands/ListServersCommand.d.ts +17 -0
  177. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +17 -0
  178. package/dist-types/ts3.4/commands/ListUsersCommand.d.ts +17 -0
  179. package/{dist/types → dist-types}/ts3.4/commands/ListWorkflowsCommand.d.ts +5 -23
  180. package/dist-types/ts3.4/commands/SendWorkflowStepStateCommand.d.ts +17 -0
  181. package/dist-types/ts3.4/commands/StartServerCommand.d.ts +17 -0
  182. package/dist-types/ts3.4/commands/StopServerCommand.d.ts +17 -0
  183. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +17 -0
  184. package/dist-types/ts3.4/commands/TestIdentityProviderCommand.d.ts +17 -0
  185. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +17 -0
  186. package/dist-types/ts3.4/commands/UpdateAccessCommand.d.ts +17 -0
  187. package/dist-types/ts3.4/commands/UpdateServerCommand.d.ts +17 -0
  188. package/dist-types/ts3.4/commands/UpdateUserCommand.d.ts +17 -0
  189. package/{dist/types → dist-types}/ts3.4/endpoints.d.ts +0 -0
  190. package/{dist/types → dist-types}/ts3.4/index.d.ts +0 -0
  191. package/{dist/types → dist-types}/ts3.4/models/index.d.ts +0 -0
  192. package/dist-types/ts3.4/models/models_0.d.ts +1344 -0
  193. package/{dist/types → dist-types}/ts3.4/pagination/Interfaces.d.ts +1 -1
  194. package/{dist/types → dist-types}/ts3.4/pagination/ListAccessesPaginator.d.ts +1 -1
  195. package/{dist/types → dist-types}/ts3.4/pagination/ListExecutionsPaginator.d.ts +1 -1
  196. package/{dist/types → dist-types}/ts3.4/pagination/ListSecurityPoliciesPaginator.d.ts +1 -1
  197. package/{dist/types → dist-types}/ts3.4/pagination/ListServersPaginator.d.ts +1 -1
  198. package/{dist/types → dist-types}/ts3.4/pagination/ListTagsForResourcePaginator.d.ts +1 -1
  199. package/{dist/types → dist-types}/ts3.4/pagination/ListUsersPaginator.d.ts +1 -1
  200. package/{dist/types → dist-types}/ts3.4/pagination/ListWorkflowsPaginator.d.ts +1 -1
  201. package/{dist/types → dist-types}/ts3.4/protocols/Aws_json1_1.d.ts +2 -2
  202. package/{dist/types → dist-types}/ts3.4/runtimeConfig.browser.d.ts +1 -3
  203. package/{dist/types → dist-types}/ts3.4/runtimeConfig.d.ts +2 -4
  204. package/{dist/types → dist-types}/ts3.4/runtimeConfig.native.d.ts +1 -3
  205. package/{dist/types → dist-types}/ts3.4/runtimeConfig.shared.d.ts +1 -3
  206. package/package.json +45 -42
  207. package/Transfer.ts +0 -1227
  208. package/TransferClient.ts +0 -354
  209. package/commands/CreateAccessCommand.ts +0 -99
  210. package/commands/CreateServerCommand.ts +0 -97
  211. package/commands/CreateUserCommand.ts +0 -100
  212. package/commands/CreateWorkflowCommand.ts +0 -97
  213. package/commands/DeleteAccessCommand.ts +0 -95
  214. package/commands/DeleteServerCommand.ts +0 -96
  215. package/commands/DeleteSshPublicKeyCommand.ts +0 -94
  216. package/commands/DeleteUserCommand.ts +0 -100
  217. package/commands/DeleteWorkflowCommand.ts +0 -94
  218. package/commands/DescribeAccessCommand.ts +0 -99
  219. package/commands/DescribeExecutionCommand.ts +0 -94
  220. package/commands/DescribeSecurityPolicyCommand.ts +0 -97
  221. package/commands/DescribeServerCommand.ts +0 -99
  222. package/commands/DescribeUserCommand.ts +0 -98
  223. package/commands/DescribeWorkflowCommand.ts +0 -94
  224. package/commands/ImportSshPublicKeyCommand.ts +0 -99
  225. package/commands/ListAccessesCommand.ts +0 -94
  226. package/commands/ListExecutionsCommand.ts +0 -94
  227. package/commands/ListSecurityPoliciesCommand.ts +0 -95
  228. package/commands/ListServersCommand.ts +0 -95
  229. package/commands/ListTagsForResourceCommand.ts +0 -95
  230. package/commands/ListUsersCommand.ts +0 -92
  231. package/commands/ListWorkflowsCommand.ts +0 -94
  232. package/commands/SendWorkflowStepStateCommand.ts +0 -98
  233. package/commands/StartServerCommand.ts +0 -102
  234. package/commands/StopServerCommand.ts +0 -108
  235. package/commands/TagResourceCommand.ts +0 -97
  236. package/commands/TestIdentityProviderCommand.ts +0 -132
  237. package/commands/UntagResourceCommand.ts +0 -97
  238. package/commands/UpdateAccessCommand.ts +0 -95
  239. package/commands/UpdateServerCommand.ts +0 -98
  240. package/commands/UpdateUserCommand.ts +0 -99
  241. package/dist/cjs/Transfer.js.map +0 -1
  242. package/dist/cjs/TransferClient.js +0 -52
  243. package/dist/cjs/TransferClient.js.map +0 -1
  244. package/dist/cjs/commands/CreateAccessCommand.js.map +0 -1
  245. package/dist/cjs/commands/CreateServerCommand.js.map +0 -1
  246. package/dist/cjs/commands/CreateUserCommand.js.map +0 -1
  247. package/dist/cjs/commands/CreateWorkflowCommand.js.map +0 -1
  248. package/dist/cjs/commands/DeleteAccessCommand.js.map +0 -1
  249. package/dist/cjs/commands/DeleteServerCommand.js.map +0 -1
  250. package/dist/cjs/commands/DeleteSshPublicKeyCommand.js.map +0 -1
  251. package/dist/cjs/commands/DeleteUserCommand.js.map +0 -1
  252. package/dist/cjs/commands/DeleteWorkflowCommand.js.map +0 -1
  253. package/dist/cjs/commands/DescribeAccessCommand.js.map +0 -1
  254. package/dist/cjs/commands/DescribeExecutionCommand.js.map +0 -1
  255. package/dist/cjs/commands/DescribeSecurityPolicyCommand.js.map +0 -1
  256. package/dist/cjs/commands/DescribeServerCommand.js.map +0 -1
  257. package/dist/cjs/commands/DescribeUserCommand.js.map +0 -1
  258. package/dist/cjs/commands/DescribeWorkflowCommand.js.map +0 -1
  259. package/dist/cjs/commands/ImportSshPublicKeyCommand.js.map +0 -1
  260. package/dist/cjs/commands/ListAccessesCommand.js.map +0 -1
  261. package/dist/cjs/commands/ListExecutionsCommand.js.map +0 -1
  262. package/dist/cjs/commands/ListSecurityPoliciesCommand.js.map +0 -1
  263. package/dist/cjs/commands/ListServersCommand.js.map +0 -1
  264. package/dist/cjs/commands/ListTagsForResourceCommand.js.map +0 -1
  265. package/dist/cjs/commands/ListUsersCommand.js.map +0 -1
  266. package/dist/cjs/commands/ListWorkflowsCommand.js.map +0 -1
  267. package/dist/cjs/commands/SendWorkflowStepStateCommand.js.map +0 -1
  268. package/dist/cjs/commands/StartServerCommand.js.map +0 -1
  269. package/dist/cjs/commands/StopServerCommand.js +0 -75
  270. package/dist/cjs/commands/StopServerCommand.js.map +0 -1
  271. package/dist/cjs/commands/TagResourceCommand.js.map +0 -1
  272. package/dist/cjs/commands/TestIdentityProviderCommand.js +0 -99
  273. package/dist/cjs/commands/TestIdentityProviderCommand.js.map +0 -1
  274. package/dist/cjs/commands/UntagResourceCommand.js.map +0 -1
  275. package/dist/cjs/commands/UpdateAccessCommand.js.map +0 -1
  276. package/dist/cjs/commands/UpdateServerCommand.js.map +0 -1
  277. package/dist/cjs/commands/UpdateUserCommand.js.map +0 -1
  278. package/dist/cjs/endpoints.js.map +0 -1
  279. package/dist/cjs/index.js.map +0 -1
  280. package/dist/cjs/models/index.js.map +0 -1
  281. package/dist/cjs/models/models_0.js.map +0 -1
  282. package/dist/cjs/package.json +0 -91
  283. package/dist/cjs/pagination/Interfaces.js.map +0 -1
  284. package/dist/cjs/pagination/ListAccessesPaginator.js.map +0 -1
  285. package/dist/cjs/pagination/ListExecutionsPaginator.js.map +0 -1
  286. package/dist/cjs/pagination/ListSecurityPoliciesPaginator.js.map +0 -1
  287. package/dist/cjs/pagination/ListServersPaginator.js.map +0 -1
  288. package/dist/cjs/pagination/ListTagsForResourcePaginator.js.map +0 -1
  289. package/dist/cjs/pagination/ListUsersPaginator.js.map +0 -1
  290. package/dist/cjs/pagination/ListWorkflowsPaginator.js.map +0 -1
  291. package/dist/cjs/protocols/Aws_json1_1.js.map +0 -1
  292. package/dist/cjs/runtimeConfig.browser.js.map +0 -1
  293. package/dist/cjs/runtimeConfig.js.map +0 -1
  294. package/dist/cjs/runtimeConfig.native.js.map +0 -1
  295. package/dist/cjs/runtimeConfig.shared.js.map +0 -1
  296. package/dist/es/Transfer.js.map +0 -1
  297. package/dist/es/TransferClient.js.map +0 -1
  298. package/dist/es/commands/CreateAccessCommand.js.map +0 -1
  299. package/dist/es/commands/CreateServerCommand.js.map +0 -1
  300. package/dist/es/commands/CreateUserCommand.js.map +0 -1
  301. package/dist/es/commands/CreateWorkflowCommand.js.map +0 -1
  302. package/dist/es/commands/DeleteAccessCommand.js.map +0 -1
  303. package/dist/es/commands/DeleteServerCommand.js.map +0 -1
  304. package/dist/es/commands/DeleteSshPublicKeyCommand.js.map +0 -1
  305. package/dist/es/commands/DeleteUserCommand.js.map +0 -1
  306. package/dist/es/commands/DeleteWorkflowCommand.js.map +0 -1
  307. package/dist/es/commands/DescribeAccessCommand.js.map +0 -1
  308. package/dist/es/commands/DescribeExecutionCommand.js.map +0 -1
  309. package/dist/es/commands/DescribeSecurityPolicyCommand.js.map +0 -1
  310. package/dist/es/commands/DescribeServerCommand.js.map +0 -1
  311. package/dist/es/commands/DescribeUserCommand.js.map +0 -1
  312. package/dist/es/commands/DescribeWorkflowCommand.js.map +0 -1
  313. package/dist/es/commands/ImportSshPublicKeyCommand.js.map +0 -1
  314. package/dist/es/commands/ListAccessesCommand.js.map +0 -1
  315. package/dist/es/commands/ListExecutionsCommand.js.map +0 -1
  316. package/dist/es/commands/ListSecurityPoliciesCommand.js.map +0 -1
  317. package/dist/es/commands/ListServersCommand.js.map +0 -1
  318. package/dist/es/commands/ListTagsForResourceCommand.js.map +0 -1
  319. package/dist/es/commands/ListUsersCommand.js.map +0 -1
  320. package/dist/es/commands/ListWorkflowsCommand.js.map +0 -1
  321. package/dist/es/commands/SendWorkflowStepStateCommand.js.map +0 -1
  322. package/dist/es/commands/StartServerCommand.js.map +0 -1
  323. package/dist/es/commands/StopServerCommand.js.map +0 -1
  324. package/dist/es/commands/TagResourceCommand.js.map +0 -1
  325. package/dist/es/commands/TestIdentityProviderCommand.js.map +0 -1
  326. package/dist/es/commands/UntagResourceCommand.js.map +0 -1
  327. package/dist/es/commands/UpdateAccessCommand.js.map +0 -1
  328. package/dist/es/commands/UpdateServerCommand.js.map +0 -1
  329. package/dist/es/commands/UpdateUserCommand.js.map +0 -1
  330. package/dist/es/endpoints.js.map +0 -1
  331. package/dist/es/index.js +0 -44
  332. package/dist/es/index.js.map +0 -1
  333. package/dist/es/models/index.js +0 -2
  334. package/dist/es/models/index.js.map +0 -1
  335. package/dist/es/models/models_0.js.map +0 -1
  336. package/dist/es/package.json +0 -91
  337. package/dist/es/pagination/Interfaces.js +0 -2
  338. package/dist/es/pagination/Interfaces.js.map +0 -1
  339. package/dist/es/pagination/ListAccessesPaginator.js.map +0 -1
  340. package/dist/es/pagination/ListExecutionsPaginator.js.map +0 -1
  341. package/dist/es/pagination/ListSecurityPoliciesPaginator.js.map +0 -1
  342. package/dist/es/pagination/ListServersPaginator.js.map +0 -1
  343. package/dist/es/pagination/ListTagsForResourcePaginator.js.map +0 -1
  344. package/dist/es/pagination/ListUsersPaginator.js.map +0 -1
  345. package/dist/es/pagination/ListWorkflowsPaginator.js.map +0 -1
  346. package/dist/es/protocols/Aws_json1_1.js.map +0 -1
  347. package/dist/es/runtimeConfig.browser.js.map +0 -1
  348. package/dist/es/runtimeConfig.js.map +0 -1
  349. package/dist/es/runtimeConfig.native.js.map +0 -1
  350. package/dist/es/runtimeConfig.shared.js.map +0 -1
  351. package/dist/types/ts3.4/commands/CreateAccessCommand.d.ts +0 -40
  352. package/dist/types/ts3.4/commands/CreateServerCommand.d.ts +0 -38
  353. package/dist/types/ts3.4/commands/CreateUserCommand.d.ts +0 -41
  354. package/dist/types/ts3.4/commands/CreateWorkflowCommand.d.ts +0 -38
  355. package/dist/types/ts3.4/commands/DeleteAccessCommand.d.ts +0 -36
  356. package/dist/types/ts3.4/commands/DeleteServerCommand.d.ts +0 -37
  357. package/dist/types/ts3.4/commands/DeleteSshPublicKeyCommand.d.ts +0 -35
  358. package/dist/types/ts3.4/commands/DeleteUserCommand.d.ts +0 -41
  359. package/dist/types/ts3.4/commands/DeleteWorkflowCommand.d.ts +0 -35
  360. package/dist/types/ts3.4/commands/DescribeAccessCommand.d.ts +0 -40
  361. package/dist/types/ts3.4/commands/DescribeExecutionCommand.d.ts +0 -35
  362. package/dist/types/ts3.4/commands/DescribeSecurityPolicyCommand.d.ts +0 -38
  363. package/dist/types/ts3.4/commands/DescribeServerCommand.d.ts +0 -40
  364. package/dist/types/ts3.4/commands/DescribeUserCommand.d.ts +0 -39
  365. package/dist/types/ts3.4/commands/ImportSshPublicKeyCommand.d.ts +0 -40
  366. package/dist/types/ts3.4/commands/ListAccessesCommand.d.ts +0 -35
  367. package/dist/types/ts3.4/commands/ListExecutionsCommand.d.ts +0 -35
  368. package/dist/types/ts3.4/commands/ListSecurityPoliciesCommand.d.ts +0 -36
  369. package/dist/types/ts3.4/commands/ListServersCommand.d.ts +0 -36
  370. package/dist/types/ts3.4/commands/ListTagsForResourceCommand.d.ts +0 -36
  371. package/dist/types/ts3.4/commands/ListUsersCommand.d.ts +0 -36
  372. package/dist/types/ts3.4/commands/SendWorkflowStepStateCommand.d.ts +0 -39
  373. package/dist/types/ts3.4/commands/StartServerCommand.d.ts +0 -43
  374. package/dist/types/ts3.4/commands/StopServerCommand.d.ts +0 -49
  375. package/dist/types/ts3.4/commands/TagResourceCommand.d.ts +0 -38
  376. package/dist/types/ts3.4/commands/TestIdentityProviderCommand.d.ts +0 -73
  377. package/dist/types/ts3.4/commands/UntagResourceCommand.d.ts +0 -38
  378. package/dist/types/ts3.4/commands/UpdateAccessCommand.d.ts +0 -36
  379. package/dist/types/ts3.4/commands/UpdateServerCommand.d.ts +0 -39
  380. package/dist/types/ts3.4/commands/UpdateUserCommand.d.ts +0 -40
  381. package/dist/types/ts3.4/models/models_0.d.ts +0 -3311
  382. package/endpoints.ts +0 -91
  383. package/jest.config.js +0 -4
  384. package/models/models_0.ts +0 -3940
  385. package/pagination/Interfaces.ts +0 -7
  386. package/pagination/ListAccessesPaginator.ts +0 -58
  387. package/pagination/ListExecutionsPaginator.ts +0 -58
  388. package/pagination/ListSecurityPoliciesPaginator.ts +0 -58
  389. package/pagination/ListServersPaginator.ts +0 -54
  390. package/pagination/ListTagsForResourcePaginator.ts +0 -58
  391. package/pagination/ListUsersPaginator.ts +0 -54
  392. package/pagination/ListWorkflowsPaginator.ts +0 -58
  393. package/protocols/Aws_json1_1.ts +0 -5078
  394. package/runtimeConfig.browser.ts +0 -40
  395. package/runtimeConfig.native.ts +0 -16
  396. package/runtimeConfig.shared.ts +0 -16
  397. package/runtimeConfig.ts +0 -45
  398. package/tsconfig.es.json +0 -10
  399. package/tsconfig.json +0 -31
  400. package/tsconfig.types.json +0 -8
@@ -1,3311 +0,0 @@
1
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
- /**
3
- * <p>You do not have sufficient access to perform this action.</p>
4
- */
5
- export interface AccessDeniedException extends __SmithyException, $MetadataBearer {
6
- name: "AccessDeniedException";
7
- $fault: "client";
8
- Message?: string;
9
- }
10
- export declare namespace AccessDeniedException {
11
- /**
12
- * @internal
13
- */
14
- const filterSensitiveLog: (obj: AccessDeniedException) => any;
15
- }
16
- /**
17
- * <p>This exception is thrown when the <code>UpdateServer</code> is called for a file transfer
18
- * protocol-enabled server that has VPC as the endpoint type and the server's
19
- * <code>VpcEndpointID</code> is not in the available state.</p>
20
- */
21
- export interface ConflictException extends __SmithyException, $MetadataBearer {
22
- name: "ConflictException";
23
- $fault: "client";
24
- Message: string | undefined;
25
- }
26
- export declare namespace ConflictException {
27
- /**
28
- * @internal
29
- */
30
- const filterSensitiveLog: (obj: ConflictException) => any;
31
- }
32
- /**
33
- * <p>Specifies the details for the file location for the file being used in the workflow. Only applicable if you are using Amazon EFS for storage.</p>
34
- * <p>
35
- * You need to provide the file system ID and the pathname.
36
- * The pathname can represent either a path or a file.
37
- * This is determined by whether or not you end the path value with the forward slash (/) character.
38
- * If the final character is "/", then your file is copied to the folder, and its name does not change.
39
- * If, rather, the final character is alphanumeric, your uploaded file is renamed to the path value. In this case, if a file with that name already exists, it is overwritten.
40
- * </p>
41
- * <p>For example, if your path is <code>shared-files/bob/</code>, your uploaded files are copied to the <code>shared-files/bob/</code>, folder.
42
- * If your path is <code>shared-files/today</code>, each uploaded file is copied to the <code>shared-files</code> folder and named <code>today</code>:
43
- * each upload overwrites the previous version of the <code>bob</code> file.</p>
44
- */
45
- export interface EfsFileLocation {
46
- /**
47
- * <p>The ID of the file system, assigned by Amazon EFS.</p>
48
- */
49
- FileSystemId?: string;
50
- /**
51
- * <p>The pathname for the folder being used by a workflow.</p>
52
- */
53
- Path?: string;
54
- }
55
- export declare namespace EfsFileLocation {
56
- /**
57
- * @internal
58
- */
59
- const filterSensitiveLog: (obj: EfsFileLocation) => any;
60
- }
61
- /**
62
- * <p>Specifies the details for the S3 file being copied.</p>
63
- */
64
- export interface S3InputFileLocation {
65
- /**
66
- * <p>Specifies the S3 bucket that contains the file being copied.</p>
67
- */
68
- Bucket?: string;
69
- /**
70
- * <p>The name assigned to the file when it was created in S3. You use the object key to retrieve the object.</p>
71
- */
72
- Key?: string;
73
- }
74
- export declare namespace S3InputFileLocation {
75
- /**
76
- * @internal
77
- */
78
- const filterSensitiveLog: (obj: S3InputFileLocation) => any;
79
- }
80
- /**
81
- * <p>Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps.</p>
82
- */
83
- export interface InputFileLocation {
84
- /**
85
- * <p>Specifies the details for the S3 file being copied.</p>
86
- */
87
- S3FileLocation?: S3InputFileLocation;
88
- /**
89
- * <p>Specifies the details for the Amazon EFS file being copied.</p>
90
- */
91
- EfsFileLocation?: EfsFileLocation;
92
- }
93
- export declare namespace InputFileLocation {
94
- /**
95
- * @internal
96
- */
97
- const filterSensitiveLog: (obj: InputFileLocation) => any;
98
- }
99
- export declare enum OverwriteExisting {
100
- FALSE = "FALSE",
101
- TRUE = "TRUE"
102
- }
103
- /**
104
- * <p>Each step type has its own <code>StepDetails</code> structure.</p>
105
- */
106
- export interface CopyStepDetails {
107
- /**
108
- * <p>The name of the step, used as an identifier.</p>
109
- */
110
- Name?: string;
111
- /**
112
- * <p>Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps.</p>
113
- */
114
- DestinationFileLocation?: InputFileLocation;
115
- /**
116
- * <p>A flag that indicates whether or not to overwrite an existing file of the same name.
117
- * The default is <code>FALSE</code>.</p>
118
- */
119
- OverwriteExisting?: OverwriteExisting | string;
120
- }
121
- export declare namespace CopyStepDetails {
122
- /**
123
- * @internal
124
- */
125
- const filterSensitiveLog: (obj: CopyStepDetails) => any;
126
- }
127
- /**
128
- * <p>Represents an object that contains entries and targets for
129
- * <code>HomeDirectoryMappings</code>.</p>
130
- * <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p>
131
- * <p>
132
- * <code>[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]</code>
133
- * </p>
134
- *
135
- * <note>
136
- * <p>If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is
137
- * ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place
138
- * holders for your directory. If using the CLI, use the <code>s3api</code> or <code>efsapi</code> call instead of
139
- * <code>s3</code> or <code>efs</code> so you can use the put-object operation. For example, you use the
140
- * following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make
141
- * sure that the end of the key name ends in a <code>/</code> for it to be considered a folder.</p>
142
- * </note>
143
- */
144
- export interface HomeDirectoryMapEntry {
145
- /**
146
- * <p>Represents an entry for <code>HomeDirectoryMappings</code>.</p>
147
- */
148
- Entry: string | undefined;
149
- /**
150
- * <p>Represents the map target that is used in a <code>HomeDirectorymapEntry</code>.</p>
151
- */
152
- Target: string | undefined;
153
- }
154
- export declare namespace HomeDirectoryMapEntry {
155
- /**
156
- * @internal
157
- */
158
- const filterSensitiveLog: (obj: HomeDirectoryMapEntry) => any;
159
- }
160
- export declare enum HomeDirectoryType {
161
- LOGICAL = "LOGICAL",
162
- PATH = "PATH"
163
- }
164
- /**
165
- * <p>The full POSIX identity, including user ID (<code>Uid</code>), group ID
166
- * (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
167
- * your users' access to your Amazon EFS file systems. The POSIX permissions that are set on
168
- * files and directories in your file system determine the level of access your users get when
169
- * transferring files into and out of your Amazon EFS file systems.</p>
170
- */
171
- export interface PosixProfile {
172
- /**
173
- * <p>The POSIX user ID used for all EFS operations by this user.</p>
174
- */
175
- Uid: number | undefined;
176
- /**
177
- * <p>The POSIX group ID used for all EFS operations by this user.</p>
178
- */
179
- Gid: number | undefined;
180
- /**
181
- * <p>The secondary POSIX group IDs used for all EFS operations by this user.</p>
182
- */
183
- SecondaryGids?: number[];
184
- }
185
- export declare namespace PosixProfile {
186
- /**
187
- * @internal
188
- */
189
- const filterSensitiveLog: (obj: PosixProfile) => any;
190
- }
191
- export interface CreateAccessRequest {
192
- /**
193
- * <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
194
- * <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
195
- */
196
- HomeDirectory?: string;
197
- /**
198
- * <p>The type of landing directory (folder) you want your users' home directory to be when they log into the server.
199
- * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.
200
- * If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon
201
- * S3 or EFS paths visible to your users.</p>
202
- */
203
- HomeDirectoryType?: HomeDirectoryType | string;
204
- /**
205
- * <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
206
- * be visible to your user and how you want to make them visible. You must specify the
207
- * <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
208
- * is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you
209
- * only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity
210
- * and Access Management (IAM) role provides access to paths in <code>Target</code>. This value
211
- * can only be set when <code>HomeDirectoryType</code> is set to
212
- * <i>LOGICAL</i>.</p>
213
- * <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p>
214
- * <p>
215
- * <code>[ { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]</code>
216
- * </p>
217
- * <p>In most cases, you can use this value instead of the session policy to lock down your
218
- * user to the designated home directory ("<code>chroot</code>"). To do this, you can set
219
- * <code>Entry</code> to <code>/</code> and set <code>Target</code> to the
220
- * <code>HomeDirectory</code> parameter value.</p>
221
- * <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p>
222
- * <p>
223
- * <code>[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]</code>
224
- * </p>
225
- *
226
- * <note>
227
- * <p>If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is
228
- * ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place
229
- * holders for your directory. If using the CLI, use the <code>s3api</code> or <code>efsapi</code> call instead of
230
- * <code>s3</code> or <code>efs</code> so you can use the put-object operation. For example, you use the
231
- * following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make
232
- * sure that the end of the key name ends in a <code>/</code> for it to be considered a folder.</p>
233
- * </note>
234
- */
235
- HomeDirectoryMappings?: HomeDirectoryMapEntry[];
236
- /**
237
- * <p>A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user
238
- * access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>,
239
- * <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>
240
- *
241
- * <note>
242
- * <p>This only applies when the domain of <code>ServerId</code> is S3. EFS does not use session policies.</p>
243
- * <p>For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead
244
- * of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass
245
- * it in the <code>Policy</code> argument.</p>
246
- * <p>For an example of a session policy, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html">Example
247
- * session policy</a>.</p>
248
- * <p>For more information, see <a href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html">AssumeRole</a> in the <i>Amazon Web Services Security Token Service API
249
- * Reference</i>.</p>
250
- * </note>
251
- */
252
- Policy?: string;
253
- /**
254
- * <p>The full POSIX identity, including user ID (<code>Uid</code>), group ID
255
- * (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
256
- * your users' access to your Amazon EFS file systems. The POSIX permissions that are set on
257
- * files and directories in your file system determine the level of access your users get when
258
- * transferring files into and out of your Amazon EFS file systems.</p>
259
- */
260
- PosixProfile?: PosixProfile;
261
- /**
262
- * <p>Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS
263
- * file system. The policies attached to this role determine the level of access that you want to provide your users when transferring
264
- * files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the
265
- * server to access your resources when servicing your users' transfer requests.</p>
266
- */
267
- Role: string | undefined;
268
- /**
269
- * <p>A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.</p>
270
- */
271
- ServerId: string | undefined;
272
- /**
273
- * <p>A unique identifier that is required to identify specific groups within your directory.
274
- * The users of the group that you associate have access to your Amazon S3 or Amazon EFS
275
- * resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,
276
- * you can view the SID values by running the following command using Windows PowerShell.</p>
277
- *
278
- * <p>
279
- * <code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code>
280
- * </p>
281
- *
282
- * <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
283
- *
284
- * <p>The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.
285
- * You can also include underscores or any of the following characters: =,.@:/-</p>
286
- */
287
- ExternalId: string | undefined;
288
- }
289
- export declare namespace CreateAccessRequest {
290
- /**
291
- * @internal
292
- */
293
- const filterSensitiveLog: (obj: CreateAccessRequest) => any;
294
- }
295
- export interface CreateAccessResponse {
296
- /**
297
- * <p>The ID of the server that the user is attached to.</p>
298
- */
299
- ServerId: string | undefined;
300
- /**
301
- * <p>The external ID of the group whose users have access to your Amazon S3 or Amazon EFS
302
- * resources over the enabled protocols using Amazon Web Services Transfer Family.</p>
303
- */
304
- ExternalId: string | undefined;
305
- }
306
- export declare namespace CreateAccessResponse {
307
- /**
308
- * @internal
309
- */
310
- const filterSensitiveLog: (obj: CreateAccessResponse) => any;
311
- }
312
- /**
313
- * <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
314
- */
315
- export interface InternalServiceError extends __SmithyException, $MetadataBearer {
316
- name: "InternalServiceError";
317
- $fault: "server";
318
- Message: string | undefined;
319
- }
320
- export declare namespace InternalServiceError {
321
- /**
322
- * @internal
323
- */
324
- const filterSensitiveLog: (obj: InternalServiceError) => any;
325
- }
326
- /**
327
- * <p>This exception is thrown when the client submits a malformed request.</p>
328
- */
329
- export interface InvalidRequestException extends __SmithyException, $MetadataBearer {
330
- name: "InvalidRequestException";
331
- $fault: "client";
332
- Message: string | undefined;
333
- }
334
- export declare namespace InvalidRequestException {
335
- /**
336
- * @internal
337
- */
338
- const filterSensitiveLog: (obj: InvalidRequestException) => any;
339
- }
340
- /**
341
- * <p>The requested resource does not exist.</p>
342
- */
343
- export interface ResourceExistsException extends __SmithyException, $MetadataBearer {
344
- name: "ResourceExistsException";
345
- $fault: "client";
346
- Message: string | undefined;
347
- Resource: string | undefined;
348
- ResourceType: string | undefined;
349
- }
350
- export declare namespace ResourceExistsException {
351
- /**
352
- * @internal
353
- */
354
- const filterSensitiveLog: (obj: ResourceExistsException) => any;
355
- }
356
- /**
357
- * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
358
- * service.</p>
359
- */
360
- export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
361
- name: "ResourceNotFoundException";
362
- $fault: "client";
363
- Message: string | undefined;
364
- Resource: string | undefined;
365
- ResourceType: string | undefined;
366
- }
367
- export declare namespace ResourceNotFoundException {
368
- /**
369
- * @internal
370
- */
371
- const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
372
- }
373
- /**
374
- * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
375
- */
376
- export interface ServiceUnavailableException extends __SmithyException, $MetadataBearer {
377
- name: "ServiceUnavailableException";
378
- $fault: "server";
379
- Message?: string;
380
- }
381
- export declare namespace ServiceUnavailableException {
382
- /**
383
- * @internal
384
- */
385
- const filterSensitiveLog: (obj: ServiceUnavailableException) => any;
386
- }
387
- export declare enum Domain {
388
- EFS = "EFS",
389
- S3 = "S3"
390
- }
391
- /**
392
- * <p>The virtual private cloud (VPC) endpoint settings that are configured for your file
393
- * transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server
394
- * and resources only within your VPC. To control incoming internet traffic, invoke the
395
- * <code>UpdateServer</code> API and attach an Elastic IP address to your server's
396
- * endpoint.</p>
397
- * <note>
398
- * <p> After May 19, 2021, you won't be able to create a server using
399
- * <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Servicesaccount if your account hasn't already
400
- * done so before May 19, 2021. If you have already created servers with
401
- * <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Servicesaccount on or before May 19, 2021,
402
- * you will not be affected. After this date, use
403
- * <code>EndpointType</code>=<code>VPC</code>.</p>
404
- *
405
- * <p>For more information, see
406
- * https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p>
407
- * </note>
408
- */
409
- export interface EndpointDetails {
410
- /**
411
- * <p>A list of address allocation IDs that are required to attach an Elastic IP address to your
412
- * server's endpoint.</p>
413
- *
414
- * <note>
415
- *
416
- * <p>This property can only be set when <code>EndpointType</code> is set to <code>VPC</code>
417
- * and it is only valid in the <code>UpdateServer</code> API.</p>
418
- * </note>
419
- */
420
- AddressAllocationIds?: string[];
421
- /**
422
- * <p>A list of subnet IDs that are required to host your server endpoint in your VPC.</p>
423
- *
424
- * <note>
425
- * <p>This property can only be set when <code>EndpointType</code> is set to
426
- * <code>VPC</code>.</p>
427
- * </note>
428
- */
429
- SubnetIds?: string[];
430
- /**
431
- * <p>The ID of the VPC endpoint.</p>
432
- *
433
- * <note>
434
- * <p>This property can only be set when <code>EndpointType</code> is set to
435
- * <code>VPC_ENDPOINT</code>.</p>
436
- *
437
- * <p>For more information, see
438
- * https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p>
439
- * </note>
440
- */
441
- VpcEndpointId?: string;
442
- /**
443
- * <p>The VPC ID of the VPC in which a server's endpoint will be hosted.</p>
444
- *
445
- * <note>
446
- * <p>This property can only be set when <code>EndpointType</code> is set to
447
- * <code>VPC</code>.</p>
448
- * </note>
449
- */
450
- VpcId?: string;
451
- /**
452
- * <p>A list of security groups IDs that are available to attach to your server's
453
- * endpoint.</p>
454
- *
455
- * <note>
456
- * <p>This property can only be set when <code>EndpointType</code> is set to
457
- * <code>VPC</code>.</p>
458
- *
459
- * <p>You can edit the <code>SecurityGroupIds</code> property in the <a href="https://docs.aws.amazon.com/transfer/latest/userguide/API_UpdateServer.html">UpdateServer</a> API only if you are changing the <code>EndpointType</code> from
460
- * <code>PUBLIC</code> or <code>VPC_ENDPOINT</code> to <code>VPC</code>. To change security
461
- * groups associated with your server's VPC endpoint after creation, use the Amazon EC2
462
- * <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyVpcEndpoint.html">ModifyVpcEndpoint</a> API.</p>
463
- * </note>
464
- */
465
- SecurityGroupIds?: string[];
466
- }
467
- export declare namespace EndpointDetails {
468
- /**
469
- * @internal
470
- */
471
- const filterSensitiveLog: (obj: EndpointDetails) => any;
472
- }
473
- export declare enum EndpointType {
474
- PUBLIC = "PUBLIC",
475
- VPC = "VPC",
476
- VPC_ENDPOINT = "VPC_ENDPOINT"
477
- }
478
- /**
479
- * <p>Returns information related to the type of user authentication that is in use for a file
480
- * transfer protocol-enabled server's users. A server can have only one method of
481
- * authentication.</p>
482
- */
483
- export interface IdentityProviderDetails {
484
- /**
485
- * <p>Provides the location of the service endpoint used to authenticate users.</p>
486
- */
487
- Url?: string;
488
- /**
489
- * <p>Provides the type of <code>InvocationRole</code> used to authenticate the user
490
- * account.</p>
491
- */
492
- InvocationRole?: string;
493
- /**
494
- * <p>The identifier of the Amazon Web ServicesDirectory Service directory that you want to stop sharing.</p>
495
- */
496
- DirectoryId?: string;
497
- }
498
- export declare namespace IdentityProviderDetails {
499
- /**
500
- * @internal
501
- */
502
- const filterSensitiveLog: (obj: IdentityProviderDetails) => any;
503
- }
504
- export declare enum IdentityProviderType {
505
- API_GATEWAY = "API_GATEWAY",
506
- AWS_DIRECTORY_SERVICE = "AWS_DIRECTORY_SERVICE",
507
- SERVICE_MANAGED = "SERVICE_MANAGED"
508
- }
509
- export declare enum Protocol {
510
- FTP = "FTP",
511
- FTPS = "FTPS",
512
- SFTP = "SFTP"
513
- }
514
- /**
515
- * <p>Creates a key-value pair for a specific resource. Tags are metadata that you can use to
516
- * search for and group a resource for various purposes. You can apply tags to servers, users,
517
- * and roles. A tag key can take more than one value. For example, to group servers for
518
- * accounting purposes, you might create a tag called <code>Group</code> and assign the values
519
- * <code>Research</code> and <code>Accounting</code> to that group.</p>
520
- */
521
- export interface Tag {
522
- /**
523
- * <p>The name assigned to the tag that you create.</p>
524
- */
525
- Key: string | undefined;
526
- /**
527
- * <p>Contains one or more values that you assigned to the key name you create.</p>
528
- */
529
- Value: string | undefined;
530
- }
531
- export declare namespace Tag {
532
- /**
533
- * @internal
534
- */
535
- const filterSensitiveLog: (obj: Tag) => any;
536
- }
537
- /**
538
- * <p>Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.</p>
539
- */
540
- export interface WorkflowDetail {
541
- /**
542
- * <p>A unique identifier for the workflow.</p>
543
- */
544
- WorkflowId: string | undefined;
545
- /**
546
- * <p>Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can
547
- * assume, so that all workflow steps can operate on the required resources</p>
548
- */
549
- ExecutionRole: string | undefined;
550
- }
551
- export declare namespace WorkflowDetail {
552
- /**
553
- * @internal
554
- */
555
- const filterSensitiveLog: (obj: WorkflowDetail) => any;
556
- }
557
- /**
558
- * <p>Container for the <code>WorkflowDetail</code> data type.
559
- * It is used by actions that trigger a workflow to begin execution.</p>
560
- */
561
- export interface WorkflowDetails {
562
- /**
563
- * <p>A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.</p>
564
- */
565
- OnUpload: WorkflowDetail[] | undefined;
566
- }
567
- export declare namespace WorkflowDetails {
568
- /**
569
- * @internal
570
- */
571
- const filterSensitiveLog: (obj: WorkflowDetails) => any;
572
- }
573
- export interface CreateServerRequest {
574
- /**
575
- * <p>The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager (ACM) certificate. Required
576
- * when <code>Protocols</code> is set to <code>FTPS</code>.</p>
577
- *
578
- * <p>To request a new public certificate, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html">Request a public certificate</a>
579
- * in the <i> Amazon Web Services Certificate Manager User Guide</i>.</p>
580
- *
581
- * <p>To import an existing certificate into ACM, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing certificates into ACM</a>
582
- * in the <i> Amazon Web Services Certificate Manager User Guide</i>.</p>
583
- *
584
- * <p>To request a private certificate to use FTPS through private IP addresses, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html">Request a
585
- * private certificate</a> in the <i> Amazon Web Services Certificate Manager User
586
- * Guide</i>.</p>
587
- *
588
- * <p>Certificates with the following cryptographic algorithms and key sizes are
589
- * supported:</p>
590
- *
591
- * <ul>
592
- * <li>
593
- * <p>2048-bit RSA (RSA_2048)</p>
594
- * </li>
595
- * <li>
596
- * <p>4096-bit RSA (RSA_4096)</p>
597
- * </li>
598
- * <li>
599
- * <p>Elliptic Prime Curve 256 bit (EC_prime256v1)</p>
600
- * </li>
601
- * <li>
602
- * <p>Elliptic Prime Curve 384 bit (EC_secp384r1)</p>
603
- * </li>
604
- * <li>
605
- * <p>Elliptic Prime Curve 521 bit (EC_secp521r1)</p>
606
- * </li>
607
- * </ul>
608
- *
609
- * <note>
610
- * <p>The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP
611
- * address specified and information about the issuer.</p>
612
- * </note>
613
- */
614
- Certificate?: string;
615
- /**
616
- * <p>The domain of the storage system that is used for file transfers. There are two domains
617
- * available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The
618
- * default value is S3.</p>
619
- *
620
- * <note>
621
- * <p>After the server is created, the domain cannot be changed.</p>
622
- * </note>
623
- */
624
- Domain?: Domain | string;
625
- /**
626
- * <p>The virtual private cloud (VPC) endpoint settings that are configured for your server.
627
- * When you host your endpoint within your VPC, you can make it accessible only to resources
628
- * within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over
629
- * the internet. Your VPC's default security groups are automatically assigned to your
630
- * endpoint.</p>
631
- */
632
- EndpointDetails?: EndpointDetails;
633
- /**
634
- * <p>The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC)
635
- * or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and
636
- * resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.</p>
637
- * <note>
638
- * <p> After May 19, 2021, you won't be able to create a server using
639
- * <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Services account if your account hasn't already
640
- * done so before May 19, 2021. If you have already created servers with
641
- * <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Services account on or before May 19, 2021,
642
- * you will not be affected. After this date, use
643
- * <code>EndpointType</code>=<code>VPC</code>.</p>
644
- *
645
- * <p>For more information, see
646
- * https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p>
647
- * <p>It is recommended that you use <code>VPC</code> as the <code>EndpointType</code>. With
648
- * this endpoint type, you have the option to directly associate up to three Elastic IPv4
649
- * addresses (BYO IP included) with your server's endpoint and use VPC security groups to
650
- * restrict traffic by the client's public IP address. This is not possible with
651
- * <code>EndpointType</code> set to <code>VPC_ENDPOINT</code>.</p>
652
- * </note>
653
- */
654
- EndpointType?: EndpointType | string;
655
- /**
656
- * <p>The RSA private key as generated by the <code>ssh-keygen -N "" -m PEM -f
657
- * my-new-server-key</code> command.</p>
658
- *
659
- * <important>
660
- * <p>If you aren't planning to migrate existing users from an existing SFTP-enabled
661
- * server to a new server, don't update the host key. Accidentally changing a
662
- * server's host key can be disruptive.</p>
663
- * </important>
664
- *
665
- *
666
- *
667
- * <p>For more information, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key">Change the host key for your SFTP-enabled server</a> in the <i>Amazon Web Services Transfer
668
- * Family User Guide</i>.</p>
669
- */
670
- HostKey?: string;
671
- /**
672
- * <p>Required when <code>IdentityProviderType</code> is set to
673
- * <code>AWS_DIRECTORY_SERVICE</code> or <code>API_GATEWAY</code>. Accepts an array containing
674
- * all of the information required to use a directory in <code>AWS_DIRECTORY_SERVICE</code> or
675
- * invoke a customer-supplied authentication API, including the API Gateway URL. Not required
676
- * when <code>IdentityProviderType</code> is set to <code>SERVICE_MANAGED</code>.</p>
677
- */
678
- IdentityProviderDetails?: IdentityProviderDetails;
679
- /**
680
- * <p>Specifies the mode of authentication for a server. The default value is
681
- * <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within
682
- * the Amazon Web Services Transfer Family service.</p>
683
- * <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to
684
- * Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your
685
- * on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to
686
- * provide a Directory ID using the <code>IdentityProviderDetails</code> parameter.</p>
687
- * <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The
688
- * <code>API_GATEWAY</code> setting requires you to provide an API Gateway endpoint URL to call
689
- * for authentication using the <code>IdentityProviderDetails</code> parameter.</p>
690
- */
691
- IdentityProviderType?: IdentityProviderType | string;
692
- /**
693
- * <p>Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn
694
- * on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in
695
- * your CloudWatch logs.</p>
696
- */
697
- LoggingRole?: string;
698
- /**
699
- * <p>Specifies the file transfer protocol or protocols over which your file transfer protocol
700
- * client can connect to your server's endpoint. The available protocols are:</p>
701
- *
702
- * <ul>
703
- * <li>
704
- * <p>
705
- * <code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over
706
- * SSH</p>
707
- * </li>
708
- * <li>
709
- * <p>
710
- * <code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS
711
- * encryption</p>
712
- * </li>
713
- * <li>
714
- * <p>
715
- * <code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p>
716
- * </li>
717
- * </ul>
718
- *
719
- * <note>
720
- * <p>If you select <code>FTPS</code>, you must choose a certificate stored in Amazon Web Services Certificate
721
- * Manager (ACM) which is used to identify your server when clients connect to it over
722
- * FTPS.</p>
723
- *
724
- * <p>If <code>Protocol</code> includes either <code>FTP</code> or <code>FTPS</code>, then the
725
- * <code>EndpointType</code> must be <code>VPC</code> and the
726
- * <code>IdentityProviderType</code> must be <code>AWS_DIRECTORY_SERVICE</code> or <code>API_GATEWAY</code>.</p>
727
- *
728
- * <p>If <code>Protocol</code> includes <code>FTP</code>, then
729
- * <code>AddressAllocationIds</code> cannot be associated.</p>
730
- *
731
- * <p>If <code>Protocol</code> is set only to <code>SFTP</code>, the <code>EndpointType</code>
732
- * can be set to <code>PUBLIC</code> and the <code>IdentityProviderType</code> can be set to
733
- * <code>SERVICE_MANAGED</code>.</p>
734
- * </note>
735
- */
736
- Protocols?: (Protocol | string)[];
737
- /**
738
- * <p>Specifies the name of the security policy that is attached to the server.</p>
739
- */
740
- SecurityPolicyName?: string;
741
- /**
742
- * <p>Key-value pairs that can be used to group and search for servers.</p>
743
- */
744
- Tags?: Tag[];
745
- /**
746
- * <p>Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.</p>
747
- */
748
- WorkflowDetails?: WorkflowDetails;
749
- }
750
- export declare namespace CreateServerRequest {
751
- /**
752
- * @internal
753
- */
754
- const filterSensitiveLog: (obj: CreateServerRequest) => any;
755
- }
756
- export interface CreateServerResponse {
757
- /**
758
- * <p>The service-assigned ID of the server that is created.</p>
759
- */
760
- ServerId: string | undefined;
761
- }
762
- export declare namespace CreateServerResponse {
763
- /**
764
- * @internal
765
- */
766
- const filterSensitiveLog: (obj: CreateServerResponse) => any;
767
- }
768
- /**
769
- * <p>The request was denied due to request throttling.</p>
770
- *
771
- * <p> HTTP Status Code: 400</p>
772
- */
773
- export interface ThrottlingException extends __SmithyException, $MetadataBearer {
774
- name: "ThrottlingException";
775
- $fault: "client";
776
- RetryAfterSeconds?: string;
777
- }
778
- export declare namespace ThrottlingException {
779
- /**
780
- * @internal
781
- */
782
- const filterSensitiveLog: (obj: ThrottlingException) => any;
783
- }
784
- export interface CreateUserRequest {
785
- /**
786
- * <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
787
- * <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
788
- */
789
- HomeDirectory?: string;
790
- /**
791
- * <p>The type of landing directory (folder) you want your users' home directory to be when they log into the server.
792
- * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.
793
- * If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon
794
- * S3 or EFS paths visible to your users.</p>
795
- */
796
- HomeDirectoryType?: HomeDirectoryType | string;
797
- /**
798
- * <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
799
- * be visible to your user and how you want to make them visible. You must specify the
800
- * <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
801
- * is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you
802
- * only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity
803
- * and Access Management (IAM) role provides access to paths in <code>Target</code>. This value
804
- * can only be set when <code>HomeDirectoryType</code> is set to
805
- * <i>LOGICAL</i>.</p>
806
- *
807
- * <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p>
808
- *
809
- * <p>
810
- * <code>[ { "Entry": "your-personal-report.pdf", "Target":
811
- * "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]</code>
812
- * </p>
813
- *
814
- * <p>In most cases, you can use this value instead of the session policy to lock your user
815
- * down to the designated home directory ("<code>chroot</code>"). To do this, you can set
816
- * <code>Entry</code> to <code>/</code> and set <code>Target</code> to the HomeDirectory
817
- * parameter value.</p>
818
- * <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p>
819
- * <p>
820
- * <code>[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]</code>
821
- * </p>
822
- *
823
- * <note>
824
- * <p>If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is
825
- * ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place
826
- * holders for your directory. If using the CLI, use the <code>s3api</code> or <code>efsapi</code> call instead of
827
- * <code>s3</code> or <code>efs</code> so you can use the put-object operation. For example, you use the
828
- * following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make
829
- * sure that the end of the key name ends in a <code>/</code> for it to be considered a folder.</p>
830
- * </note>
831
- */
832
- HomeDirectoryMappings?: HomeDirectoryMapEntry[];
833
- /**
834
- * <p>A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user
835
- * access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>,
836
- * <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>
837
- *
838
- * <note>
839
- * <p>This only applies when the domain of <code>ServerId</code> is S3. EFS does not use session policies.</p>
840
- * <p>For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead
841
- * of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass
842
- * it in the <code>Policy</code> argument.</p>
843
- *
844
- *
845
- *
846
- * <p>For an example of a session policy, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html">Example session
847
- * policy</a>.</p>
848
- *
849
- *
850
- *
851
- * <p>For more information, see <a href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html">AssumeRole</a> in the <i>Amazon Web Services
852
- * Security Token Service API Reference</i>.</p>
853
- * </note>
854
- */
855
- Policy?: string;
856
- /**
857
- * <p>Specifies the full POSIX identity, including user ID (<code>Uid</code>), group ID
858
- * (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
859
- * your users' access to your Amazon EFS file systems. The POSIX permissions that are set on
860
- * files and directories in Amazon EFS determine the level of access your users get when
861
- * transferring files into and out of your Amazon EFS file systems.</p>
862
- */
863
- PosixProfile?: PosixProfile;
864
- /**
865
- * <p>Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS
866
- * file system. The policies attached to this role determine the level of access that you want to provide your users when transferring
867
- * files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the
868
- * server to access your resources when servicing your users' transfer requests.</p>
869
- */
870
- Role: string | undefined;
871
- /**
872
- * <p>A system-assigned unique identifier for a server instance. This is the specific server
873
- * that you added your user to.</p>
874
- */
875
- ServerId: string | undefined;
876
- /**
877
- * <p>The public portion of the Secure Shell (SSH) key used to authenticate the user to the
878
- * server.</p>
879
- */
880
- SshPublicKeyBody?: string;
881
- /**
882
- * <p>Key-value pairs that can be used to group and search for users. Tags are metadata attached
883
- * to users for any purpose.</p>
884
- */
885
- Tags?: Tag[];
886
- /**
887
- * <p>A unique string that identifies a user and is associated with a <code>ServerId</code>. This user name must be a minimum of 3 and a maximum of 100 characters
888
- * long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen
889
- * '-', period '.', and at sign '@'. The user name can't start
890
- * with a hyphen, period, or at sign.</p>
891
- */
892
- UserName: string | undefined;
893
- }
894
- export declare namespace CreateUserRequest {
895
- /**
896
- * @internal
897
- */
898
- const filterSensitiveLog: (obj: CreateUserRequest) => any;
899
- }
900
- export interface CreateUserResponse {
901
- /**
902
- * <p>The ID of the server that the user is attached to.</p>
903
- */
904
- ServerId: string | undefined;
905
- /**
906
- * <p>A unique string that identifies a user account associated with a server.</p>
907
- */
908
- UserName: string | undefined;
909
- }
910
- export declare namespace CreateUserResponse {
911
- /**
912
- * @internal
913
- */
914
- const filterSensitiveLog: (obj: CreateUserResponse) => any;
915
- }
916
- /**
917
- * <p>Each step type has its own <code>StepDetails</code> structure.</p>
918
- */
919
- export interface CustomStepDetails {
920
- /**
921
- * <p>The name of the step, used as an identifier.</p>
922
- */
923
- Name?: string;
924
- /**
925
- * <p>The ARN for the lambda function that is being called.</p>
926
- */
927
- Target?: string;
928
- /**
929
- * <p>Timeout, in seconds, for the step.</p>
930
- */
931
- TimeoutSeconds?: number;
932
- }
933
- export declare namespace CustomStepDetails {
934
- /**
935
- * @internal
936
- */
937
- const filterSensitiveLog: (obj: CustomStepDetails) => any;
938
- }
939
- /**
940
- * <p>The name of the step, used to identify the step that is being deleted.</p>
941
- */
942
- export interface DeleteStepDetails {
943
- /**
944
- * <p>The name of the step, used as an identifier.</p>
945
- */
946
- Name?: string;
947
- }
948
- export declare namespace DeleteStepDetails {
949
- /**
950
- * @internal
951
- */
952
- const filterSensitiveLog: (obj: DeleteStepDetails) => any;
953
- }
954
- /**
955
- * <p>Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.</p>
956
- */
957
- export interface S3Tag {
958
- /**
959
- * <p>The name assigned to the tag that you create.</p>
960
- */
961
- Key: string | undefined;
962
- /**
963
- * <p>The value that corresponds to the key.</p>
964
- */
965
- Value: string | undefined;
966
- }
967
- export declare namespace S3Tag {
968
- /**
969
- * @internal
970
- */
971
- const filterSensitiveLog: (obj: S3Tag) => any;
972
- }
973
- /**
974
- * <p>Each step type has its own <code>StepDetails</code> structure.</p>
975
- * <p>The key/value pairs used to tag a file during the execution of a workflow step.</p>
976
- */
977
- export interface TagStepDetails {
978
- /**
979
- * <p>The name of the step, used as an identifier.</p>
980
- */
981
- Name?: string;
982
- /**
983
- * <p>Array that contains from 1 to 10 key/value pairs.</p>
984
- */
985
- Tags?: S3Tag[];
986
- }
987
- export declare namespace TagStepDetails {
988
- /**
989
- * @internal
990
- */
991
- const filterSensitiveLog: (obj: TagStepDetails) => any;
992
- }
993
- export declare enum WorkflowStepType {
994
- COPY = "COPY",
995
- CUSTOM = "CUSTOM",
996
- DELETE = "DELETE",
997
- TAG = "TAG"
998
- }
999
- /**
1000
- * <p>The basic building block of a workflow.</p>
1001
- */
1002
- export interface WorkflowStep {
1003
- /**
1004
- * <p>
1005
- * Currently, the following step types are supported.
1006
- * </p>
1007
- * <ul>
1008
- * <li>
1009
- * <p>
1010
- * <i>Copy</i>: copy the file to another location</p>
1011
- * </li>
1012
- * <li>
1013
- * <p>
1014
- * <i>Custom</i>: custom step with a lambda target</p>
1015
- * </li>
1016
- * <li>
1017
- * <p>
1018
- * <i>Delete</i>: delete the file</p>
1019
- * </li>
1020
- * <li>
1021
- * <p>
1022
- * <i>Tag</i>: add a tag to the file</p>
1023
- * </li>
1024
- * </ul>
1025
- */
1026
- Type?: WorkflowStepType | string;
1027
- /**
1028
- * <p>Details for a step that performs a file copy.</p>
1029
- * <p>
1030
- * Consists of the following values:
1031
- * </p>
1032
- * <ul>
1033
- * <li>
1034
- * <p>A description</p>
1035
- * </li>
1036
- * <li>
1037
- * <p>An S3 or EFS location for the destination of the file copy.</p>
1038
- * </li>
1039
- * <li>
1040
- * <p>A flag that indicates whether or not to overwrite an existing file of the same name.
1041
- * The default is <code>FALSE</code>.</p>
1042
- * </li>
1043
- * </ul>
1044
- */
1045
- CopyStepDetails?: CopyStepDetails;
1046
- /**
1047
- * <p>Details for a step that invokes a lambda function.</p>
1048
- * <p>
1049
- * Consists of the lambda function name, target, and timeout (in seconds).
1050
- * </p>
1051
- */
1052
- CustomStepDetails?: CustomStepDetails;
1053
- /**
1054
- * <p>You need to specify the name of the file to be deleted.</p>
1055
- */
1056
- DeleteStepDetails?: DeleteStepDetails;
1057
- /**
1058
- * <p>Details for a step that creates one or more tags.</p>
1059
- * <p>You specify one or more tags: each tag contains a key/value pair.</p>
1060
- */
1061
- TagStepDetails?: TagStepDetails;
1062
- }
1063
- export declare namespace WorkflowStep {
1064
- /**
1065
- * @internal
1066
- */
1067
- const filterSensitiveLog: (obj: WorkflowStep) => any;
1068
- }
1069
- export interface CreateWorkflowRequest {
1070
- /**
1071
- * <p>A textual description for the workflow.</p>
1072
- */
1073
- Description?: string;
1074
- /**
1075
- * <p>Specifies the details for the steps that are in the specified workflow.</p>
1076
- * <p>
1077
- * The <code>TYPE</code> specifies which of the following actions is being taken for this step.
1078
- * </p>
1079
- * <ul>
1080
- * <li>
1081
- * <p>
1082
- * <i>Copy</i>: copy the file to another location</p>
1083
- * </li>
1084
- * <li>
1085
- * <p>
1086
- * <i>Custom</i>: custom step with a lambda target</p>
1087
- * </li>
1088
- * <li>
1089
- * <p>
1090
- * <i>Delete</i>: delete the file</p>
1091
- * </li>
1092
- * <li>
1093
- * <p>
1094
- * <i>Tag</i>: add a tag to the file</p>
1095
- * </li>
1096
- * </ul>
1097
- * <p>
1098
- * For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path.
1099
- * </p>
1100
- */
1101
- Steps: WorkflowStep[] | undefined;
1102
- /**
1103
- * <p>Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.</p>
1104
- */
1105
- OnExceptionSteps?: WorkflowStep[];
1106
- /**
1107
- * <p>Key-value pairs that can be used to group and search for workflows. Tags are metadata attached
1108
- * to workflows for any purpose.</p>
1109
- */
1110
- Tags?: Tag[];
1111
- }
1112
- export declare namespace CreateWorkflowRequest {
1113
- /**
1114
- * @internal
1115
- */
1116
- const filterSensitiveLog: (obj: CreateWorkflowRequest) => any;
1117
- }
1118
- export interface CreateWorkflowResponse {
1119
- /**
1120
- * <p>A unique identifier for the workflow.</p>
1121
- */
1122
- WorkflowId: string | undefined;
1123
- }
1124
- export declare namespace CreateWorkflowResponse {
1125
- /**
1126
- * @internal
1127
- */
1128
- const filterSensitiveLog: (obj: CreateWorkflowResponse) => any;
1129
- }
1130
- export declare enum CustomStepStatus {
1131
- FAILURE = "FAILURE",
1132
- SUCCESS = "SUCCESS"
1133
- }
1134
- export interface DeleteAccessRequest {
1135
- /**
1136
- * <p>A system-assigned unique identifier for a server that has this user assigned.</p>
1137
- */
1138
- ServerId: string | undefined;
1139
- /**
1140
- * <p>A unique identifier that is required to identify specific groups within your directory.
1141
- * The users of the group that you associate have access to your Amazon S3 or Amazon EFS
1142
- * resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,
1143
- * you can view the SID values by running the following command using Windows PowerShell.</p>
1144
- *
1145
- * <p>
1146
- * <code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code>
1147
- * </p>
1148
- *
1149
- * <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
1150
- *
1151
- * <p>The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.
1152
- * You can also include underscores or any of the following characters: =,.@:/-</p>
1153
- */
1154
- ExternalId: string | undefined;
1155
- }
1156
- export declare namespace DeleteAccessRequest {
1157
- /**
1158
- * @internal
1159
- */
1160
- const filterSensitiveLog: (obj: DeleteAccessRequest) => any;
1161
- }
1162
- export interface DeleteServerRequest {
1163
- /**
1164
- * <p>A unique system-assigned identifier for a server instance.</p>
1165
- */
1166
- ServerId: string | undefined;
1167
- }
1168
- export declare namespace DeleteServerRequest {
1169
- /**
1170
- * @internal
1171
- */
1172
- const filterSensitiveLog: (obj: DeleteServerRequest) => any;
1173
- }
1174
- export interface DeleteSshPublicKeyRequest {
1175
- /**
1176
- * <p>A system-assigned unique identifier for a file transfer protocol-enabled server instance
1177
- * that has the user assigned to it.</p>
1178
- */
1179
- ServerId: string | undefined;
1180
- /**
1181
- * <p>A unique identifier used to reference your user's specific SSH key.</p>
1182
- */
1183
- SshPublicKeyId: string | undefined;
1184
- /**
1185
- * <p>A unique string that identifies a user whose public key is being deleted.</p>
1186
- */
1187
- UserName: string | undefined;
1188
- }
1189
- export declare namespace DeleteSshPublicKeyRequest {
1190
- /**
1191
- * @internal
1192
- */
1193
- const filterSensitiveLog: (obj: DeleteSshPublicKeyRequest) => any;
1194
- }
1195
- export interface DeleteUserRequest {
1196
- /**
1197
- * <p>A system-assigned unique identifier for a server instance that has the user assigned to
1198
- * it.</p>
1199
- */
1200
- ServerId: string | undefined;
1201
- /**
1202
- * <p>A unique string that identifies a user that is being deleted from a server.</p>
1203
- */
1204
- UserName: string | undefined;
1205
- }
1206
- export declare namespace DeleteUserRequest {
1207
- /**
1208
- * @internal
1209
- */
1210
- const filterSensitiveLog: (obj: DeleteUserRequest) => any;
1211
- }
1212
- export interface DeleteWorkflowRequest {
1213
- /**
1214
- * <p>A unique identifier for the workflow.</p>
1215
- */
1216
- WorkflowId: string | undefined;
1217
- }
1218
- export declare namespace DeleteWorkflowRequest {
1219
- /**
1220
- * @internal
1221
- */
1222
- const filterSensitiveLog: (obj: DeleteWorkflowRequest) => any;
1223
- }
1224
- export interface DescribeAccessRequest {
1225
- /**
1226
- * <p>A system-assigned unique identifier for a server that has this access assigned.</p>
1227
- */
1228
- ServerId: string | undefined;
1229
- /**
1230
- * <p>A unique identifier that is required to identify specific groups within your directory.
1231
- * The users of the group that you associate have access to your Amazon S3 or Amazon EFS
1232
- * resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,
1233
- * you can view the SID values by running the following command using Windows PowerShell.</p>
1234
- *
1235
- * <p>
1236
- * <code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code>
1237
- * </p>
1238
- *
1239
- * <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
1240
- *
1241
- * <p>The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.
1242
- * You can also include underscores or any of the following characters: =,.@:/-</p>
1243
- */
1244
- ExternalId: string | undefined;
1245
- }
1246
- export declare namespace DescribeAccessRequest {
1247
- /**
1248
- * @internal
1249
- */
1250
- const filterSensitiveLog: (obj: DescribeAccessRequest) => any;
1251
- }
1252
- /**
1253
- * <p>Describes the properties of the access that was specified.</p>
1254
- */
1255
- export interface DescribedAccess {
1256
- /**
1257
- * <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
1258
- * <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
1259
- */
1260
- HomeDirectory?: string;
1261
- /**
1262
- * <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
1263
- * be visible to your user and how you want to make them visible. You must specify the
1264
- * <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
1265
- * is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you
1266
- * only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity
1267
- * and Access Management (IAM) role provides access to paths in <code>Target</code>. This value
1268
- * can only be set when <code>HomeDirectoryType</code> is set to
1269
- * <i>LOGICAL</i>.</p>
1270
- *
1271
- * <p>In most cases, you can use this value instead of the session policy to lock down the
1272
- * associated access to the designated home directory ("<code>chroot</code>"). To do this, you
1273
- * can set <code>Entry</code> to '/' and set <code>Target</code> to the
1274
- * <code>HomeDirectory</code> parameter value.</p>
1275
- */
1276
- HomeDirectoryMappings?: HomeDirectoryMapEntry[];
1277
- /**
1278
- * <p>The type of landing directory (folder) you want your users' home directory to be when they log into the server.
1279
- * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.
1280
- * If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon
1281
- * S3 or EFS paths visible to your users.</p>
1282
- */
1283
- HomeDirectoryType?: HomeDirectoryType | string;
1284
- /**
1285
- * <p>A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user
1286
- * access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>,
1287
- * <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>
1288
- */
1289
- Policy?: string;
1290
- /**
1291
- * <p>The full POSIX identity, including user ID (<code>Uid</code>), group ID
1292
- * (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
1293
- * your users' access to your Amazon EFS file systems. The POSIX permissions that are set on
1294
- * files and directories in your file system determine the level of access your users get when
1295
- * transferring files into and out of your Amazon EFS file systems.</p>
1296
- */
1297
- PosixProfile?: PosixProfile;
1298
- /**
1299
- * <p>Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS
1300
- * file system. The policies attached to this role determine the level of access that you want to provide your users when transferring
1301
- * files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the
1302
- * server to access your resources when servicing your users' transfer requests.</p>
1303
- */
1304
- Role?: string;
1305
- /**
1306
- * <p>A unique identifier that is required to identify specific groups within your directory.
1307
- * The users of the group that you associate have access to your Amazon S3 or Amazon EFS
1308
- * resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,
1309
- * you can view the SID values by running the following command using Windows PowerShell.</p>
1310
- *
1311
- * <p>
1312
- * <code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code>
1313
- * </p>
1314
- *
1315
- * <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
1316
- *
1317
- * <p>The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.
1318
- * You can also include underscores or any of the following characters: =,.@:/-</p>
1319
- */
1320
- ExternalId?: string;
1321
- }
1322
- export declare namespace DescribedAccess {
1323
- /**
1324
- * @internal
1325
- */
1326
- const filterSensitiveLog: (obj: DescribedAccess) => any;
1327
- }
1328
- export interface DescribeAccessResponse {
1329
- /**
1330
- * <p>A system-assigned unique identifier for a server that has this access assigned.</p>
1331
- */
1332
- ServerId: string | undefined;
1333
- /**
1334
- * <p>The external ID of the server that the access is attached to.</p>
1335
- */
1336
- Access: DescribedAccess | undefined;
1337
- }
1338
- export declare namespace DescribeAccessResponse {
1339
- /**
1340
- * @internal
1341
- */
1342
- const filterSensitiveLog: (obj: DescribeAccessResponse) => any;
1343
- }
1344
- /**
1345
- * <p>Specifies the details for the file location for the file being used in the workflow. Only applicable if you are using S3 storage.</p>
1346
- * <p>
1347
- * You need to provide the bucket and key.
1348
- * The key can represent either a path or a file.
1349
- * This is determined by whether or not you end the key value with the forward slash (/) character.
1350
- * If the final character is "/", then your file is copied to the folder, and its name does not change.
1351
- * If, rather, the final character is alphanumeric, your uploaded file is renamed to the path value. In this case, if a file with that name already exists, it is overwritten.
1352
- * </p>
1353
- * <p>For example, if your path is <code>shared-files/bob/</code>, your uploaded files are copied to the <code>shared-files/bob/</code>, folder.
1354
- * If your path is <code>shared-files/today</code>, each uploaded file is copied to the <code>shared-files</code> folder and named <code>today</code>:
1355
- * each upload overwrites the previous version of the <i>bob</i> file.</p>
1356
- */
1357
- export interface S3FileLocation {
1358
- /**
1359
- * <p>Specifies the S3 bucket that contains the file being used.</p>
1360
- */
1361
- Bucket?: string;
1362
- /**
1363
- * <p>The name assigned to the file when it was created in S3. You use the object key to retrieve the object.</p>
1364
- */
1365
- Key?: string;
1366
- /**
1367
- * <p>Specifies the file version.</p>
1368
- */
1369
- VersionId?: string;
1370
- /**
1371
- * <p>The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata.</p>
1372
- */
1373
- Etag?: string;
1374
- }
1375
- export declare namespace S3FileLocation {
1376
- /**
1377
- * @internal
1378
- */
1379
- const filterSensitiveLog: (obj: S3FileLocation) => any;
1380
- }
1381
- /**
1382
- * <p>Specifies the Amazon S3 or EFS file details to be used in the step.</p>
1383
- */
1384
- export interface FileLocation {
1385
- /**
1386
- * <p>Specifies the S3 details for the file being used, such as bucket, Etag, and so forth.</p>
1387
- */
1388
- S3FileLocation?: S3FileLocation;
1389
- /**
1390
- * <p>Specifies the Amazon EFS ID and the path for the file being used.</p>
1391
- */
1392
- EfsFileLocation?: EfsFileLocation;
1393
- }
1394
- export declare namespace FileLocation {
1395
- /**
1396
- * @internal
1397
- */
1398
- const filterSensitiveLog: (obj: FileLocation) => any;
1399
- }
1400
- /**
1401
- * <p>Consists of the logging role and the log group name.</p>
1402
- */
1403
- export interface LoggingConfiguration {
1404
- /**
1405
- * <p>Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn
1406
- * on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in
1407
- * your CloudWatch logs.</p>
1408
- */
1409
- LoggingRole?: string;
1410
- /**
1411
- * <p>The name of the CloudWatch logging group for the Amazon Web Services Transfer server to which this workflow belongs.</p>
1412
- */
1413
- LogGroupName?: string;
1414
- }
1415
- export declare namespace LoggingConfiguration {
1416
- /**
1417
- * @internal
1418
- */
1419
- const filterSensitiveLog: (obj: LoggingConfiguration) => any;
1420
- }
1421
- export declare enum ExecutionErrorType {
1422
- PERMISSION_DENIED = "PERMISSION_DENIED"
1423
- }
1424
- /**
1425
- * <p>Specifies the error message and type, for an error that occurs during the execution of the workflow.</p>
1426
- */
1427
- export interface ExecutionError {
1428
- /**
1429
- * <p>Specifies the error type: currently, the only valid value is <code>PERMISSION_DENIED</code>, which occurs
1430
- * if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.</p>
1431
- */
1432
- Type: ExecutionErrorType | string | undefined;
1433
- /**
1434
- * <p>Specifies the descriptive message that corresponds to the <code>ErrorType</code>.</p>
1435
- */
1436
- Message: string | undefined;
1437
- }
1438
- export declare namespace ExecutionError {
1439
- /**
1440
- * @internal
1441
- */
1442
- const filterSensitiveLog: (obj: ExecutionError) => any;
1443
- }
1444
- /**
1445
- * <p>Specifies the following details for the step: error (if any), outputs (if any), and the step type.</p>
1446
- */
1447
- export interface ExecutionStepResult {
1448
- /**
1449
- * <p>One of the available step types.</p>
1450
- * <ul>
1451
- * <li>
1452
- * <p>
1453
- * <i>Copy</i>: copy the file to another location</p>
1454
- * </li>
1455
- * <li>
1456
- * <p>
1457
- * <i>Custom</i>: custom step with a lambda target</p>
1458
- * </li>
1459
- * <li>
1460
- * <p>
1461
- * <i>Delete</i>: delete the file</p>
1462
- * </li>
1463
- * <li>
1464
- * <p>
1465
- * <i>Tag</i>: add a tag to the file</p>
1466
- * </li>
1467
- * </ul>
1468
- */
1469
- StepType?: WorkflowStepType | string;
1470
- /**
1471
- * <p>The values for the key/value pair applied as a tag to the file. Only applicable if the step type is <code>TAG</code>.</p>
1472
- */
1473
- Outputs?: string;
1474
- /**
1475
- * <p>Specifies the details for an error, if it occurred during execution of the specified workfow step.</p>
1476
- */
1477
- Error?: ExecutionError;
1478
- }
1479
- export declare namespace ExecutionStepResult {
1480
- /**
1481
- * @internal
1482
- */
1483
- const filterSensitiveLog: (obj: ExecutionStepResult) => any;
1484
- }
1485
- /**
1486
- * <p>Specifies the steps in the workflow, as well as the steps to execute in case of any errors during workflow execution.</p>
1487
- */
1488
- export interface ExecutionResults {
1489
- /**
1490
- * <p>Specifies the details for the steps that are in the specified workflow.</p>
1491
- */
1492
- Steps?: ExecutionStepResult[];
1493
- /**
1494
- * <p>Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.</p>
1495
- */
1496
- OnExceptionSteps?: ExecutionStepResult[];
1497
- }
1498
- export declare namespace ExecutionResults {
1499
- /**
1500
- * @internal
1501
- */
1502
- const filterSensitiveLog: (obj: ExecutionResults) => any;
1503
- }
1504
- /**
1505
- * <p>Specifies the user name, server ID, and session ID for a workflow.</p>
1506
- */
1507
- export interface UserDetails {
1508
- /**
1509
- * <p>A unique string that identifies a user account associated with a server.</p>
1510
- */
1511
- UserName: string | undefined;
1512
- /**
1513
- * <p>The system-assigned unique identifier for a Transfer server instance. </p>
1514
- */
1515
- ServerId: string | undefined;
1516
- /**
1517
- * <p>The system-assigned unique identifier for a session that corresponds to the workflow.</p>
1518
- */
1519
- SessionId?: string;
1520
- }
1521
- export declare namespace UserDetails {
1522
- /**
1523
- * @internal
1524
- */
1525
- const filterSensitiveLog: (obj: UserDetails) => any;
1526
- }
1527
- /**
1528
- * <p>A container object for the session details associated with a workflow.</p>
1529
- */
1530
- export interface ServiceMetadata {
1531
- /**
1532
- * <p>The Server ID (<code>ServerId</code>), Session ID (<code>SessionId</code>) and user (<code>UserName</code>) make up the <code>UserDetails</code>.</p>
1533
- */
1534
- UserDetails: UserDetails | undefined;
1535
- }
1536
- export declare namespace ServiceMetadata {
1537
- /**
1538
- * @internal
1539
- */
1540
- const filterSensitiveLog: (obj: ServiceMetadata) => any;
1541
- }
1542
- export declare enum ExecutionStatus {
1543
- COMPLETED = "COMPLETED",
1544
- EXCEPTION = "EXCEPTION",
1545
- HANDLING_EXCEPTION = "HANDLING_EXCEPTION",
1546
- IN_PROGRESS = "IN_PROGRESS"
1547
- }
1548
- /**
1549
- * <p>The details for an execution object.</p>
1550
- */
1551
- export interface DescribedExecution {
1552
- /**
1553
- * <p>A unique identifier for the execution of a workflow.</p>
1554
- */
1555
- ExecutionId?: string;
1556
- /**
1557
- * <p>A structure that describes the Amazon S3 or EFS file location.
1558
- * This is the file location when the execution begins: if the file is being copied,
1559
- * this is the initial (as opposed to destination) file location.</p>
1560
- */
1561
- InitialFileLocation?: FileLocation;
1562
- /**
1563
- * <p>A container object for the session details associated with a workflow.</p>
1564
- */
1565
- ServiceMetadata?: ServiceMetadata;
1566
- /**
1567
- * <p>The IAM role associated with the execution.</p>
1568
- */
1569
- ExecutionRole?: string;
1570
- /**
1571
- * <p>The IAM logging role associated with the execution.</p>
1572
- */
1573
- LoggingConfiguration?: LoggingConfiguration;
1574
- /**
1575
- * <p>The full POSIX identity, including user ID (<code>Uid</code>), group ID
1576
- * (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
1577
- * your users' access to your Amazon EFS file systems. The POSIX permissions that are set on
1578
- * files and directories in your file system determine the level of access your users get when
1579
- * transferring files into and out of your Amazon EFS file systems.</p>
1580
- */
1581
- PosixProfile?: PosixProfile;
1582
- /**
1583
- * <p>The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.
1584
- * </p>
1585
- */
1586
- Status?: ExecutionStatus | string;
1587
- /**
1588
- * <p>A structure that describes the execution results. This includes a list of the steps along with the details of each step,
1589
- * error type and message (if any), and the <code>OnExceptionSteps</code> structure.</p>
1590
- */
1591
- Results?: ExecutionResults;
1592
- }
1593
- export declare namespace DescribedExecution {
1594
- /**
1595
- * @internal
1596
- */
1597
- const filterSensitiveLog: (obj: DescribedExecution) => any;
1598
- }
1599
- /**
1600
- * <p>Describes the properties of a security policy that was specified. For more information
1601
- * about security policies, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html">Working with security
1602
- * policies</a>.</p>
1603
- */
1604
- export interface DescribedSecurityPolicy {
1605
- /**
1606
- * <p>Specifies whether this policy enables Federal Information Processing Standards
1607
- * (FIPS).</p>
1608
- */
1609
- Fips?: boolean;
1610
- /**
1611
- * <p>Specifies the name of the security policy that is attached to the server.</p>
1612
- */
1613
- SecurityPolicyName: string | undefined;
1614
- /**
1615
- * <p>Specifies the enabled Secure Shell (SSH) cipher encryption algorithms in the security
1616
- * policy that is attached to the server.</p>
1617
- */
1618
- SshCiphers?: string[];
1619
- /**
1620
- * <p>Specifies the enabled SSH key exchange (KEX) encryption algorithms in the security policy
1621
- * that is attached to the server.</p>
1622
- */
1623
- SshKexs?: string[];
1624
- /**
1625
- * <p>Specifies the enabled SSH message authentication code (MAC) encryption algorithms in the
1626
- * security policy that is attached to the server.</p>
1627
- */
1628
- SshMacs?: string[];
1629
- /**
1630
- * <p>Specifies the enabled Transport Layer Security (TLS) cipher encryption algorithms in the
1631
- * security policy that is attached to the server.</p>
1632
- */
1633
- TlsCiphers?: string[];
1634
- }
1635
- export declare namespace DescribedSecurityPolicy {
1636
- /**
1637
- * @internal
1638
- */
1639
- const filterSensitiveLog: (obj: DescribedSecurityPolicy) => any;
1640
- }
1641
- /**
1642
- * <p>
1643
- * The protocol settings that are configured for your server.
1644
- * </p>
1645
- * <note>
1646
- * <p>
1647
- * This type is only valid in the <code>UpdateServer</code> API.
1648
- * </p>
1649
- * </note>
1650
- */
1651
- export interface ProtocolDetails {
1652
- /**
1653
- * <p>
1654
- * Indicates passive mode, for FTP and FTPS protocols.
1655
- * Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
1656
- * For example:
1657
- * </p>
1658
- * <p>
1659
- * <code>
1660
- * aws transfer update-server --protocol-details PassiveIp=<i>0.0.0.0</i>
1661
- * </code>
1662
- * </p>
1663
- * <p>Replace <code>
1664
- * <i>0.0.0.0</i>
1665
- * </code> in the example above with the actual IP address you want to use.</p>
1666
- * <note>
1667
- * <p>
1668
- * If you change the <code>PassiveIp</code> value, you must stop and then restart your Transfer server for the change to take effect. For details on using Passive IP (PASV) in a NAT environment, see <a href="http://aws.amazon.com/blogs/storage/configuring-your-ftps-server-behind-a-firewall-or-nat-with-aws-transfer-family/">Configuring your FTPS server behind a firewall or NAT with Amazon Web Services Transfer Family</a>.
1669
- * </p>
1670
- * </note>
1671
- */
1672
- PassiveIp?: string;
1673
- }
1674
- export declare namespace ProtocolDetails {
1675
- /**
1676
- * @internal
1677
- */
1678
- const filterSensitiveLog: (obj: ProtocolDetails) => any;
1679
- }
1680
- export declare enum State {
1681
- OFFLINE = "OFFLINE",
1682
- ONLINE = "ONLINE",
1683
- STARTING = "STARTING",
1684
- START_FAILED = "START_FAILED",
1685
- STOPPING = "STOPPING",
1686
- STOP_FAILED = "STOP_FAILED"
1687
- }
1688
- /**
1689
- * <p>Describes the properties of a file transfer protocol-enabled server that was
1690
- * specified.</p>
1691
- */
1692
- export interface DescribedServer {
1693
- /**
1694
- * <p>Specifies the unique Amazon Resource Name (ARN) of the server.</p>
1695
- */
1696
- Arn: string | undefined;
1697
- /**
1698
- * <p>Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when
1699
- * <code>Protocols</code> is set to <code>FTPS</code>.</p>
1700
- */
1701
- Certificate?: string;
1702
- /**
1703
- * <p>
1704
- * The protocol settings that are configured for your server.
1705
- * </p>
1706
- * <p>
1707
- * Use the <code>PassiveIp</code> parameter to indicate passive mode.
1708
- * Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
1709
- * </p>
1710
- */
1711
- ProtocolDetails?: ProtocolDetails;
1712
- /**
1713
- * <p>Specifies the domain of the storage system that is used for file transfers.</p>
1714
- */
1715
- Domain?: Domain | string;
1716
- /**
1717
- * <p>The virtual private cloud (VPC) endpoint settings that are configured for your server.
1718
- * When you host your endpoint within your VPC, you can make it accessible only to resources
1719
- * within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over
1720
- * the internet. Your VPC's default security groups are automatically assigned to your
1721
- * endpoint.</p>
1722
- */
1723
- EndpointDetails?: EndpointDetails;
1724
- /**
1725
- * <p>Defines the type of endpoint that your server is connected to. If your server is connected
1726
- * to a VPC endpoint, your server isn't accessible over the public internet.</p>
1727
- */
1728
- EndpointType?: EndpointType | string;
1729
- /**
1730
- * <p>Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value
1731
- * is equivalent to the output of the <code>ssh-keygen -l -f my-new-server-key</code>
1732
- * command.</p>
1733
- */
1734
- HostKeyFingerprint?: string;
1735
- /**
1736
- * <p>Specifies information to call a customer-supplied authentication API. This field is not
1737
- * populated when the <code>IdentityProviderType</code> of a server is
1738
- * <code>AWS_DIRECTORY_SERVICE</code> or <code>SERVICE_MANAGED</code>.</p>
1739
- */
1740
- IdentityProviderDetails?: IdentityProviderDetails;
1741
- /**
1742
- * <p>Specifies the mode of authentication for a server. The default value is
1743
- * <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within
1744
- * the Amazon Web Services Transfer Family service.</p>
1745
- * <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to
1746
- * Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your
1747
- * on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to
1748
- * provide a Directory ID using the <code>IdentityProviderDetails</code> parameter.</p>
1749
- * <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The
1750
- * <code>API_GATEWAY</code> setting requires you to provide an API Gateway endpoint URL to call
1751
- * for authentication using the <code>IdentityProviderDetails</code> parameter.</p>
1752
- */
1753
- IdentityProviderType?: IdentityProviderType | string;
1754
- /**
1755
- * <p>Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn
1756
- * on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in
1757
- * your CloudWatch logs.</p>
1758
- */
1759
- LoggingRole?: string;
1760
- /**
1761
- * <p>Specifies the file transfer protocol or protocols over which your file transfer protocol
1762
- * client can connect to your server's endpoint. The available protocols are:</p>
1763
- *
1764
- * <ul>
1765
- * <li>
1766
- * <p>
1767
- * <code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over
1768
- * SSH</p>
1769
- * </li>
1770
- * <li>
1771
- * <p>
1772
- * <code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS
1773
- * encryption</p>
1774
- * </li>
1775
- * <li>
1776
- * <p>
1777
- * <code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p>
1778
- * </li>
1779
- * </ul>
1780
- */
1781
- Protocols?: (Protocol | string)[];
1782
- /**
1783
- * <p>Specifies the name of the security policy that is attached to the server.</p>
1784
- */
1785
- SecurityPolicyName?: string;
1786
- /**
1787
- * <p>Specifies the unique system-assigned identifier for a server that you instantiate.</p>
1788
- */
1789
- ServerId?: string;
1790
- /**
1791
- * <p>Specifies the condition of a server for the server that was described. A value of
1792
- * <code>ONLINE</code> indicates that the server can accept jobs and transfer files. A
1793
- * <code>State</code> value of <code>OFFLINE</code> means that the server cannot perform file
1794
- * transfer operations.</p>
1795
- *
1796
- * <p>The states of <code>STARTING</code> and <code>STOPPING</code> indicate that the server is
1797
- * in an intermediate state, either not fully able to respond, or not fully offline. The values
1798
- * of <code>START_FAILED</code> or <code>STOP_FAILED</code> can indicate an error
1799
- * condition.</p>
1800
- */
1801
- State?: State | string;
1802
- /**
1803
- * <p>Specifies the key-value pairs that you can use to search for and group servers that were
1804
- * assigned to the server that was described.</p>
1805
- */
1806
- Tags?: Tag[];
1807
- /**
1808
- * <p>Specifies the number of users that are assigned to a server you specified with the
1809
- * <code>ServerId</code>.</p>
1810
- */
1811
- UserCount?: number;
1812
- /**
1813
- * <p>Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.</p>
1814
- */
1815
- WorkflowDetails?: WorkflowDetails;
1816
- }
1817
- export declare namespace DescribedServer {
1818
- /**
1819
- * @internal
1820
- */
1821
- const filterSensitiveLog: (obj: DescribedServer) => any;
1822
- }
1823
- /**
1824
- * <p>Provides information about the public Secure Shell (SSH) key that is associated with a
1825
- * user account for the specific file transfer protocol-enabled server (as identified by
1826
- * <code>ServerId</code>). The information returned includes the date the key was imported, the
1827
- * public key contents, and the public key ID. A user can store more than one SSH public key
1828
- * associated with their user name on a specific server.</p>
1829
- */
1830
- export interface SshPublicKey {
1831
- /**
1832
- * <p>Specifies the date that the public key was added to the user account.</p>
1833
- */
1834
- DateImported: Date | undefined;
1835
- /**
1836
- * <p>Specifies the content of the SSH public key as specified by the
1837
- * <code>PublicKeyId</code>.</p>
1838
- */
1839
- SshPublicKeyBody: string | undefined;
1840
- /**
1841
- * <p>Specifies the <code>SshPublicKeyId</code> parameter contains the identifier of the public
1842
- * key.</p>
1843
- */
1844
- SshPublicKeyId: string | undefined;
1845
- }
1846
- export declare namespace SshPublicKey {
1847
- /**
1848
- * @internal
1849
- */
1850
- const filterSensitiveLog: (obj: SshPublicKey) => any;
1851
- }
1852
- /**
1853
- * <p>Describes the properties of a user that was specified.</p>
1854
- */
1855
- export interface DescribedUser {
1856
- /**
1857
- * <p>Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be
1858
- * described.</p>
1859
- */
1860
- Arn: string | undefined;
1861
- /**
1862
- * <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
1863
- * <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
1864
- */
1865
- HomeDirectory?: string;
1866
- /**
1867
- * <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
1868
- * be visible to your user and how you want to make them visible. You must specify the
1869
- * <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
1870
- * is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you
1871
- * only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity
1872
- * and Access Management (IAM) role provides access to paths in <code>Target</code>. This value
1873
- * can only be set when <code>HomeDirectoryType</code> is set to
1874
- * <i>LOGICAL</i>.</p>
1875
- *
1876
- * <p>In most cases, you can use this value instead of the session policy to lock your user
1877
- * down to the designated home directory ("<code>chroot</code>"). To do this, you can set
1878
- * <code>Entry</code> to '/' and set <code>Target</code> to the HomeDirectory
1879
- * parameter value.</p>
1880
- */
1881
- HomeDirectoryMappings?: HomeDirectoryMapEntry[];
1882
- /**
1883
- * <p>The type of landing directory (folder) you want your users' home directory to be when they log into the server.
1884
- * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.
1885
- * If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon
1886
- * S3 or EFS paths visible to your users.</p>
1887
- */
1888
- HomeDirectoryType?: HomeDirectoryType | string;
1889
- /**
1890
- * <p>A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user
1891
- * access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>,
1892
- * <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>
1893
- */
1894
- Policy?: string;
1895
- /**
1896
- * <p>Specifies the full POSIX identity, including user ID (<code>Uid</code>), group ID
1897
- * (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
1898
- * your users' access to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX
1899
- * permissions that are set on files and directories in your file system determine the level of
1900
- * access your users get when transferring files into and out of your Amazon EFS file
1901
- * systems.</p>
1902
- */
1903
- PosixProfile?: PosixProfile;
1904
- /**
1905
- * <p>Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS
1906
- * file system. The policies attached to this role determine the level of access that you want to provide your users when transferring
1907
- * files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the
1908
- * server to access your resources when servicing your users' transfer requests.</p>
1909
- */
1910
- Role?: string;
1911
- /**
1912
- * <p>Specifies the public key portion of the Secure Shell (SSH) keys stored for the described
1913
- * user.</p>
1914
- */
1915
- SshPublicKeys?: SshPublicKey[];
1916
- /**
1917
- * <p>Specifies the key-value pairs for the user requested. Tag can be used to search for and
1918
- * group users for a variety of purposes.</p>
1919
- */
1920
- Tags?: Tag[];
1921
- /**
1922
- * <p>Specifies the name of the user that was requested to be described. User names are used for
1923
- * authentication purposes. This is the string that will be used by your user when they log in to
1924
- * your server.</p>
1925
- */
1926
- UserName?: string;
1927
- }
1928
- export declare namespace DescribedUser {
1929
- /**
1930
- * @internal
1931
- */
1932
- const filterSensitiveLog: (obj: DescribedUser) => any;
1933
- }
1934
- /**
1935
- * <p>Describes the properties of the specified workflow</p>
1936
- */
1937
- export interface DescribedWorkflow {
1938
- /**
1939
- * <p>Specifies the unique Amazon Resource Name (ARN) for the workflow.</p>
1940
- */
1941
- Arn: string | undefined;
1942
- /**
1943
- * <p>Specifies the text description for the workflow.</p>
1944
- */
1945
- Description?: string;
1946
- /**
1947
- * <p>Specifies the details for the steps that are in the specified workflow.</p>
1948
- */
1949
- Steps?: WorkflowStep[];
1950
- /**
1951
- * <p>Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.</p>
1952
- */
1953
- OnExceptionSteps?: WorkflowStep[];
1954
- /**
1955
- * <p>A unique identifier for the workflow.</p>
1956
- */
1957
- WorkflowId?: string;
1958
- /**
1959
- * <p>Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.</p>
1960
- */
1961
- Tags?: Tag[];
1962
- }
1963
- export declare namespace DescribedWorkflow {
1964
- /**
1965
- * @internal
1966
- */
1967
- const filterSensitiveLog: (obj: DescribedWorkflow) => any;
1968
- }
1969
- export interface DescribeExecutionRequest {
1970
- /**
1971
- * <p>A unique identifier for the execution of a workflow.</p>
1972
- */
1973
- ExecutionId: string | undefined;
1974
- /**
1975
- * <p>A unique identifier for the workflow.</p>
1976
- */
1977
- WorkflowId: string | undefined;
1978
- }
1979
- export declare namespace DescribeExecutionRequest {
1980
- /**
1981
- * @internal
1982
- */
1983
- const filterSensitiveLog: (obj: DescribeExecutionRequest) => any;
1984
- }
1985
- export interface DescribeExecutionResponse {
1986
- /**
1987
- * <p>A unique identifier for the workflow.</p>
1988
- */
1989
- WorkflowId: string | undefined;
1990
- /**
1991
- * <p>The structure that contains the details of the workflow' execution.</p>
1992
- */
1993
- Execution: DescribedExecution | undefined;
1994
- }
1995
- export declare namespace DescribeExecutionResponse {
1996
- /**
1997
- * @internal
1998
- */
1999
- const filterSensitiveLog: (obj: DescribeExecutionResponse) => any;
2000
- }
2001
- export interface DescribeSecurityPolicyRequest {
2002
- /**
2003
- * <p>Specifies the name of the security policy that is attached to the server.</p>
2004
- */
2005
- SecurityPolicyName: string | undefined;
2006
- }
2007
- export declare namespace DescribeSecurityPolicyRequest {
2008
- /**
2009
- * @internal
2010
- */
2011
- const filterSensitiveLog: (obj: DescribeSecurityPolicyRequest) => any;
2012
- }
2013
- export interface DescribeSecurityPolicyResponse {
2014
- /**
2015
- * <p>An array containing the properties of the security policy.</p>
2016
- */
2017
- SecurityPolicy: DescribedSecurityPolicy | undefined;
2018
- }
2019
- export declare namespace DescribeSecurityPolicyResponse {
2020
- /**
2021
- * @internal
2022
- */
2023
- const filterSensitiveLog: (obj: DescribeSecurityPolicyResponse) => any;
2024
- }
2025
- export interface DescribeServerRequest {
2026
- /**
2027
- * <p>A system-assigned unique identifier for a server.</p>
2028
- */
2029
- ServerId: string | undefined;
2030
- }
2031
- export declare namespace DescribeServerRequest {
2032
- /**
2033
- * @internal
2034
- */
2035
- const filterSensitiveLog: (obj: DescribeServerRequest) => any;
2036
- }
2037
- export interface DescribeServerResponse {
2038
- /**
2039
- * <p>An array containing the properties of a server with the <code>ServerID</code> you
2040
- * specified.</p>
2041
- */
2042
- Server: DescribedServer | undefined;
2043
- }
2044
- export declare namespace DescribeServerResponse {
2045
- /**
2046
- * @internal
2047
- */
2048
- const filterSensitiveLog: (obj: DescribeServerResponse) => any;
2049
- }
2050
- export interface DescribeUserRequest {
2051
- /**
2052
- * <p>A system-assigned unique identifier for a server that has this user assigned.</p>
2053
- */
2054
- ServerId: string | undefined;
2055
- /**
2056
- * <p>The name of the user assigned to one or more servers. User names are part of the sign-in
2057
- * credentials to use the Amazon Web Services Transfer Family service and perform file transfer tasks.</p>
2058
- */
2059
- UserName: string | undefined;
2060
- }
2061
- export declare namespace DescribeUserRequest {
2062
- /**
2063
- * @internal
2064
- */
2065
- const filterSensitiveLog: (obj: DescribeUserRequest) => any;
2066
- }
2067
- export interface DescribeUserResponse {
2068
- /**
2069
- * <p>A system-assigned unique identifier for a server that has this user assigned.</p>
2070
- */
2071
- ServerId: string | undefined;
2072
- /**
2073
- * <p>An array containing the properties of the user account for the <code>ServerID</code> value
2074
- * that you specified.</p>
2075
- */
2076
- User: DescribedUser | undefined;
2077
- }
2078
- export declare namespace DescribeUserResponse {
2079
- /**
2080
- * @internal
2081
- */
2082
- const filterSensitiveLog: (obj: DescribeUserResponse) => any;
2083
- }
2084
- export interface DescribeWorkflowRequest {
2085
- /**
2086
- * <p>A unique identifier for the workflow.</p>
2087
- */
2088
- WorkflowId: string | undefined;
2089
- }
2090
- export declare namespace DescribeWorkflowRequest {
2091
- /**
2092
- * @internal
2093
- */
2094
- const filterSensitiveLog: (obj: DescribeWorkflowRequest) => any;
2095
- }
2096
- export interface DescribeWorkflowResponse {
2097
- /**
2098
- * <p>The structure that contains the details of the workflow.</p>
2099
- */
2100
- Workflow: DescribedWorkflow | undefined;
2101
- }
2102
- export declare namespace DescribeWorkflowResponse {
2103
- /**
2104
- * @internal
2105
- */
2106
- const filterSensitiveLog: (obj: DescribeWorkflowResponse) => any;
2107
- }
2108
- export interface ImportSshPublicKeyRequest {
2109
- /**
2110
- * <p>A system-assigned unique identifier for a server.</p>
2111
- */
2112
- ServerId: string | undefined;
2113
- /**
2114
- * <p>The public key portion of an SSH key pair.</p>
2115
- */
2116
- SshPublicKeyBody: string | undefined;
2117
- /**
2118
- * <p>The name of the user account that is assigned to one or more servers.</p>
2119
- */
2120
- UserName: string | undefined;
2121
- }
2122
- export declare namespace ImportSshPublicKeyRequest {
2123
- /**
2124
- * @internal
2125
- */
2126
- const filterSensitiveLog: (obj: ImportSshPublicKeyRequest) => any;
2127
- }
2128
- /**
2129
- * <p>Identifies the user, the server they belong to, and the identifier of the SSH public key
2130
- * associated with that user. A user can have more than one key on each server that they are
2131
- * associated with.</p>
2132
- */
2133
- export interface ImportSshPublicKeyResponse {
2134
- /**
2135
- * <p>A system-assigned unique identifier for a server.</p>
2136
- */
2137
- ServerId: string | undefined;
2138
- /**
2139
- * <p>The name given to a public key by the system that was imported.</p>
2140
- */
2141
- SshPublicKeyId: string | undefined;
2142
- /**
2143
- * <p>A user name assigned to the <code>ServerID</code> value that you specified.</p>
2144
- */
2145
- UserName: string | undefined;
2146
- }
2147
- export declare namespace ImportSshPublicKeyResponse {
2148
- /**
2149
- * @internal
2150
- */
2151
- const filterSensitiveLog: (obj: ImportSshPublicKeyResponse) => any;
2152
- }
2153
- /**
2154
- * <p>The <code>NextToken</code> parameter that was passed is invalid.</p>
2155
- */
2156
- export interface InvalidNextTokenException extends __SmithyException, $MetadataBearer {
2157
- name: "InvalidNextTokenException";
2158
- $fault: "client";
2159
- Message: string | undefined;
2160
- }
2161
- export declare namespace InvalidNextTokenException {
2162
- /**
2163
- * @internal
2164
- */
2165
- const filterSensitiveLog: (obj: InvalidNextTokenException) => any;
2166
- }
2167
- export interface ListAccessesRequest {
2168
- /**
2169
- * <p>Specifies the maximum number of access SIDs to return.</p>
2170
- */
2171
- MaxResults?: number;
2172
- /**
2173
- * <p>When you can get additional results from the <code>ListAccesses</code> call, a
2174
- * <code>NextToken</code> parameter is returned in the output. You can then pass in a
2175
- * subsequent command to the <code>NextToken</code> parameter to continue listing additional
2176
- * accesses.</p>
2177
- */
2178
- NextToken?: string;
2179
- /**
2180
- * <p>A system-assigned unique identifier for a server that has users assigned to it.</p>
2181
- */
2182
- ServerId: string | undefined;
2183
- }
2184
- export declare namespace ListAccessesRequest {
2185
- /**
2186
- * @internal
2187
- */
2188
- const filterSensitiveLog: (obj: ListAccessesRequest) => any;
2189
- }
2190
- /**
2191
- * <p>Lists the properties for one or more specified associated accesses.</p>
2192
- */
2193
- export interface ListedAccess {
2194
- /**
2195
- * <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
2196
- * <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
2197
- */
2198
- HomeDirectory?: string;
2199
- /**
2200
- * <p>The type of landing directory (folder) you want your users' home directory to be when they log into the server.
2201
- * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.
2202
- * If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon
2203
- * S3 or EFS paths visible to your users.</p>
2204
- */
2205
- HomeDirectoryType?: HomeDirectoryType | string;
2206
- /**
2207
- * <p>Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS
2208
- * file system. The policies attached to this role determine the level of access that you want to provide your users when transferring
2209
- * files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the
2210
- * server to access your resources when servicing your users' transfer requests.</p>
2211
- */
2212
- Role?: string;
2213
- /**
2214
- * <p>A unique identifier that is required to identify specific groups within your directory.
2215
- * The users of the group that you associate have access to your Amazon S3 or Amazon EFS
2216
- * resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,
2217
- * you can view the SID values by running the following command using Windows PowerShell.</p>
2218
- *
2219
- * <p>
2220
- * <code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code>
2221
- * </p>
2222
- *
2223
- * <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
2224
- *
2225
- * <p>The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.
2226
- * You can also include underscores or any of the following characters: =,.@:/-</p>
2227
- */
2228
- ExternalId?: string;
2229
- }
2230
- export declare namespace ListedAccess {
2231
- /**
2232
- * @internal
2233
- */
2234
- const filterSensitiveLog: (obj: ListedAccess) => any;
2235
- }
2236
- export interface ListAccessesResponse {
2237
- /**
2238
- * <p>When you can get additional results from the <code>ListAccesses</code> call, a
2239
- * <code>NextToken</code> parameter is returned in the output. You can then pass in a
2240
- * subsequent command to the <code>NextToken</code> parameter to continue listing additional
2241
- * accesses.</p>
2242
- */
2243
- NextToken?: string;
2244
- /**
2245
- * <p>A system-assigned unique identifier for a server that has users assigned to it.</p>
2246
- */
2247
- ServerId: string | undefined;
2248
- /**
2249
- * <p>Returns the accesses and their properties for the <code>ServerId</code> value that you
2250
- * specify.</p>
2251
- */
2252
- Accesses: ListedAccess[] | undefined;
2253
- }
2254
- export declare namespace ListAccessesResponse {
2255
- /**
2256
- * @internal
2257
- */
2258
- const filterSensitiveLog: (obj: ListAccessesResponse) => any;
2259
- }
2260
- /**
2261
- * <p>Returns properties of the execution that is specified.</p>
2262
- */
2263
- export interface ListedExecution {
2264
- /**
2265
- * <p>A unique identifier for the execution of a workflow.</p>
2266
- */
2267
- ExecutionId?: string;
2268
- /**
2269
- * <p>A structure that describes the Amazon S3 or EFS file location.
2270
- * This is the file location when the execution begins: if the file is being copied,
2271
- * this is the initial (as opposed to destination) file location.</p>
2272
- */
2273
- InitialFileLocation?: FileLocation;
2274
- /**
2275
- * <p>A container object for the session details associated with a workflow.</p>
2276
- */
2277
- ServiceMetadata?: ServiceMetadata;
2278
- /**
2279
- * <p>The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.</p>
2280
- */
2281
- Status?: ExecutionStatus | string;
2282
- }
2283
- export declare namespace ListedExecution {
2284
- /**
2285
- * @internal
2286
- */
2287
- const filterSensitiveLog: (obj: ListedExecution) => any;
2288
- }
2289
- /**
2290
- * <p>Returns properties of a file transfer protocol-enabled server that was specified.</p>
2291
- */
2292
- export interface ListedServer {
2293
- /**
2294
- * <p>Specifies the unique Amazon Resource Name (ARN) for a server to be listed.</p>
2295
- */
2296
- Arn: string | undefined;
2297
- /**
2298
- * <p>Specifies the domain of the storage system that is used for file transfers.</p>
2299
- */
2300
- Domain?: Domain | string;
2301
- /**
2302
- * <p>Specifies the mode of authentication for a server. The default value is
2303
- * <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within
2304
- * the Amazon Web Services Transfer Family service.</p>
2305
- * <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to
2306
- * Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your
2307
- * on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to
2308
- * provide a Directory ID using the <code>IdentityProviderDetails</code> parameter.</p>
2309
- * <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The
2310
- * <code>API_GATEWAY</code> setting requires you to provide an API Gateway endpoint URL to call
2311
- * for authentication using the <code>IdentityProviderDetails</code> parameter.</p>
2312
- */
2313
- IdentityProviderType?: IdentityProviderType | string;
2314
- /**
2315
- * <p>Specifies the type of VPC endpoint that your server is connected to. If your server is
2316
- * connected to a VPC endpoint, your server isn't accessible over the public internet.</p>
2317
- */
2318
- EndpointType?: EndpointType | string;
2319
- /**
2320
- * <p>Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn
2321
- * on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in
2322
- * your CloudWatch logs.</p>
2323
- */
2324
- LoggingRole?: string;
2325
- /**
2326
- * <p>Specifies the unique system assigned identifier for the servers that were listed.</p>
2327
- */
2328
- ServerId?: string;
2329
- /**
2330
- * <p>Specifies the condition of a server for the server that was described. A value of
2331
- * <code>ONLINE</code> indicates that the server can accept jobs and transfer files. A
2332
- * <code>State</code> value of <code>OFFLINE</code> means that the server cannot perform file
2333
- * transfer operations.</p>
2334
- *
2335
- * <p>The states of <code>STARTING</code> and <code>STOPPING</code> indicate that the server is
2336
- * in an intermediate state, either not fully able to respond, or not fully offline. The values
2337
- * of <code>START_FAILED</code> or <code>STOP_FAILED</code> can indicate an error
2338
- * condition.</p>
2339
- */
2340
- State?: State | string;
2341
- /**
2342
- * <p>Specifies the number of users that are assigned to a server you specified with the
2343
- * <code>ServerId</code>.</p>
2344
- */
2345
- UserCount?: number;
2346
- }
2347
- export declare namespace ListedServer {
2348
- /**
2349
- * @internal
2350
- */
2351
- const filterSensitiveLog: (obj: ListedServer) => any;
2352
- }
2353
- /**
2354
- * <p>Returns properties of the user that you specify.</p>
2355
- */
2356
- export interface ListedUser {
2357
- /**
2358
- * <p>Provides the unique Amazon Resource Name (ARN) for the user that you want to learn
2359
- * about.</p>
2360
- */
2361
- Arn: string | undefined;
2362
- /**
2363
- * <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
2364
- * <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
2365
- */
2366
- HomeDirectory?: string;
2367
- /**
2368
- * <p>The type of landing directory (folder) you want your users' home directory to be when they log into the server.
2369
- * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.
2370
- * If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon
2371
- * S3 or EFS paths visible to your users.</p>
2372
- */
2373
- HomeDirectoryType?: HomeDirectoryType | string;
2374
- /**
2375
- * <p>Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS
2376
- * file system. The policies attached to this role determine the level of access that you want to provide your users when transferring
2377
- * files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the
2378
- * server to access your resources when servicing your users' transfer requests.</p>
2379
- * <note>
2380
- *
2381
- * <p>The IAM role that controls your users' access to your Amazon S3 bucket for servers with <code>Domain=S3</code>, or your EFS file system for servers with <code>Domain=EFS</code>.
2382
- * </p>
2383
- * <p>The policies attached to this role determine the level of access you want to provide your users when
2384
- * transferring files into and out of your S3 buckets or EFS file systems.</p>
2385
- *
2386
- * </note>
2387
- */
2388
- Role?: string;
2389
- /**
2390
- * <p>Specifies the number of SSH public keys stored for the user you specified.</p>
2391
- */
2392
- SshPublicKeyCount?: number;
2393
- /**
2394
- * <p>Specifies the name of the user whose ARN was specified. User names are used for
2395
- * authentication purposes.</p>
2396
- */
2397
- UserName?: string;
2398
- }
2399
- export declare namespace ListedUser {
2400
- /**
2401
- * @internal
2402
- */
2403
- const filterSensitiveLog: (obj: ListedUser) => any;
2404
- }
2405
- /**
2406
- * <p>Contains the ID, text description, and Amazon Resource Name (ARN) for the workflow.</p>
2407
- */
2408
- export interface ListedWorkflow {
2409
- /**
2410
- * <p>A unique identifier for the workflow.</p>
2411
- */
2412
- WorkflowId?: string;
2413
- /**
2414
- * <p>Specifies the text description for the workflow.</p>
2415
- */
2416
- Description?: string;
2417
- /**
2418
- * <p>Specifies the unique Amazon Resource Name (ARN) for the workflow.</p>
2419
- */
2420
- Arn?: string;
2421
- }
2422
- export declare namespace ListedWorkflow {
2423
- /**
2424
- * @internal
2425
- */
2426
- const filterSensitiveLog: (obj: ListedWorkflow) => any;
2427
- }
2428
- export interface ListExecutionsRequest {
2429
- /**
2430
- * <p>Specifies the aximum number of executions to return.</p>
2431
- */
2432
- MaxResults?: number;
2433
- /**
2434
- * <p>
2435
- * <code>ListExecutions</code> returns the <code>NextToken</code> parameter in the output.
2436
- * You can then pass the <code>NextToken</code> parameter in a subsequent command to
2437
- * continue listing additional executions.</p>
2438
- * <p>
2439
- * This is useful for pagination, for instance.
2440
- * If you have 100 executions for a workflow, you might only want to list first 10. If so, callthe API by specifing the <code>max-results</code>:
2441
- * </p>
2442
- * <p>
2443
- * <code>aws transfer list-executions --max-results 10</code>
2444
- * </p>
2445
- * <p>
2446
- * This returns details for the first 10 executions, as well as the pointer (<code>NextToken</code>) to the eleventh execution.
2447
- * You can now call the API again, suppling the <code>NextToken</code> value you received:
2448
- * </p>
2449
- * <p>
2450
- * <code>aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult</code>
2451
- * </p>
2452
- * <p>
2453
- * This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details
2454
- * for all 100 executions have been returned.
2455
- * </p>
2456
- */
2457
- NextToken?: string;
2458
- /**
2459
- * <p>A unique identifier for the workflow.</p>
2460
- */
2461
- WorkflowId: string | undefined;
2462
- }
2463
- export declare namespace ListExecutionsRequest {
2464
- /**
2465
- * @internal
2466
- */
2467
- const filterSensitiveLog: (obj: ListExecutionsRequest) => any;
2468
- }
2469
- export interface ListExecutionsResponse {
2470
- /**
2471
- * <p>
2472
- * <code>ListExecutions</code> returns the <code>NextToken</code> parameter in the output.
2473
- * You can then pass the <code>NextToken</code> parameter in a subsequent command to
2474
- * continue listing additional executions.</p>
2475
- */
2476
- NextToken?: string;
2477
- /**
2478
- * <p>A unique identifier for the workflow.</p>
2479
- */
2480
- WorkflowId: string | undefined;
2481
- /**
2482
- * <p>Returns the details for each execution.</p>
2483
- * <ul>
2484
- * <li>
2485
- * <p>
2486
- * <b>NextToken</b>: returned from a call to several APIs,
2487
- * you can use pass it to a subsequent command to continue listing additional executions.</p>
2488
- * </li>
2489
- * <li>
2490
- * <p>
2491
- * <b>StartTime</b>: timestamp indicating when the execution began.</p>
2492
- * </li>
2493
- * <li>
2494
- * <p>
2495
- * <b>Executions</b>: details of the execution, including the execution ID, initial file location,
2496
- * and Service metadata.</p>
2497
- * </li>
2498
- * <li>
2499
- * <p>
2500
- * <b>Status</b>: one of the following values:
2501
- * <code>IN_PROGRESS</code>, <code>COMPLETED</code>, <code>EXCEPTION</code>, <code>HANDLING_EXEPTION</code>.
2502
- * </p>
2503
- * </li>
2504
- * </ul>
2505
- */
2506
- Executions: ListedExecution[] | undefined;
2507
- }
2508
- export declare namespace ListExecutionsResponse {
2509
- /**
2510
- * @internal
2511
- */
2512
- const filterSensitiveLog: (obj: ListExecutionsResponse) => any;
2513
- }
2514
- export interface ListSecurityPoliciesRequest {
2515
- /**
2516
- * <p>Specifies the number of security policies to return as a response to the
2517
- * <code>ListSecurityPolicies</code> query.</p>
2518
- */
2519
- MaxResults?: number;
2520
- /**
2521
- * <p>When additional results are obtained from the <code>ListSecurityPolicies</code> command, a
2522
- * <code>NextToken</code> parameter is returned in the output. You can then pass the
2523
- * <code>NextToken</code> parameter in a subsequent command to continue listing additional
2524
- * security policies.</p>
2525
- */
2526
- NextToken?: string;
2527
- }
2528
- export declare namespace ListSecurityPoliciesRequest {
2529
- /**
2530
- * @internal
2531
- */
2532
- const filterSensitiveLog: (obj: ListSecurityPoliciesRequest) => any;
2533
- }
2534
- export interface ListSecurityPoliciesResponse {
2535
- /**
2536
- * <p>When you can get additional results from the <code>ListSecurityPolicies</code> operation,
2537
- * a <code>NextToken</code> parameter is returned in the output. In a following command, you can
2538
- * pass in the <code>NextToken</code> parameter to continue listing security policies.</p>
2539
- */
2540
- NextToken?: string;
2541
- /**
2542
- * <p>An array of security policies that were listed.</p>
2543
- */
2544
- SecurityPolicyNames: string[] | undefined;
2545
- }
2546
- export declare namespace ListSecurityPoliciesResponse {
2547
- /**
2548
- * @internal
2549
- */
2550
- const filterSensitiveLog: (obj: ListSecurityPoliciesResponse) => any;
2551
- }
2552
- export interface ListServersRequest {
2553
- /**
2554
- * <p>Specifies the number of servers to return as a response to the <code>ListServers</code>
2555
- * query.</p>
2556
- */
2557
- MaxResults?: number;
2558
- /**
2559
- * <p>When additional results are obtained from the <code>ListServers</code> command, a
2560
- * <code>NextToken</code> parameter is returned in the output. You can then pass the
2561
- * <code>NextToken</code> parameter in a subsequent command to continue listing additional
2562
- * servers.</p>
2563
- */
2564
- NextToken?: string;
2565
- }
2566
- export declare namespace ListServersRequest {
2567
- /**
2568
- * @internal
2569
- */
2570
- const filterSensitiveLog: (obj: ListServersRequest) => any;
2571
- }
2572
- export interface ListServersResponse {
2573
- /**
2574
- * <p>When you can get additional results from the <code>ListServers</code> operation, a
2575
- * <code>NextToken</code> parameter is returned in the output. In a following command, you can
2576
- * pass in the <code>NextToken</code> parameter to continue listing additional servers.</p>
2577
- */
2578
- NextToken?: string;
2579
- /**
2580
- * <p>An array of servers that were listed.</p>
2581
- */
2582
- Servers: ListedServer[] | undefined;
2583
- }
2584
- export declare namespace ListServersResponse {
2585
- /**
2586
- * @internal
2587
- */
2588
- const filterSensitiveLog: (obj: ListServersResponse) => any;
2589
- }
2590
- export interface ListTagsForResourceRequest {
2591
- /**
2592
- * <p>Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an
2593
- * identifier for a specific Amazon Web Services resource, such as a server, user, or role.</p>
2594
- */
2595
- Arn: string | undefined;
2596
- /**
2597
- * <p>Specifies the number of tags to return as a response to the
2598
- * <code>ListTagsForResource</code> request.</p>
2599
- */
2600
- MaxResults?: number;
2601
- /**
2602
- * <p>When you request additional results from the <code>ListTagsForResource</code> operation, a
2603
- * <code>NextToken</code> parameter is returned in the input. You can then pass in a subsequent
2604
- * command to the <code>NextToken</code> parameter to continue listing additional tags.</p>
2605
- */
2606
- NextToken?: string;
2607
- }
2608
- export declare namespace ListTagsForResourceRequest {
2609
- /**
2610
- * @internal
2611
- */
2612
- const filterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
2613
- }
2614
- export interface ListTagsForResourceResponse {
2615
- /**
2616
- * <p>The ARN you specified to list the tags of.</p>
2617
- */
2618
- Arn?: string;
2619
- /**
2620
- * <p>When you can get additional results from the <code>ListTagsForResource</code> call, a
2621
- * <code>NextToken</code> parameter is returned in the output. You can then pass in a
2622
- * subsequent command to the <code>NextToken</code> parameter to continue listing additional
2623
- * tags.</p>
2624
- */
2625
- NextToken?: string;
2626
- /**
2627
- * <p>Key-value pairs that are assigned to a resource, usually for the purpose of grouping and
2628
- * searching for items. Tags are metadata that you define.</p>
2629
- */
2630
- Tags?: Tag[];
2631
- }
2632
- export declare namespace ListTagsForResourceResponse {
2633
- /**
2634
- * @internal
2635
- */
2636
- const filterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
2637
- }
2638
- export interface ListUsersRequest {
2639
- /**
2640
- * <p>Specifies the number of users to return as a response to the <code>ListUsers</code>
2641
- * request.</p>
2642
- */
2643
- MaxResults?: number;
2644
- /**
2645
- * <p>When you can get additional results from the <code>ListUsers</code> call, a
2646
- * <code>NextToken</code> parameter is returned in the output. You can then pass in a
2647
- * subsequent command to the <code>NextToken</code> parameter to continue listing additional
2648
- * users.</p>
2649
- */
2650
- NextToken?: string;
2651
- /**
2652
- * <p>A system-assigned unique identifier for a server that has users assigned to it.</p>
2653
- */
2654
- ServerId: string | undefined;
2655
- }
2656
- export declare namespace ListUsersRequest {
2657
- /**
2658
- * @internal
2659
- */
2660
- const filterSensitiveLog: (obj: ListUsersRequest) => any;
2661
- }
2662
- export interface ListUsersResponse {
2663
- /**
2664
- * <p>When you can get additional results from the <code>ListUsers</code> call, a
2665
- * <code>NextToken</code> parameter is returned in the output. You can then pass in a
2666
- * subsequent command to the <code>NextToken</code> parameter to continue listing additional
2667
- * users.</p>
2668
- */
2669
- NextToken?: string;
2670
- /**
2671
- * <p>A system-assigned unique identifier for a server that the users are assigned to.</p>
2672
- */
2673
- ServerId: string | undefined;
2674
- /**
2675
- * <p>Returns the user accounts and their properties for the <code>ServerId</code> value that
2676
- * you specify.</p>
2677
- */
2678
- Users: ListedUser[] | undefined;
2679
- }
2680
- export declare namespace ListUsersResponse {
2681
- /**
2682
- * @internal
2683
- */
2684
- const filterSensitiveLog: (obj: ListUsersResponse) => any;
2685
- }
2686
- export interface ListWorkflowsRequest {
2687
- /**
2688
- * <p>Specifies the maximum number of workflows to return.</p>
2689
- */
2690
- MaxResults?: number;
2691
- /**
2692
- * <p>
2693
- * <code>ListWorkflows</code> returns the <code>NextToken</code> parameter in the output.
2694
- * You can then pass the <code>NextToken</code> parameter in a subsequent command to
2695
- * continue listing additional workflows.</p>
2696
- */
2697
- NextToken?: string;
2698
- }
2699
- export declare namespace ListWorkflowsRequest {
2700
- /**
2701
- * @internal
2702
- */
2703
- const filterSensitiveLog: (obj: ListWorkflowsRequest) => any;
2704
- }
2705
- export interface ListWorkflowsResponse {
2706
- /**
2707
- * <p>
2708
- * <code>ListWorkflows</code> returns the <code>NextToken</code> parameter in the output.
2709
- * You can then pass the <code>NextToken</code> parameter in a subsequent command to
2710
- * continue listing additional workflows.</p>
2711
- */
2712
- NextToken?: string;
2713
- /**
2714
- * <p>Returns the <code>Arn</code>, <code>WorkflowId</code>, and <code>Description</code> for each workflow.</p>
2715
- */
2716
- Workflows: ListedWorkflow[] | undefined;
2717
- }
2718
- export declare namespace ListWorkflowsResponse {
2719
- /**
2720
- * @internal
2721
- */
2722
- const filterSensitiveLog: (obj: ListWorkflowsResponse) => any;
2723
- }
2724
- export interface SendWorkflowStepStateRequest {
2725
- /**
2726
- * <p>A unique identifier for the workflow.</p>
2727
- */
2728
- WorkflowId: string | undefined;
2729
- /**
2730
- * <p>A unique identifier for the execution of a workflow.</p>
2731
- */
2732
- ExecutionId: string | undefined;
2733
- /**
2734
- * <p>Used to distinguish between multiple callbacks for multiple Lambda steps within the same execution.</p>
2735
- */
2736
- Token: string | undefined;
2737
- /**
2738
- * <p>Indicates whether the specified step succeeded or failed.</p>
2739
- */
2740
- Status: CustomStepStatus | string | undefined;
2741
- }
2742
- export declare namespace SendWorkflowStepStateRequest {
2743
- /**
2744
- * @internal
2745
- */
2746
- const filterSensitiveLog: (obj: SendWorkflowStepStateRequest) => any;
2747
- }
2748
- export interface SendWorkflowStepStateResponse {
2749
- }
2750
- export declare namespace SendWorkflowStepStateResponse {
2751
- /**
2752
- * @internal
2753
- */
2754
- const filterSensitiveLog: (obj: SendWorkflowStepStateResponse) => any;
2755
- }
2756
- export interface StartServerRequest {
2757
- /**
2758
- * <p>A system-assigned unique identifier for a server that you start.</p>
2759
- */
2760
- ServerId: string | undefined;
2761
- }
2762
- export declare namespace StartServerRequest {
2763
- /**
2764
- * @internal
2765
- */
2766
- const filterSensitiveLog: (obj: StartServerRequest) => any;
2767
- }
2768
- export interface StopServerRequest {
2769
- /**
2770
- * <p>A system-assigned unique identifier for a server that you stopped.</p>
2771
- */
2772
- ServerId: string | undefined;
2773
- }
2774
- export declare namespace StopServerRequest {
2775
- /**
2776
- * @internal
2777
- */
2778
- const filterSensitiveLog: (obj: StopServerRequest) => any;
2779
- }
2780
- export interface TagResourceRequest {
2781
- /**
2782
- * <p>An Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a server, user, or
2783
- * role.</p>
2784
- */
2785
- Arn: string | undefined;
2786
- /**
2787
- * <p>Key-value pairs assigned to ARNs that you can use to group and search for resources by
2788
- * type. You can attach this metadata to user accounts for any purpose.</p>
2789
- */
2790
- Tags: Tag[] | undefined;
2791
- }
2792
- export declare namespace TagResourceRequest {
2793
- /**
2794
- * @internal
2795
- */
2796
- const filterSensitiveLog: (obj: TagResourceRequest) => any;
2797
- }
2798
- export interface TestIdentityProviderRequest {
2799
- /**
2800
- * <p>A system-assigned identifier for a specific server. That server's user authentication
2801
- * method is tested with a user name and password.</p>
2802
- */
2803
- ServerId: string | undefined;
2804
- /**
2805
- * <p>The type of file transfer protocol to be tested.</p>
2806
- *
2807
- * <p>The available protocols are:</p>
2808
- *
2809
- * <ul>
2810
- * <li>
2811
- * <p>Secure Shell (SSH) File Transfer Protocol (SFTP)</p>
2812
- * </li>
2813
- * <li>
2814
- * <p>File Transfer Protocol Secure (FTPS)</p>
2815
- * </li>
2816
- * <li>
2817
- * <p>File Transfer Protocol (FTP)</p>
2818
- * </li>
2819
- * </ul>
2820
- */
2821
- ServerProtocol?: Protocol | string;
2822
- /**
2823
- * <p>The source IP address of the user account to be tested.</p>
2824
- */
2825
- SourceIp?: string;
2826
- /**
2827
- * <p>The name of the user account to be tested.</p>
2828
- */
2829
- UserName: string | undefined;
2830
- /**
2831
- * <p>The password of the user account to be tested.</p>
2832
- */
2833
- UserPassword?: string;
2834
- }
2835
- export declare namespace TestIdentityProviderRequest {
2836
- /**
2837
- * @internal
2838
- */
2839
- const filterSensitiveLog: (obj: TestIdentityProviderRequest) => any;
2840
- }
2841
- export interface TestIdentityProviderResponse {
2842
- /**
2843
- * <p>The response that is returned from your API Gateway.</p>
2844
- */
2845
- Response?: string;
2846
- /**
2847
- * <p>The HTTP status code that is the response from your API Gateway.</p>
2848
- */
2849
- StatusCode: number | undefined;
2850
- /**
2851
- * <p>A message that indicates whether the test was successful or not.</p>
2852
- */
2853
- Message?: string;
2854
- /**
2855
- * <p>The endpoint of the service used to authenticate a user.</p>
2856
- */
2857
- Url: string | undefined;
2858
- }
2859
- export declare namespace TestIdentityProviderResponse {
2860
- /**
2861
- * @internal
2862
- */
2863
- const filterSensitiveLog: (obj: TestIdentityProviderResponse) => any;
2864
- }
2865
- export interface UntagResourceRequest {
2866
- /**
2867
- * <p>The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is
2868
- * an identifier for a specific Amazon Web Services resource, such as a server, user, or role.</p>
2869
- */
2870
- Arn: string | undefined;
2871
- /**
2872
- * <p>TagKeys are key-value pairs assigned to ARNs that can be used to group and search for
2873
- * resources by type. This metadata can be attached to resources for any purpose.</p>
2874
- */
2875
- TagKeys: string[] | undefined;
2876
- }
2877
- export declare namespace UntagResourceRequest {
2878
- /**
2879
- * @internal
2880
- */
2881
- const filterSensitiveLog: (obj: UntagResourceRequest) => any;
2882
- }
2883
- export interface UpdateAccessRequest {
2884
- /**
2885
- * <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
2886
- * <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
2887
- */
2888
- HomeDirectory?: string;
2889
- /**
2890
- * <p>The type of landing directory (folder) you want your users' home directory to be when they log into the server.
2891
- * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.
2892
- * If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon
2893
- * S3 or EFS paths visible to your users.</p>
2894
- */
2895
- HomeDirectoryType?: HomeDirectoryType | string;
2896
- /**
2897
- * <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
2898
- * be visible to your user and how you want to make them visible. You must specify the
2899
- * <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
2900
- * is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you
2901
- * only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity
2902
- * and Access Management (IAM) role provides access to paths in <code>Target</code>. This value
2903
- * can only be set when <code>HomeDirectoryType</code> is set to
2904
- * <i>LOGICAL</i>.</p>
2905
- * <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p>
2906
- * <p>
2907
- * <code>[ { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]</code>
2908
- * </p>
2909
- * <p>In most cases, you can use this value instead of the session policy to lock down your
2910
- * user to the designated home directory ("<code>chroot</code>"). To do this, you can set
2911
- * <code>Entry</code> to <code>/</code> and set <code>Target</code> to the
2912
- * <code>HomeDirectory</code> parameter value.</p>
2913
- * <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p>
2914
- * <p>
2915
- * <code>[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]</code>
2916
- * </p>
2917
- *
2918
- * <note>
2919
- * <p>If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is
2920
- * ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place
2921
- * holders for your directory. If using the CLI, use the <code>s3api</code> or <code>efsapi</code> call instead of
2922
- * <code>s3</code> or <code>efs</code> so you can use the put-object operation. For example, you use the
2923
- * following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make
2924
- * sure that the end of the key name ends in a <code>/</code> for it to be considered a folder.</p>
2925
- * </note>
2926
- */
2927
- HomeDirectoryMappings?: HomeDirectoryMapEntry[];
2928
- /**
2929
- * <p>A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user
2930
- * access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>,
2931
- * <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>
2932
- *
2933
- *
2934
- * <note>
2935
- * <p>This only applies when the domain of <code>ServerId</code> is S3. EFS does not use session policies.</p>
2936
- * <p>For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead
2937
- * of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass
2938
- * it in the <code>Policy</code> argument.</p>
2939
- * <p>For an example of a session policy, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html">Example
2940
- * session policy</a>.</p>
2941
- * <p>For more information, see <a href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html">AssumeRole</a> in the <i>Amazon Web ServicesSecurity Token Service API
2942
- * Reference</i>.</p>
2943
- * </note>
2944
- */
2945
- Policy?: string;
2946
- /**
2947
- * <p>The full POSIX identity, including user ID (<code>Uid</code>), group ID
2948
- * (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
2949
- * your users' access to your Amazon EFS file systems. The POSIX permissions that are set on
2950
- * files and directories in your file system determine the level of access your users get when
2951
- * transferring files into and out of your Amazon EFS file systems.</p>
2952
- */
2953
- PosixProfile?: PosixProfile;
2954
- /**
2955
- * <p>Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS
2956
- * file system. The policies attached to this role determine the level of access that you want to provide your users when transferring
2957
- * files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the
2958
- * server to access your resources when servicing your users' transfer requests.</p>
2959
- */
2960
- Role?: string;
2961
- /**
2962
- * <p>A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.</p>
2963
- */
2964
- ServerId: string | undefined;
2965
- /**
2966
- * <p>A unique identifier that is required to identify specific groups within your directory.
2967
- * The users of the group that you associate have access to your Amazon S3 or Amazon EFS
2968
- * resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,
2969
- * you can view the SID values by running the following command using Windows PowerShell.</p>
2970
- *
2971
- * <p>
2972
- * <code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code>
2973
- * </p>
2974
- *
2975
- * <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
2976
- *
2977
- * <p>The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.
2978
- * You can also include underscores or any of the following characters: =,.@:/-</p>
2979
- */
2980
- ExternalId: string | undefined;
2981
- }
2982
- export declare namespace UpdateAccessRequest {
2983
- /**
2984
- * @internal
2985
- */
2986
- const filterSensitiveLog: (obj: UpdateAccessRequest) => any;
2987
- }
2988
- export interface UpdateAccessResponse {
2989
- /**
2990
- * <p>The ID of the server that the user is attached to.</p>
2991
- */
2992
- ServerId: string | undefined;
2993
- /**
2994
- * <p>The external ID of the group whose users have access to your Amazon S3 or Amazon EFS
2995
- * resources over the enabled protocols using Amazon Web ServicesTransfer Family.</p>
2996
- */
2997
- ExternalId: string | undefined;
2998
- }
2999
- export declare namespace UpdateAccessResponse {
3000
- /**
3001
- * @internal
3002
- */
3003
- const filterSensitiveLog: (obj: UpdateAccessResponse) => any;
3004
- }
3005
- export interface UpdateServerRequest {
3006
- /**
3007
- * <p>The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required
3008
- * when <code>Protocols</code> is set to <code>FTPS</code>.</p>
3009
- *
3010
- * <p>To request a new public certificate, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html">Request a public certificate</a>
3011
- * in the <i> Amazon Web ServicesCertificate Manager User Guide</i>.</p>
3012
- *
3013
- * <p>To import an existing certificate into ACM, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing certificates into ACM</a>
3014
- * in the <i> Amazon Web ServicesCertificate Manager User Guide</i>.</p>
3015
- *
3016
- * <p>To request a private certificate to use FTPS through private IP addresses, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html">Request a
3017
- * private certificate</a> in the <i> Amazon Web ServicesCertificate Manager User
3018
- * Guide</i>.</p>
3019
- *
3020
- * <p>Certificates with the following cryptographic algorithms and key sizes are
3021
- * supported:</p>
3022
- *
3023
- * <ul>
3024
- * <li>
3025
- * <p>2048-bit RSA (RSA_2048)</p>
3026
- * </li>
3027
- * <li>
3028
- * <p>4096-bit RSA (RSA_4096)</p>
3029
- * </li>
3030
- * <li>
3031
- * <p>Elliptic Prime Curve 256 bit (EC_prime256v1)</p>
3032
- * </li>
3033
- * <li>
3034
- * <p>Elliptic Prime Curve 384 bit (EC_secp384r1)</p>
3035
- * </li>
3036
- * <li>
3037
- * <p>Elliptic Prime Curve 521 bit (EC_secp521r1)</p>
3038
- * </li>
3039
- * </ul>
3040
- *
3041
- * <note>
3042
- * <p>The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP
3043
- * address specified and information about the issuer.</p>
3044
- * </note>
3045
- */
3046
- Certificate?: string;
3047
- /**
3048
- * <p>
3049
- * The protocol settings that are configured for your server.
3050
- * </p>
3051
- * <p>
3052
- * Use the <code>PassiveIp</code> parameter to indicate passive mode (for FTP and FTPS protocols).
3053
- * Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
3054
- * </p>
3055
- */
3056
- ProtocolDetails?: ProtocolDetails;
3057
- /**
3058
- * <p>The virtual private cloud (VPC) endpoint settings that are configured for your server.
3059
- * When you host your endpoint within your VPC, you can make it accessible only to resources
3060
- * within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over
3061
- * the internet. Your VPC's default security groups are automatically assigned to your
3062
- * endpoint.</p>
3063
- */
3064
- EndpointDetails?: EndpointDetails;
3065
- /**
3066
- * <p>The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC)
3067
- * or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and
3068
- * resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.</p>
3069
- * <note>
3070
- * <p> After May 19, 2021, you won't be able to create a server using
3071
- * <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Servicesaccount if your account hasn't already
3072
- * done so before May 19, 2021. If you have already created servers with
3073
- * <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Servicesaccount on or before May 19, 2021,
3074
- * you will not be affected. After this date, use
3075
- * <code>EndpointType</code>=<code>VPC</code>.</p>
3076
- *
3077
- * <p>For more information, see
3078
- * https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p>
3079
- * <p>It is recommended that you use <code>VPC</code> as the <code>EndpointType</code>. With
3080
- * this endpoint type, you have the option to directly associate up to three Elastic IPv4
3081
- * addresses (BYO IP included) with your server's endpoint and use VPC security groups to
3082
- * restrict traffic by the client's public IP address. This is not possible with
3083
- * <code>EndpointType</code> set to <code>VPC_ENDPOINT</code>.</p>
3084
- * </note>
3085
- */
3086
- EndpointType?: EndpointType | string;
3087
- /**
3088
- * <p>The RSA private key as generated by <code>ssh-keygen -N "" -m PEM -f
3089
- * my-new-server-key</code>.</p>
3090
- *
3091
- * <important>
3092
- * <p>If you aren't planning to migrate existing users from an existing server to a new
3093
- * server, don't update the host key. Accidentally changing a server's host key can
3094
- * be disruptive.</p>
3095
- * </important>
3096
- *
3097
- *
3098
- *
3099
- * <p>For more information, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key">Change the host key for your SFTP-enabled server</a> in the <i>Amazon Web ServicesTransfer
3100
- * Family User Guide</i>.</p>
3101
- */
3102
- HostKey?: string;
3103
- /**
3104
- * <p>An array containing all of the information required to call a customer's
3105
- * authentication API method.</p>
3106
- */
3107
- IdentityProviderDetails?: IdentityProviderDetails;
3108
- /**
3109
- * <p>Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn
3110
- * on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in
3111
- * your CloudWatch logs.</p>
3112
- */
3113
- LoggingRole?: string;
3114
- /**
3115
- * <p>Specifies the file transfer protocol or protocols over which your file transfer protocol
3116
- * client can connect to your server's endpoint. The available protocols are:</p>
3117
- *
3118
- * <ul>
3119
- * <li>
3120
- * <p>Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH</p>
3121
- * </li>
3122
- * <li>
3123
- * <p>File Transfer Protocol Secure (FTPS): File transfer with TLS encryption</p>
3124
- * </li>
3125
- * <li>
3126
- * <p>File Transfer Protocol (FTP): Unencrypted file transfer</p>
3127
- * </li>
3128
- * </ul>
3129
- *
3130
- * <note>
3131
- * <p>If you select <code>FTPS</code>, you must choose a certificate stored in Amazon Web ServicesCertificate
3132
- * Manager (ACM) which will be used to identify your server when clients connect to it over
3133
- * FTPS.</p>
3134
- *
3135
- *
3136
- * <p>If <code>Protocol</code> includes either <code>FTP</code> or <code>FTPS</code>, then the
3137
- * <code>EndpointType</code> must be <code>VPC</code> and the
3138
- * <code>IdentityProviderType</code> must be <code>AWS_DIRECTORY_SERVICE</code> or <code>API_GATEWAY</code>.</p>
3139
- *
3140
- * <p>If <code>Protocol</code> includes <code>FTP</code>, then
3141
- * <code>AddressAllocationIds</code> cannot be associated.</p>
3142
- *
3143
- * <p>If <code>Protocol</code> is set only to <code>SFTP</code>, the <code>EndpointType</code>
3144
- * can be set to <code>PUBLIC</code> and the <code>IdentityProviderType</code> can be set to
3145
- * <code>SERVICE_MANAGED</code>.</p>
3146
- * </note>
3147
- */
3148
- Protocols?: (Protocol | string)[];
3149
- /**
3150
- * <p>Specifies the name of the security policy that is attached to the server.</p>
3151
- */
3152
- SecurityPolicyName?: string;
3153
- /**
3154
- * <p>A system-assigned unique identifier for a server instance that the user account is
3155
- * assigned to.</p>
3156
- */
3157
- ServerId: string | undefined;
3158
- /**
3159
- * <p>Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.</p>
3160
- */
3161
- WorkflowDetails?: WorkflowDetails;
3162
- }
3163
- export declare namespace UpdateServerRequest {
3164
- /**
3165
- * @internal
3166
- */
3167
- const filterSensitiveLog: (obj: UpdateServerRequest) => any;
3168
- }
3169
- export interface UpdateServerResponse {
3170
- /**
3171
- * <p>A system-assigned unique identifier for a server that the user account is assigned
3172
- * to.</p>
3173
- */
3174
- ServerId: string | undefined;
3175
- }
3176
- export declare namespace UpdateServerResponse {
3177
- /**
3178
- * @internal
3179
- */
3180
- const filterSensitiveLog: (obj: UpdateServerResponse) => any;
3181
- }
3182
- export interface UpdateUserRequest {
3183
- /**
3184
- * <p>The landing directory (folder) for a user when they log in to the server using the client.</p>
3185
- * <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>
3186
- */
3187
- HomeDirectory?: string;
3188
- /**
3189
- * <p>The type of landing directory (folder) you want your users' home directory to be when they log into the server.
3190
- * If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.
3191
- * If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon
3192
- * S3 or EFS paths visible to your users.</p>
3193
- */
3194
- HomeDirectoryType?: HomeDirectoryType | string;
3195
- /**
3196
- * <p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
3197
- * be visible to your user and how you want to make them visible. You must specify the
3198
- * <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path
3199
- * is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you
3200
- * only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity
3201
- * and Access Management (IAM) role provides access to paths in <code>Target</code>. This value
3202
- * can only be set when <code>HomeDirectoryType</code> is set to
3203
- * <i>LOGICAL</i>.</p>
3204
- *
3205
- * <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p>
3206
- * <p>
3207
- * <code>[ { "Entry": "your-personal-report.pdf", "Target":
3208
- * "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]</code>
3209
- * </p>
3210
- *
3211
- * <p>In most cases, you can use this value instead of the session policy to lock down your
3212
- * user to the designated home directory ("<code>chroot</code>"). To do this, you can set
3213
- * <code>Entry</code> to '/' and set <code>Target</code> to the HomeDirectory
3214
- * parameter value.</p>
3215
- *
3216
- * <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p>
3217
- * <p>
3218
- * <code>[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]</code>
3219
- * </p>
3220
- *
3221
- * <note>
3222
- * <p>If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is
3223
- * ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place
3224
- * holders for your directory. If using the CLI, use the <code>s3api</code> or <code>efsapi</code> call instead of
3225
- * <code>s3</code> or <code>efs</code> so you can use the put-object operation. For example, you use the
3226
- * following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make
3227
- * sure that the end of the key name ends in a <code>/</code> for it to be considered a folder.</p>
3228
- * </note>
3229
- */
3230
- HomeDirectoryMappings?: HomeDirectoryMapEntry[];
3231
- /**
3232
- * <p>A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user
3233
- * access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>,
3234
- * <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>
3235
- *
3236
- * <note>
3237
- * <p>This only applies when the domain of <code>ServerId</code> is S3. EFS does not use session policies.</p>
3238
- * <p>For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead
3239
- * of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass
3240
- * it in the <code>Policy</code> argument.</p>
3241
- *
3242
- *
3243
- *
3244
- * <p>For an example of a session policy, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/session-policy">Creating a session
3245
- * policy</a>.</p>
3246
- *
3247
- *
3248
- *
3249
- * <p>For more information, see <a href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html">AssumeRole</a> in the <i>Amazon Web Services
3250
- * Security Token Service API Reference</i>.</p>
3251
- * </note>
3252
- */
3253
- Policy?: string;
3254
- /**
3255
- * <p>Specifies the full POSIX identity, including user ID (<code>Uid</code>), group ID
3256
- * (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls
3257
- * your users' access to your Amazon Elastic File Systems (Amazon EFS). The POSIX permissions
3258
- * that are set on files and directories in your file system determines the level of access your
3259
- * users get when transferring files into and out of your Amazon EFS file systems.</p>
3260
- */
3261
- PosixProfile?: PosixProfile;
3262
- /**
3263
- * <p>Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS
3264
- * file system. The policies attached to this role determine the level of access that you want to provide your users when transferring
3265
- * files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the
3266
- * server to access your resources when servicing your users' transfer requests.</p>
3267
- */
3268
- Role?: string;
3269
- /**
3270
- * <p>A system-assigned unique identifier for a server instance that the user account is
3271
- * assigned to.</p>
3272
- */
3273
- ServerId: string | undefined;
3274
- /**
3275
- * <p>A unique string that identifies a user and is associated with a server as specified by the
3276
- * <code>ServerId</code>. This user name must be a minimum of 3 and a maximum of 100 characters
3277
- * long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen
3278
- * '-', period '.', and at sign '@'. The user name can't start
3279
- * with a hyphen, period, or at sign.</p>
3280
- */
3281
- UserName: string | undefined;
3282
- }
3283
- export declare namespace UpdateUserRequest {
3284
- /**
3285
- * @internal
3286
- */
3287
- const filterSensitiveLog: (obj: UpdateUserRequest) => any;
3288
- }
3289
- /**
3290
- * <p>
3291
- * <code>UpdateUserResponse</code> returns the user name and identifier for the request to
3292
- * update a user's properties.</p>
3293
- */
3294
- export interface UpdateUserResponse {
3295
- /**
3296
- * <p>A system-assigned unique identifier for a server instance that the user account is
3297
- * assigned to.</p>
3298
- */
3299
- ServerId: string | undefined;
3300
- /**
3301
- * <p>The unique identifier for a user that is assigned to a server instance that was specified
3302
- * in the request.</p>
3303
- */
3304
- UserName: string | undefined;
3305
- }
3306
- export declare namespace UpdateUserResponse {
3307
- /**
3308
- * @internal
3309
- */
3310
- const filterSensitiveLog: (obj: UpdateUserResponse) => any;
3311
- }