@aws-sdk/client-secrets-manager 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 (303) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/{dist/cjs → dist-cjs}/SecretsManager.js +2 -68
  3. package/dist-cjs/SecretsManagerClient.js +35 -0
  4. package/dist-cjs/commands/CancelRotateSecretCommand.js +36 -0
  5. package/dist-cjs/commands/CreateSecretCommand.js +36 -0
  6. package/dist-cjs/commands/DeleteResourcePolicyCommand.js +36 -0
  7. package/dist-cjs/commands/DeleteSecretCommand.js +36 -0
  8. package/dist-cjs/commands/DescribeSecretCommand.js +36 -0
  9. package/{dist/cjs → dist-cjs}/commands/GetRandomPasswordCommand.js +2 -39
  10. package/dist-cjs/commands/GetResourcePolicyCommand.js +36 -0
  11. package/dist-cjs/commands/GetSecretValueCommand.js +36 -0
  12. package/dist-cjs/commands/ListSecretVersionIdsCommand.js +36 -0
  13. package/dist-cjs/commands/ListSecretsCommand.js +36 -0
  14. package/dist-cjs/commands/PutResourcePolicyCommand.js +36 -0
  15. package/dist-cjs/commands/PutSecretValueCommand.js +36 -0
  16. package/{dist/cjs → dist-cjs}/commands/RemoveRegionsFromReplicationCommand.js +2 -27
  17. package/{dist/cjs → dist-cjs}/commands/ReplicateSecretToRegionsCommand.js +2 -28
  18. package/dist-cjs/commands/RestoreSecretCommand.js +36 -0
  19. package/dist-cjs/commands/RotateSecretCommand.js +36 -0
  20. package/{dist/cjs → dist-cjs}/commands/StopReplicationToReplicaCommand.js +2 -27
  21. package/dist-cjs/commands/TagResourceCommand.js +36 -0
  22. package/dist-cjs/commands/UntagResourceCommand.js +36 -0
  23. package/dist-cjs/commands/UpdateSecretCommand.js +36 -0
  24. package/dist-cjs/commands/UpdateSecretVersionStageCommand.js +36 -0
  25. package/dist-cjs/commands/ValidateResourcePolicyCommand.js +36 -0
  26. package/{dist/cjs → dist-cjs}/endpoints.js +1 -2
  27. package/{dist/cjs → dist-cjs}/index.js +0 -1
  28. package/{dist/cjs → dist-cjs}/models/index.js +0 -1
  29. package/{dist/cjs → dist-cjs}/models/models_0.js +0 -187
  30. package/{dist/cjs → dist-cjs}/pagination/Interfaces.js +0 -1
  31. package/{dist/cjs → dist-cjs}/pagination/ListSecretVersionIdsPaginator.js +1 -12
  32. package/{dist/cjs → dist-cjs}/pagination/ListSecretsPaginator.js +1 -12
  33. package/{dist/cjs → dist-cjs}/protocols/Aws_json1_1.js +0 -6
  34. package/{dist/cjs → dist-cjs}/runtimeConfig.browser.js +1 -5
  35. package/{dist/cjs → dist-cjs}/runtimeConfig.js +1 -5
  36. package/{dist/cjs → dist-cjs}/runtimeConfig.native.js +0 -4
  37. package/{dist/cjs → dist-cjs}/runtimeConfig.shared.js +1 -5
  38. package/{dist/es → dist-es}/SecretsManager.js +2 -3
  39. package/{dist/es → dist-es}/SecretsManagerClient.js +1 -2
  40. package/{dist/es → dist-es}/commands/CancelRotateSecretCommand.js +2 -3
  41. package/{dist/es → dist-es}/commands/CreateSecretCommand.js +2 -3
  42. package/{dist/es → dist-es}/commands/DeleteResourcePolicyCommand.js +2 -3
  43. package/{dist/es → dist-es}/commands/DeleteSecretCommand.js +2 -3
  44. package/{dist/es → dist-es}/commands/DescribeSecretCommand.js +2 -3
  45. package/{dist/es → dist-es}/commands/GetRandomPasswordCommand.js +2 -3
  46. package/{dist/es → dist-es}/commands/GetResourcePolicyCommand.js +2 -3
  47. package/{dist/es → dist-es}/commands/GetSecretValueCommand.js +2 -3
  48. package/{dist/es → dist-es}/commands/ListSecretVersionIdsCommand.js +2 -3
  49. package/{dist/es → dist-es}/commands/ListSecretsCommand.js +2 -3
  50. package/{dist/es → dist-es}/commands/PutResourcePolicyCommand.js +2 -3
  51. package/{dist/es → dist-es}/commands/PutSecretValueCommand.js +2 -3
  52. package/{dist/es → dist-es}/commands/RemoveRegionsFromReplicationCommand.js +2 -3
  53. package/{dist/es → dist-es}/commands/ReplicateSecretToRegionsCommand.js +2 -3
  54. package/{dist/es → dist-es}/commands/RestoreSecretCommand.js +2 -3
  55. package/{dist/es → dist-es}/commands/RotateSecretCommand.js +2 -3
  56. package/{dist/es → dist-es}/commands/StopReplicationToReplicaCommand.js +2 -3
  57. package/{dist/es → dist-es}/commands/TagResourceCommand.js +2 -3
  58. package/{dist/es → dist-es}/commands/UntagResourceCommand.js +2 -3
  59. package/{dist/es → dist-es}/commands/UpdateSecretCommand.js +2 -3
  60. package/{dist/es → dist-es}/commands/UpdateSecretVersionStageCommand.js +2 -3
  61. package/{dist/es → dist-es}/commands/ValidateResourcePolicyCommand.js +2 -3
  62. package/{dist/es → dist-es}/endpoints.js +1 -2
  63. package/{dist/types/index.d.ts → dist-es/index.js} +0 -0
  64. package/{dist/types/models/index.d.ts → dist-es/models/index.js} +0 -0
  65. package/{dist/es → dist-es}/models/models_0.js +0 -1
  66. package/dist-es/pagination/Interfaces.js +1 -0
  67. package/{dist/es → dist-es}/pagination/ListSecretVersionIdsPaginator.js +1 -2
  68. package/{dist/es → dist-es}/pagination/ListSecretsPaginator.js +1 -2
  69. package/{dist/es → dist-es}/protocols/Aws_json1_1.js +0 -1
  70. package/{dist/es → dist-es}/runtimeConfig.browser.js +1 -2
  71. package/{dist/es → dist-es}/runtimeConfig.js +1 -2
  72. package/{dist/es → dist-es}/runtimeConfig.native.js +0 -1
  73. package/{dist/es → dist-es}/runtimeConfig.shared.js +1 -2
  74. package/{dist/types → dist-types}/SecretsManager.d.ts +19 -13
  75. package/{dist/types → dist-types}/SecretsManagerClient.d.ts +9 -9
  76. package/{dist/types → dist-types}/commands/CancelRotateSecretCommand.d.ts +3 -3
  77. package/{dist/types → dist-types}/commands/CreateSecretCommand.d.ts +3 -3
  78. package/{dist/types → dist-types}/commands/DeleteResourcePolicyCommand.d.ts +3 -3
  79. package/{dist/types → dist-types}/commands/DeleteSecretCommand.d.ts +3 -3
  80. package/{dist/types → dist-types}/commands/DescribeSecretCommand.d.ts +3 -3
  81. package/{dist/types → dist-types}/commands/GetRandomPasswordCommand.d.ts +3 -3
  82. package/{dist/types → dist-types}/commands/GetResourcePolicyCommand.d.ts +3 -3
  83. package/{dist/types → dist-types}/commands/GetSecretValueCommand.d.ts +3 -3
  84. package/{dist/types → dist-types}/commands/ListSecretVersionIdsCommand.d.ts +3 -3
  85. package/{dist/types → dist-types}/commands/ListSecretsCommand.d.ts +3 -3
  86. package/{dist/types → dist-types}/commands/PutResourcePolicyCommand.d.ts +3 -3
  87. package/{dist/types/ts3.4 → dist-types}/commands/PutSecretValueCommand.d.ts +123 -122
  88. package/{dist/types → dist-types}/commands/RemoveRegionsFromReplicationCommand.d.ts +3 -3
  89. package/{dist/types → dist-types}/commands/ReplicateSecretToRegionsCommand.d.ts +3 -3
  90. package/{dist/types → dist-types}/commands/RestoreSecretCommand.d.ts +3 -3
  91. package/{dist/types → dist-types}/commands/RotateSecretCommand.d.ts +3 -3
  92. package/{dist/types → dist-types}/commands/StopReplicationToReplicaCommand.d.ts +3 -3
  93. package/{dist/types → dist-types}/commands/TagResourceCommand.d.ts +3 -3
  94. package/{dist/types → dist-types}/commands/UntagResourceCommand.d.ts +3 -3
  95. package/{dist/types/ts3.4 → dist-types}/commands/UpdateSecretCommand.d.ts +124 -119
  96. package/{dist/types → dist-types}/commands/UpdateSecretVersionStageCommand.d.ts +3 -3
  97. package/{dist/types → dist-types}/commands/ValidateResourcePolicyCommand.d.ts +3 -3
  98. package/{dist/types → dist-types}/endpoints.d.ts +0 -0
  99. package/{index.ts → dist-types/index.d.ts} +0 -0
  100. package/{models/index.ts → dist-types/models/index.d.ts} +0 -0
  101. package/{dist/types → dist-types}/models/models_0.d.ts +54 -268
  102. package/{dist/types → dist-types}/pagination/Interfaces.d.ts +1 -1
  103. package/{dist/types → dist-types}/pagination/ListSecretVersionIdsPaginator.d.ts +1 -1
  104. package/{dist/types → dist-types}/pagination/ListSecretsPaginator.d.ts +1 -1
  105. package/{dist/types → dist-types}/protocols/Aws_json1_1.d.ts +3 -3
  106. package/{dist/types → dist-types}/runtimeConfig.browser.d.ts +0 -0
  107. package/{dist/types → dist-types}/runtimeConfig.d.ts +1 -1
  108. package/{dist/types → dist-types}/runtimeConfig.native.d.ts +0 -0
  109. package/{dist/types → dist-types}/runtimeConfig.shared.d.ts +0 -0
  110. package/dist-types/ts3.4/SecretsManager.d.ts +115 -0
  111. package/dist-types/ts3.4/SecretsManagerClient.d.ts +89 -0
  112. package/dist-types/ts3.4/commands/CancelRotateSecretCommand.d.ts +17 -0
  113. package/dist-types/ts3.4/commands/CreateSecretCommand.d.ts +17 -0
  114. package/dist-types/ts3.4/commands/DeleteResourcePolicyCommand.d.ts +17 -0
  115. package/dist-types/ts3.4/commands/DeleteSecretCommand.d.ts +17 -0
  116. package/dist-types/ts3.4/commands/DescribeSecretCommand.d.ts +17 -0
  117. package/dist-types/ts3.4/commands/GetRandomPasswordCommand.d.ts +17 -0
  118. package/dist-types/ts3.4/commands/GetResourcePolicyCommand.d.ts +17 -0
  119. package/dist-types/ts3.4/commands/GetSecretValueCommand.d.ts +17 -0
  120. package/dist-types/ts3.4/commands/ListSecretVersionIdsCommand.d.ts +17 -0
  121. package/dist-types/ts3.4/commands/ListSecretsCommand.d.ts +17 -0
  122. package/dist-types/ts3.4/commands/PutResourcePolicyCommand.d.ts +17 -0
  123. package/dist-types/ts3.4/commands/PutSecretValueCommand.d.ts +17 -0
  124. package/{dist/types → dist-types}/ts3.4/commands/RemoveRegionsFromReplicationCommand.d.ts +5 -23
  125. package/dist-types/ts3.4/commands/ReplicateSecretToRegionsCommand.d.ts +17 -0
  126. package/dist-types/ts3.4/commands/RestoreSecretCommand.d.ts +17 -0
  127. package/dist-types/ts3.4/commands/RotateSecretCommand.d.ts +17 -0
  128. package/{dist/types → dist-types}/ts3.4/commands/StopReplicationToReplicaCommand.d.ts +5 -23
  129. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +17 -0
  130. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +17 -0
  131. package/dist-types/ts3.4/commands/UpdateSecretCommand.d.ts +17 -0
  132. package/dist-types/ts3.4/commands/UpdateSecretVersionStageCommand.d.ts +17 -0
  133. package/dist-types/ts3.4/commands/ValidateResourcePolicyCommand.d.ts +17 -0
  134. package/{dist/types → dist-types}/ts3.4/endpoints.d.ts +0 -0
  135. package/{dist/types → dist-types}/ts3.4/index.d.ts +0 -0
  136. package/{dist/types → dist-types}/ts3.4/models/index.d.ts +0 -0
  137. package/dist-types/ts3.4/models/models_0.d.ts +791 -0
  138. package/{dist/types → dist-types}/ts3.4/pagination/Interfaces.d.ts +1 -1
  139. package/{dist/types → dist-types}/ts3.4/pagination/ListSecretVersionIdsPaginator.d.ts +1 -1
  140. package/{dist/types → dist-types}/ts3.4/pagination/ListSecretsPaginator.d.ts +1 -1
  141. package/{dist/types → dist-types}/ts3.4/protocols/Aws_json1_1.d.ts +3 -3
  142. package/{dist/types → dist-types}/ts3.4/runtimeConfig.browser.d.ts +1 -3
  143. package/{dist/types → dist-types}/ts3.4/runtimeConfig.d.ts +2 -4
  144. package/{dist/types → dist-types}/ts3.4/runtimeConfig.native.d.ts +1 -3
  145. package/{dist/types → dist-types}/ts3.4/runtimeConfig.shared.d.ts +1 -3
  146. package/package.json +45 -42
  147. package/SecretsManager.ts +0 -1642
  148. package/SecretsManagerClient.ts +0 -384
  149. package/commands/CancelRotateSecretCommand.ts +0 -146
  150. package/commands/CreateSecretCommand.ts +0 -181
  151. package/commands/DeleteResourcePolicyCommand.ts +0 -117
  152. package/commands/DeleteSecretCommand.ts +0 -139
  153. package/commands/DescribeSecretCommand.ts +0 -121
  154. package/commands/GetRandomPasswordCommand.ts +0 -106
  155. package/commands/GetResourcePolicyCommand.ts +0 -120
  156. package/commands/GetSecretValueCommand.ts +0 -121
  157. package/commands/ListSecretVersionIdsCommand.ts +0 -122
  158. package/commands/ListSecretsCommand.ts +0 -123
  159. package/commands/PutResourcePolicyCommand.ts +0 -125
  160. package/commands/PutSecretValueCommand.ts +0 -181
  161. package/commands/RemoveRegionsFromReplicationCommand.ts +0 -99
  162. package/commands/ReplicateSecretToRegionsCommand.ts +0 -95
  163. package/commands/RestoreSecretCommand.ts +0 -112
  164. package/commands/RotateSecretCommand.ts +0 -155
  165. package/commands/StopReplicationToReplicaCommand.ts +0 -94
  166. package/commands/TagResourceCommand.ts +0 -149
  167. package/commands/UntagResourceCommand.ts +0 -122
  168. package/commands/UpdateSecretCommand.ts +0 -178
  169. package/commands/UpdateSecretVersionStageCommand.ts +0 -130
  170. package/commands/ValidateResourcePolicyCommand.ts +0 -128
  171. package/dist/cjs/SecretsManager.js.map +0 -1
  172. package/dist/cjs/SecretsManagerClient.js +0 -106
  173. package/dist/cjs/SecretsManagerClient.js.map +0 -1
  174. package/dist/cjs/commands/CancelRotateSecretCommand.js +0 -113
  175. package/dist/cjs/commands/CancelRotateSecretCommand.js.map +0 -1
  176. package/dist/cjs/commands/CreateSecretCommand.js +0 -148
  177. package/dist/cjs/commands/CreateSecretCommand.js.map +0 -1
  178. package/dist/cjs/commands/DeleteResourcePolicyCommand.js +0 -84
  179. package/dist/cjs/commands/DeleteResourcePolicyCommand.js.map +0 -1
  180. package/dist/cjs/commands/DeleteSecretCommand.js +0 -106
  181. package/dist/cjs/commands/DeleteSecretCommand.js.map +0 -1
  182. package/dist/cjs/commands/DescribeSecretCommand.js +0 -88
  183. package/dist/cjs/commands/DescribeSecretCommand.js.map +0 -1
  184. package/dist/cjs/commands/GetRandomPasswordCommand.js.map +0 -1
  185. package/dist/cjs/commands/GetResourcePolicyCommand.js +0 -87
  186. package/dist/cjs/commands/GetResourcePolicyCommand.js.map +0 -1
  187. package/dist/cjs/commands/GetSecretValueCommand.js +0 -88
  188. package/dist/cjs/commands/GetSecretValueCommand.js.map +0 -1
  189. package/dist/cjs/commands/ListSecretVersionIdsCommand.js +0 -89
  190. package/dist/cjs/commands/ListSecretVersionIdsCommand.js.map +0 -1
  191. package/dist/cjs/commands/ListSecretsCommand.js +0 -90
  192. package/dist/cjs/commands/ListSecretsCommand.js.map +0 -1
  193. package/dist/cjs/commands/PutResourcePolicyCommand.js +0 -92
  194. package/dist/cjs/commands/PutResourcePolicyCommand.js.map +0 -1
  195. package/dist/cjs/commands/PutSecretValueCommand.js +0 -148
  196. package/dist/cjs/commands/PutSecretValueCommand.js.map +0 -1
  197. package/dist/cjs/commands/RemoveRegionsFromReplicationCommand.js.map +0 -1
  198. package/dist/cjs/commands/ReplicateSecretToRegionsCommand.js.map +0 -1
  199. package/dist/cjs/commands/RestoreSecretCommand.js +0 -79
  200. package/dist/cjs/commands/RestoreSecretCommand.js.map +0 -1
  201. package/dist/cjs/commands/RotateSecretCommand.js +0 -122
  202. package/dist/cjs/commands/RotateSecretCommand.js.map +0 -1
  203. package/dist/cjs/commands/StopReplicationToReplicaCommand.js.map +0 -1
  204. package/dist/cjs/commands/TagResourceCommand.js +0 -116
  205. package/dist/cjs/commands/TagResourceCommand.js.map +0 -1
  206. package/dist/cjs/commands/UntagResourceCommand.js +0 -89
  207. package/dist/cjs/commands/UntagResourceCommand.js.map +0 -1
  208. package/dist/cjs/commands/UpdateSecretCommand.js +0 -145
  209. package/dist/cjs/commands/UpdateSecretCommand.js.map +0 -1
  210. package/dist/cjs/commands/UpdateSecretVersionStageCommand.js +0 -97
  211. package/dist/cjs/commands/UpdateSecretVersionStageCommand.js.map +0 -1
  212. package/dist/cjs/commands/ValidateResourcePolicyCommand.js +0 -95
  213. package/dist/cjs/commands/ValidateResourcePolicyCommand.js.map +0 -1
  214. package/dist/cjs/endpoints.js.map +0 -1
  215. package/dist/cjs/index.js.map +0 -1
  216. package/dist/cjs/models/index.js.map +0 -1
  217. package/dist/cjs/models/models_0.js.map +0 -1
  218. package/dist/cjs/package.json +0 -93
  219. package/dist/cjs/pagination/Interfaces.js.map +0 -1
  220. package/dist/cjs/pagination/ListSecretVersionIdsPaginator.js.map +0 -1
  221. package/dist/cjs/pagination/ListSecretsPaginator.js.map +0 -1
  222. package/dist/cjs/protocols/Aws_json1_1.js.map +0 -1
  223. package/dist/cjs/runtimeConfig.browser.js.map +0 -1
  224. package/dist/cjs/runtimeConfig.js.map +0 -1
  225. package/dist/cjs/runtimeConfig.native.js.map +0 -1
  226. package/dist/cjs/runtimeConfig.shared.js.map +0 -1
  227. package/dist/es/SecretsManager.js.map +0 -1
  228. package/dist/es/SecretsManagerClient.js.map +0 -1
  229. package/dist/es/commands/CancelRotateSecretCommand.js.map +0 -1
  230. package/dist/es/commands/CreateSecretCommand.js.map +0 -1
  231. package/dist/es/commands/DeleteResourcePolicyCommand.js.map +0 -1
  232. package/dist/es/commands/DeleteSecretCommand.js.map +0 -1
  233. package/dist/es/commands/DescribeSecretCommand.js.map +0 -1
  234. package/dist/es/commands/GetRandomPasswordCommand.js.map +0 -1
  235. package/dist/es/commands/GetResourcePolicyCommand.js.map +0 -1
  236. package/dist/es/commands/GetSecretValueCommand.js.map +0 -1
  237. package/dist/es/commands/ListSecretVersionIdsCommand.js.map +0 -1
  238. package/dist/es/commands/ListSecretsCommand.js.map +0 -1
  239. package/dist/es/commands/PutResourcePolicyCommand.js.map +0 -1
  240. package/dist/es/commands/PutSecretValueCommand.js.map +0 -1
  241. package/dist/es/commands/RemoveRegionsFromReplicationCommand.js.map +0 -1
  242. package/dist/es/commands/ReplicateSecretToRegionsCommand.js.map +0 -1
  243. package/dist/es/commands/RestoreSecretCommand.js.map +0 -1
  244. package/dist/es/commands/RotateSecretCommand.js.map +0 -1
  245. package/dist/es/commands/StopReplicationToReplicaCommand.js.map +0 -1
  246. package/dist/es/commands/TagResourceCommand.js.map +0 -1
  247. package/dist/es/commands/UntagResourceCommand.js.map +0 -1
  248. package/dist/es/commands/UpdateSecretCommand.js.map +0 -1
  249. package/dist/es/commands/UpdateSecretVersionStageCommand.js.map +0 -1
  250. package/dist/es/commands/ValidateResourcePolicyCommand.js.map +0 -1
  251. package/dist/es/endpoints.js.map +0 -1
  252. package/dist/es/index.js +0 -29
  253. package/dist/es/index.js.map +0 -1
  254. package/dist/es/models/index.js +0 -2
  255. package/dist/es/models/index.js.map +0 -1
  256. package/dist/es/models/models_0.js.map +0 -1
  257. package/dist/es/package.json +0 -93
  258. package/dist/es/pagination/Interfaces.js +0 -2
  259. package/dist/es/pagination/Interfaces.js.map +0 -1
  260. package/dist/es/pagination/ListSecretVersionIdsPaginator.js.map +0 -1
  261. package/dist/es/pagination/ListSecretsPaginator.js.map +0 -1
  262. package/dist/es/protocols/Aws_json1_1.js.map +0 -1
  263. package/dist/es/runtimeConfig.browser.js.map +0 -1
  264. package/dist/es/runtimeConfig.js.map +0 -1
  265. package/dist/es/runtimeConfig.native.js.map +0 -1
  266. package/dist/es/runtimeConfig.shared.js.map +0 -1
  267. package/dist/types/commands/PutSecretValueCommand.d.ts +0 -122
  268. package/dist/types/commands/UpdateSecretCommand.d.ts +0 -119
  269. package/dist/types/ts3.4/SecretsManager.d.ts +0 -1014
  270. package/dist/types/ts3.4/SecretsManagerClient.d.ts +0 -216
  271. package/dist/types/ts3.4/commands/CancelRotateSecretCommand.d.ts +0 -87
  272. package/dist/types/ts3.4/commands/CreateSecretCommand.d.ts +0 -122
  273. package/dist/types/ts3.4/commands/DeleteResourcePolicyCommand.d.ts +0 -58
  274. package/dist/types/ts3.4/commands/DeleteSecretCommand.d.ts +0 -80
  275. package/dist/types/ts3.4/commands/DescribeSecretCommand.d.ts +0 -62
  276. package/dist/types/ts3.4/commands/GetRandomPasswordCommand.d.ts +0 -47
  277. package/dist/types/ts3.4/commands/GetResourcePolicyCommand.d.ts +0 -61
  278. package/dist/types/ts3.4/commands/GetSecretValueCommand.d.ts +0 -62
  279. package/dist/types/ts3.4/commands/ListSecretVersionIdsCommand.d.ts +0 -63
  280. package/dist/types/ts3.4/commands/ListSecretsCommand.d.ts +0 -64
  281. package/dist/types/ts3.4/commands/PutResourcePolicyCommand.d.ts +0 -66
  282. package/dist/types/ts3.4/commands/ReplicateSecretToRegionsCommand.d.ts +0 -36
  283. package/dist/types/ts3.4/commands/RestoreSecretCommand.d.ts +0 -53
  284. package/dist/types/ts3.4/commands/RotateSecretCommand.d.ts +0 -96
  285. package/dist/types/ts3.4/commands/TagResourceCommand.d.ts +0 -90
  286. package/dist/types/ts3.4/commands/UntagResourceCommand.d.ts +0 -63
  287. package/dist/types/ts3.4/commands/UpdateSecretVersionStageCommand.d.ts +0 -71
  288. package/dist/types/ts3.4/commands/ValidateResourcePolicyCommand.d.ts +0 -69
  289. package/dist/types/ts3.4/models/models_0.d.ts +0 -2041
  290. package/endpoints.ts +0 -86
  291. package/jest.config.js +0 -4
  292. package/models/models_0.ts +0 -2422
  293. package/pagination/Interfaces.ts +0 -7
  294. package/pagination/ListSecretVersionIdsPaginator.ts +0 -58
  295. package/pagination/ListSecretsPaginator.ts +0 -54
  296. package/protocols/Aws_json1_1.ts +0 -3421
  297. package/runtimeConfig.browser.ts +0 -40
  298. package/runtimeConfig.native.ts +0 -16
  299. package/runtimeConfig.shared.ts +0 -16
  300. package/runtimeConfig.ts +0 -45
  301. package/tsconfig.es.json +0 -10
  302. package/tsconfig.json +0 -31
  303. package/tsconfig.types.json +0 -8
@@ -1,2041 +0,0 @@
1
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
- /**
3
- * <p>(Optional) Custom type consisting of a <code>Region</code> (required) and the <code>KmsKeyId</code> which can be an <code>ARN</code>, <code>Key ID</code>, or <code>Alias</code>.</p>
4
- */
5
- export interface ReplicaRegionType {
6
- /**
7
- * <p>Describes a single instance of Region objects.</p>
8
- */
9
- Region?: string;
10
- /**
11
- * <p>Can be an <code>ARN</code>, <code>Key ID</code>, or <code>Alias</code>. </p>
12
- */
13
- KmsKeyId?: string;
14
- }
15
- export declare namespace ReplicaRegionType {
16
- /**
17
- * @internal
18
- */
19
- const filterSensitiveLog: (obj: ReplicaRegionType) => any;
20
- }
21
- export interface CancelRotateSecretRequest {
22
- /**
23
- * <p>Specifies the secret to cancel a rotation request. You can specify either the Amazon
24
- * Resource Name (ARN) or the friendly name of the secret.</p>
25
- * <note>
26
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
27
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
28
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
29
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
30
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
31
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
32
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
33
- * results. To avoid this situation, we recommend that you don’t create secret names ending
34
- * with a hyphen followed by six characters.</p>
35
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
36
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
37
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
38
- * </note>
39
- */
40
- SecretId: string | undefined;
41
- }
42
- export declare namespace CancelRotateSecretRequest {
43
- /**
44
- * @internal
45
- */
46
- const filterSensitiveLog: (obj: CancelRotateSecretRequest) => any;
47
- }
48
- export interface CancelRotateSecretResponse {
49
- /**
50
- * <p>The ARN of the secret for which rotation was canceled.</p>
51
- */
52
- ARN?: string;
53
- /**
54
- * <p>The friendly name of the secret for which rotation was canceled.</p>
55
- */
56
- Name?: string;
57
- /**
58
- * <p>The unique identifier of the version of the secret created during the rotation. This
59
- * version might not be complete, and should be evaluated for possible deletion. At the very
60
- * least, you should remove the <code>VersionStage</code> value <code>AWSPENDING</code> to enable this
61
- * version to be deleted. Failing to clean up a cancelled rotation can block you from
62
- * successfully starting future rotations.</p>
63
- */
64
- VersionId?: string;
65
- }
66
- export declare namespace CancelRotateSecretResponse {
67
- /**
68
- * @internal
69
- */
70
- const filterSensitiveLog: (obj: CancelRotateSecretResponse) => any;
71
- }
72
- /**
73
- * <p>An error occurred on the server side.</p>
74
- */
75
- export interface InternalServiceError extends __SmithyException, $MetadataBearer {
76
- name: "InternalServiceError";
77
- $fault: "server";
78
- Message?: string;
79
- }
80
- export declare namespace InternalServiceError {
81
- /**
82
- * @internal
83
- */
84
- const filterSensitiveLog: (obj: InternalServiceError) => any;
85
- }
86
- /**
87
- * <p>You provided an invalid value for a parameter.</p>
88
- */
89
- export interface InvalidParameterException extends __SmithyException, $MetadataBearer {
90
- name: "InvalidParameterException";
91
- $fault: "client";
92
- Message?: string;
93
- }
94
- export declare namespace InvalidParameterException {
95
- /**
96
- * @internal
97
- */
98
- const filterSensitiveLog: (obj: InvalidParameterException) => any;
99
- }
100
- /**
101
- * <p>You provided a parameter value that is not valid for the current state of the
102
- * resource.</p>
103
- * <p>Possible causes:</p>
104
- * <ul>
105
- * <li>
106
- * <p>You tried to perform the operation on a secret that's currently marked deleted.</p>
107
- * </li>
108
- * <li>
109
- * <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
110
- * ARN configured and you didn't include such an ARN as a parameter in this call. </p>
111
- * </li>
112
- * </ul>
113
- */
114
- export interface InvalidRequestException extends __SmithyException, $MetadataBearer {
115
- name: "InvalidRequestException";
116
- $fault: "client";
117
- Message?: string;
118
- }
119
- export declare namespace InvalidRequestException {
120
- /**
121
- * @internal
122
- */
123
- const filterSensitiveLog: (obj: InvalidRequestException) => any;
124
- }
125
- /**
126
- * <p>We can't find the resource that you asked for.</p>
127
- */
128
- export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
129
- name: "ResourceNotFoundException";
130
- $fault: "client";
131
- Message?: string;
132
- }
133
- export declare namespace ResourceNotFoundException {
134
- /**
135
- * @internal
136
- */
137
- const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
138
- }
139
- /**
140
- * <p>A structure that contains information about a tag.</p>
141
- */
142
- export interface Tag {
143
- /**
144
- * <p>The key identifier, or name, of the tag.</p>
145
- */
146
- Key?: string;
147
- /**
148
- * <p>The string value associated with the key of the tag.</p>
149
- */
150
- Value?: string;
151
- }
152
- export declare namespace Tag {
153
- /**
154
- * @internal
155
- */
156
- const filterSensitiveLog: (obj: Tag) => any;
157
- }
158
- export interface CreateSecretRequest {
159
- /**
160
- * <p>Specifies the friendly name of the new secret.</p>
161
- * <p>The secret name must be ASCII letters, digits, or the following characters :
162
- * /_+=.@-</p>
163
- * <note>
164
- * <p>Do not end your secret name with a hyphen followed by six characters. If you do so, you
165
- * risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager
166
- * automatically adds a hyphen and six random characters at the end of the ARN.</p>
167
- * </note>
168
- */
169
- Name: string | undefined;
170
- /**
171
- * <p>(Optional) If you include <code>SecretString</code> or <code>SecretBinary</code>, then an
172
- * initial version is created as part of the secret, and this parameter specifies a unique
173
- * identifier for the new version. </p>
174
- * <note>
175
- * <p>If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can
176
- * leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it
177
- * as the value for this parameter in the request. If you don't use the SDK and instead
178
- * generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a
179
- * <code>ClientRequestToken</code> yourself for the new version and include the value in the
180
- * request.</p>
181
- * </note>
182
- * <p>This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental
183
- * creation of duplicate versions if there are failures and retries during a rotation. We
184
- * recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value to
185
- * ensure uniqueness of your versions within the specified secret. </p>
186
- * <ul>
187
- * <li>
188
- * <p>If the <code>ClientRequestToken</code> value isn't already associated with a version
189
- * of the secret then a new version of the secret is created. </p>
190
- * </li>
191
- * <li>
192
- * <p>If a version with this value already exists and the version <code>SecretString</code>
193
- * and <code>SecretBinary</code> values are the same as those in the request, then the
194
- * request is ignored.</p>
195
- * </li>
196
- * <li>
197
- * <p>If a version with this value already exists and that version's
198
- * <code>SecretString</code> and <code>SecretBinary</code> values are different from those
199
- * in the request, then the request fails because you cannot modify an existing version.
200
- * Instead, use <a>PutSecretValue</a> to create a new version.</p>
201
- * </li>
202
- * </ul>
203
- * <p>This value becomes the <code>VersionId</code> of the new version.</p>
204
- */
205
- ClientRequestToken?: string;
206
- /**
207
- * <p>(Optional) Specifies a user-provided description of the secret.</p>
208
- */
209
- Description?: string;
210
- /**
211
- * <p>(Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services KMS customer master key (CMK) to
212
- * be used to encrypt the <code>SecretString</code> or <code>SecretBinary</code> values in the
213
- * versions stored in this secret.</p>
214
- * <p>You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to
215
- * reference a CMK in a different account, you can use only the key ARN or the alias ARN.</p>
216
- * <p>If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's
217
- * default CMK (the one named <code>aws/secretsmanager</code>). If a Amazon Web Services KMS CMK with that name doesn't yet
218
- * exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a
219
- * version's <code>SecretString</code> or <code>SecretBinary</code> fields.</p>
220
- * <important>
221
- * <p>You can use the account default CMK to encrypt and decrypt only if you call this
222
- * operation using credentials from the same account that owns the secret. If the secret
223
- * resides in a different account, then you must create a custom CMK and specify the ARN in
224
- * this field. </p>
225
- * </important>
226
- */
227
- KmsKeyId?: string;
228
- /**
229
- * <p>(Optional) Specifies binary data that you want to encrypt and store in the new version of
230
- * the secret. To use this parameter in the command-line tools, we recommend that you store your
231
- * binary data in a file and then use the appropriate technique for your tool to pass the
232
- * contents of the file as a parameter.</p>
233
- * <p>Either <code>SecretString</code> or <code>SecretBinary</code> must have a value, but not
234
- * both. They cannot both be empty.</p>
235
- * <p>This parameter is not available using the Secrets Manager console. It can be accessed only by
236
- * using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.</p>
237
- */
238
- SecretBinary?: Uint8Array;
239
- /**
240
- * <p>(Optional) Specifies text data that you want to encrypt and store in this new version of
241
- * the secret.</p>
242
- * <p>Either <code>SecretString</code> or <code>SecretBinary</code> must have a value, but not
243
- * both. They cannot both be empty.</p>
244
- * <p>If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected
245
- * secret text in only the <code>SecretString</code> parameter. The Secrets Manager console stores the
246
- * information as a JSON structure of key/value pairs that the Lambda rotation function knows how
247
- * to parse.</p>
248
- * <p>For storing multiple values, we recommend that you use a JSON text string argument and
249
- * specify key/value pairs. For information on how to format a JSON parameter for the various
250
- * command line tool environments, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json">Using JSON for
251
- * Parameters</a> in the <i>CLI User Guide</i>. For example:</p>
252
- * <p>
253
- * <code>{"username":"bob","password":"abc123xyz456"}</code>
254
- * </p>
255
- * <p>If your command-line tool or SDK requires quotation marks around the parameter, you should
256
- * use single quotes to avoid confusion with the double quotes required in the JSON text. </p>
257
- */
258
- SecretString?: string;
259
- /**
260
- * <p>(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag
261
- * is a "Key" and "Value" pair of strings. This operation only appends tags to the existing list
262
- * of tags. To remove tags, you must use <a>UntagResource</a>.</p>
263
- * <important>
264
- * <ul>
265
- * <li>
266
- * <p>Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag
267
- * from one with key "abc".</p>
268
- * </li>
269
- * <li>
270
- * <p>If you check tags in IAM policy <code>Condition</code> elements as part of your
271
- * security strategy, then adding or removing a tag can change permissions. If the
272
- * successful completion of this operation would result in you losing your permissions for
273
- * this secret, then this operation is blocked and returns an <code>Access Denied</code>
274
- * error.</p>
275
- * </li>
276
- * </ul>
277
- * </important>
278
- * <p>This parameter requires a JSON text string argument. For information on how to format a
279
- * JSON parameter for the various command line tool environments, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json">Using JSON for
280
- * Parameters</a> in the <i>CLI User Guide</i>. For example:</p>
281
- * <p>
282
- * <code>[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]</code>
283
- * </p>
284
- * <p>If your command-line tool or SDK requires quotation marks around the parameter, you should
285
- * use single quotes to avoid confusion with the double quotes required in the JSON text. </p>
286
- * <p>The following basic restrictions apply to tags:</p>
287
- * <ul>
288
- * <li>
289
- * <p>Maximum number of tags per secret—50</p>
290
- * </li>
291
- * <li>
292
- * <p>Maximum key length—127 Unicode characters in UTF-8</p>
293
- * </li>
294
- * <li>
295
- * <p>Maximum value length—255 Unicode characters in UTF-8</p>
296
- * </li>
297
- * <li>
298
- * <p>Tag keys and values are case sensitive.</p>
299
- * </li>
300
- * <li>
301
- * <p>Do not use the <code>aws:</code> prefix in your tag names or values because Amazon Web Services reserves it
302
- * for Amazon Web Services use. You can't edit or delete tag names or values with this
303
- * prefix. Tags with this prefix do not count against your tags per secret limit.</p>
304
- * </li>
305
- * <li>
306
- * <p>If you use your tagging schema across multiple services and resources,
307
- * remember other services might have restrictions on allowed characters. Generally
308
- * allowed characters: letters, spaces, and numbers representable in UTF-8, plus the
309
- * following special characters: + - = . _ : / @.</p>
310
- * </li>
311
- * </ul>
312
- */
313
- Tags?: Tag[];
314
- /**
315
- * <p>(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in
316
- * the parameter.</p>
317
- */
318
- AddReplicaRegions?: ReplicaRegionType[];
319
- /**
320
- * <p>(Optional) If set, the replication overwrites a secret with the same name in the
321
- * destination region.</p>
322
- */
323
- ForceOverwriteReplicaSecret?: boolean;
324
- }
325
- export declare namespace CreateSecretRequest {
326
- /**
327
- * @internal
328
- */
329
- const filterSensitiveLog: (obj: CreateSecretRequest) => any;
330
- }
331
- export declare enum StatusType {
332
- Failed = "Failed",
333
- InProgress = "InProgress",
334
- InSync = "InSync"
335
- }
336
- /**
337
- * <p>A replication object consisting of a <code>RegionReplicationStatus</code> object and includes a Region, KMSKeyId, status, and status message.</p>
338
- */
339
- export interface ReplicationStatusType {
340
- /**
341
- * <p>The Region where replication occurs.</p>
342
- */
343
- Region?: string;
344
- /**
345
- * <p>Can be an <code>ARN</code>, <code>Key ID</code>, or <code>Alias</code>. </p>
346
- */
347
- KmsKeyId?: string;
348
- /**
349
- * <p>The status can be <code>InProgress</code>, <code>Failed</code>, or <code>InSync</code>.</p>
350
- */
351
- Status?: StatusType | string;
352
- /**
353
- * <p>Status message such as "<i>Secret with this name already exists in this
354
- * region</i>".</p>
355
- */
356
- StatusMessage?: string;
357
- /**
358
- * <p>The date that you last accessed the secret in the Region. </p>
359
- */
360
- LastAccessedDate?: Date;
361
- }
362
- export declare namespace ReplicationStatusType {
363
- /**
364
- * @internal
365
- */
366
- const filterSensitiveLog: (obj: ReplicationStatusType) => any;
367
- }
368
- export interface CreateSecretResponse {
369
- /**
370
- * <p>The Amazon Resource Name (ARN) of the secret that you just created.</p>
371
- * <note>
372
- * <p>Secrets Manager automatically adds several random characters to the name at the end of the ARN when
373
- * you initially create a secret. This affects only the ARN and not the actual friendly name.
374
- * This ensures that if you create a new secret with the same name as an old secret that you
375
- * previously deleted, then users with access to the old secret <i>don't</i>
376
- * automatically get access to the new secret because the ARNs are different.</p>
377
- * </note>
378
- */
379
- ARN?: string;
380
- /**
381
- * <p>The friendly name of the secret that you just created.</p>
382
- */
383
- Name?: string;
384
- /**
385
- * <p>The unique identifier associated with the version of the secret you just created.</p>
386
- */
387
- VersionId?: string;
388
- /**
389
- * <p>Describes a list of replication status objects as <code>InProgress</code>, <code>Failed</code> or <code>InSync</code>.</p>
390
- */
391
- ReplicationStatus?: ReplicationStatusType[];
392
- }
393
- export declare namespace CreateSecretResponse {
394
- /**
395
- * @internal
396
- */
397
- const filterSensitiveLog: (obj: CreateSecretResponse) => any;
398
- }
399
- /**
400
- * <p>Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the
401
- * customer master key (CMK) is available, enabled, and not in an invalid state. For more
402
- * information, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a
403
- * Customer Master Key</a>.</p>
404
- */
405
- export interface EncryptionFailure extends __SmithyException, $MetadataBearer {
406
- name: "EncryptionFailure";
407
- $fault: "client";
408
- Message?: string;
409
- }
410
- export declare namespace EncryptionFailure {
411
- /**
412
- * @internal
413
- */
414
- const filterSensitiveLog: (obj: EncryptionFailure) => any;
415
- }
416
- /**
417
- * <p>The request failed because it would exceed one of the Secrets Manager internal limits.</p>
418
- */
419
- export interface LimitExceededException extends __SmithyException, $MetadataBearer {
420
- name: "LimitExceededException";
421
- $fault: "client";
422
- Message?: string;
423
- }
424
- export declare namespace LimitExceededException {
425
- /**
426
- * @internal
427
- */
428
- const filterSensitiveLog: (obj: LimitExceededException) => any;
429
- }
430
- /**
431
- * <p>You provided a resource-based policy with syntax errors.</p>
432
- */
433
- export interface MalformedPolicyDocumentException extends __SmithyException, $MetadataBearer {
434
- name: "MalformedPolicyDocumentException";
435
- $fault: "client";
436
- Message?: string;
437
- }
438
- export declare namespace MalformedPolicyDocumentException {
439
- /**
440
- * @internal
441
- */
442
- const filterSensitiveLog: (obj: MalformedPolicyDocumentException) => any;
443
- }
444
- /**
445
- * <p>The request failed because you did not complete all the prerequisite steps.</p>
446
- */
447
- export interface PreconditionNotMetException extends __SmithyException, $MetadataBearer {
448
- name: "PreconditionNotMetException";
449
- $fault: "client";
450
- Message?: string;
451
- }
452
- export declare namespace PreconditionNotMetException {
453
- /**
454
- * @internal
455
- */
456
- const filterSensitiveLog: (obj: PreconditionNotMetException) => any;
457
- }
458
- /**
459
- * <p>A resource with the ID you requested already exists.</p>
460
- */
461
- export interface ResourceExistsException extends __SmithyException, $MetadataBearer {
462
- name: "ResourceExistsException";
463
- $fault: "client";
464
- Message?: string;
465
- }
466
- export declare namespace ResourceExistsException {
467
- /**
468
- * @internal
469
- */
470
- const filterSensitiveLog: (obj: ResourceExistsException) => any;
471
- }
472
- /**
473
- * <p>Secrets Manager can't decrypt the protected secret text using the provided KMS key. </p>
474
- */
475
- export interface DecryptionFailure extends __SmithyException, $MetadataBearer {
476
- name: "DecryptionFailure";
477
- $fault: "client";
478
- Message?: string;
479
- }
480
- export declare namespace DecryptionFailure {
481
- /**
482
- * @internal
483
- */
484
- const filterSensitiveLog: (obj: DecryptionFailure) => any;
485
- }
486
- export interface DeleteResourcePolicyRequest {
487
- /**
488
- * <p>Specifies the secret that you want to delete the attached resource-based policy for. You
489
- * can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p>
490
- * <note>
491
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
492
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
493
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
494
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
495
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
496
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
497
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
498
- * results. To avoid this situation, we recommend that you don’t create secret names ending
499
- * with a hyphen followed by six characters.</p>
500
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
501
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
502
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
503
- * </note>
504
- */
505
- SecretId: string | undefined;
506
- }
507
- export declare namespace DeleteResourcePolicyRequest {
508
- /**
509
- * @internal
510
- */
511
- const filterSensitiveLog: (obj: DeleteResourcePolicyRequest) => any;
512
- }
513
- export interface DeleteResourcePolicyResponse {
514
- /**
515
- * <p>The ARN of the secret that the resource-based policy was deleted for.</p>
516
- */
517
- ARN?: string;
518
- /**
519
- * <p>The friendly name of the secret that the resource-based policy was deleted for.</p>
520
- */
521
- Name?: string;
522
- }
523
- export declare namespace DeleteResourcePolicyResponse {
524
- /**
525
- * @internal
526
- */
527
- const filterSensitiveLog: (obj: DeleteResourcePolicyResponse) => any;
528
- }
529
- export interface DeleteSecretRequest {
530
- /**
531
- * <p>Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or
532
- * the friendly name of the secret.</p>
533
- * <note>
534
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
535
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
536
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
537
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
538
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
539
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
540
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
541
- * results. To avoid this situation, we recommend that you don’t create secret names ending
542
- * with a hyphen followed by six characters.</p>
543
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
544
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
545
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
546
- * </note>
547
- */
548
- SecretId: string | undefined;
549
- /**
550
- * <p>(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the
551
- * secret. You can't use both this parameter and the <code>ForceDeleteWithoutRecovery</code>
552
- * parameter in the same API call.</p>
553
- * <p>This value can range from 7 to 30 days with a default value of 30.</p>
554
- */
555
- RecoveryWindowInDays?: number;
556
- /**
557
- * <p>(Optional) Specifies that the secret is to be deleted without any recovery window. You
558
- * can't use both this parameter and the <code>RecoveryWindowInDays</code> parameter in the same
559
- * API call.</p>
560
- * <p>An asynchronous background process performs the actual deletion, so there can be a short
561
- * delay before the operation completes. If you write code to delete and then immediately
562
- * recreate a secret with the same name, ensure that your code includes appropriate back off and
563
- * retry logic.</p>
564
- * <important>
565
- * <p>Use this parameter with caution. This parameter causes the operation to skip the normal
566
- * waiting period before the permanent deletion that Amazon Web Services would normally impose with the
567
- * <code>RecoveryWindowInDays</code> parameter. If you delete a secret with the
568
- * <code>ForceDeleteWithouRecovery</code> parameter, then you have no opportunity to recover
569
- * the secret. You lose the secret permanently.</p>
570
- * </important>
571
- * <important>
572
- * <p>If you use this parameter and include a previously deleted or nonexistent secret, the
573
- * operation does not return the error <code>ResourceNotFoundException</code> in order to
574
- * correctly handle retries.</p>
575
- * </important>
576
- */
577
- ForceDeleteWithoutRecovery?: boolean;
578
- }
579
- export declare namespace DeleteSecretRequest {
580
- /**
581
- * @internal
582
- */
583
- const filterSensitiveLog: (obj: DeleteSecretRequest) => any;
584
- }
585
- export interface DeleteSecretResponse {
586
- /**
587
- * <p>The ARN of the secret that is now scheduled for deletion.</p>
588
- */
589
- ARN?: string;
590
- /**
591
- * <p>The friendly name of the secret currently scheduled for deletion.</p>
592
- */
593
- Name?: string;
594
- /**
595
- * <p>The date and time after which this secret can be deleted by Secrets Manager and can no longer be
596
- * restored. This value is the date and time of the delete request plus the number of days
597
- * specified in <code>RecoveryWindowInDays</code>.</p>
598
- */
599
- DeletionDate?: Date;
600
- }
601
- export declare namespace DeleteSecretResponse {
602
- /**
603
- * @internal
604
- */
605
- const filterSensitiveLog: (obj: DeleteSecretResponse) => any;
606
- }
607
- export interface DescribeSecretRequest {
608
- /**
609
- * <p>The identifier of the secret whose details you want to retrieve. You can specify either
610
- * the Amazon Resource Name (ARN) or the friendly name of the secret.</p>
611
- * <note>
612
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
613
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
614
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
615
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
616
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
617
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
618
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
619
- * results. To avoid this situation, we recommend that you don’t create secret names ending
620
- * with a hyphen followed by six characters.</p>
621
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
622
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
623
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
624
- * </note>
625
- */
626
- SecretId: string | undefined;
627
- }
628
- export declare namespace DescribeSecretRequest {
629
- /**
630
- * @internal
631
- */
632
- const filterSensitiveLog: (obj: DescribeSecretRequest) => any;
633
- }
634
- /**
635
- * <p>A structure that defines the rotation configuration for the secret.</p>
636
- */
637
- export interface RotationRulesType {
638
- /**
639
- * <p>Specifies the number of days between automatic scheduled rotations of the secret.</p>
640
- * <p>Secrets Manager schedules the next rotation when the previous
641
- * one is complete. Secrets Manager schedules the date by adding the rotation interval (number of days) to the
642
- * actual date of the last rotation. The service chooses the hour within that 24-hour date window
643
- * randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour
644
- * and influenced by a variety of factors that help distribute load.</p>
645
- */
646
- AutomaticallyAfterDays?: number;
647
- }
648
- export declare namespace RotationRulesType {
649
- /**
650
- * @internal
651
- */
652
- const filterSensitiveLog: (obj: RotationRulesType) => any;
653
- }
654
- export interface DescribeSecretResponse {
655
- /**
656
- * <p>The ARN of the secret.</p>
657
- */
658
- ARN?: string;
659
- /**
660
- * <p>The user-provided friendly name of the secret.</p>
661
- */
662
- Name?: string;
663
- /**
664
- * <p>The user-provided description of the secret.</p>
665
- */
666
- Description?: string;
667
- /**
668
- * <p>The ARN or alias of the Amazon Web Services KMS customer master key (CMK) that's used to encrypt the
669
- * <code>SecretString</code> or <code>SecretBinary</code> fields in each version of the secret.
670
- * If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the
671
- * default Amazon Web Services KMS CMK (the one named <code>awssecretsmanager</code>) for this account.</p>
672
- */
673
- KmsKeyId?: string;
674
- /**
675
- * <p>Specifies whether automatic rotation is enabled for this secret.</p>
676
- * <p>To enable rotation, use <a>RotateSecret</a> with
677
- * <code>AutomaticallyRotateAfterDays</code> set to a value greater than 0. To disable
678
- * rotation, use <a>CancelRotateSecret</a>.</p>
679
- */
680
- RotationEnabled?: boolean;
681
- /**
682
- * <p>The ARN of a Lambda function that's invoked by Secrets Manager to rotate the
683
- * secret either automatically per the schedule or manually by a call to
684
- * <code>RotateSecret</code>.</p>
685
- */
686
- RotationLambdaARN?: string;
687
- /**
688
- * <p>A structure with the rotation configuration for this secret.</p>
689
- */
690
- RotationRules?: RotationRulesType;
691
- /**
692
- * <p>The last date and time that the rotation process for this secret was invoked.</p>
693
- * <p>The most recent date and time that the Secrets Manager rotation process successfully
694
- * completed. If the secret doesn't rotate, Secrets Manager returns a null value.</p>
695
- */
696
- LastRotatedDate?: Date;
697
- /**
698
- * <p>The last date and time that this secret was modified in any way.</p>
699
- */
700
- LastChangedDate?: Date;
701
- /**
702
- * <p>The last date that this secret was accessed. This value is truncated to midnight of the
703
- * date and therefore shows only the date, not the time.</p>
704
- */
705
- LastAccessedDate?: Date;
706
- /**
707
- * <p>This value exists if the secret is scheduled for deletion. Some time after the specified
708
- * date and time, Secrets Manager deletes the secret and all of its versions.</p>
709
- * <p>If a secret is scheduled for deletion, then its details, including the encrypted secret
710
- * information, is not accessible. To cancel a scheduled deletion and restore access, use <a>RestoreSecret</a>.</p>
711
- */
712
- DeletedDate?: Date;
713
- /**
714
- * <p>The list of user-defined tags that are associated with the secret. To add tags to a
715
- * secret, use <a>TagResource</a>. To remove tags, use <a>UntagResource</a>.</p>
716
- */
717
- Tags?: Tag[];
718
- /**
719
- * <p>A list of all of the currently assigned <code>VersionStage</code> staging labels and the
720
- * <code>VersionId</code> that each is attached to. Staging labels are used to keep track of
721
- * the different versions during the rotation process.</p>
722
- * <note>
723
- * <p>A version that does not have any staging labels attached is considered deprecated and
724
- * subject to deletion. Such versions are not included in this list.</p>
725
- * </note>
726
- */
727
- VersionIdsToStages?: {
728
- [key: string]: string[];
729
- };
730
- /**
731
- * <p>Returns the name of the service that created this secret.</p>
732
- */
733
- OwningService?: string;
734
- /**
735
- * <p>The date you created the secret.</p>
736
- */
737
- CreatedDate?: Date;
738
- /**
739
- * <p>Specifies the primary region for secret replication. </p>
740
- */
741
- PrimaryRegion?: string;
742
- /**
743
- * <p>Describes a list of replication status objects as <code>InProgress</code>, <code>Failed</code> or <code>InSync</code>.<code>P</code>
744
- * </p>
745
- */
746
- ReplicationStatus?: ReplicationStatusType[];
747
- }
748
- export declare namespace DescribeSecretResponse {
749
- /**
750
- * @internal
751
- */
752
- const filterSensitiveLog: (obj: DescribeSecretResponse) => any;
753
- }
754
- export declare type FilterNameStringType = "all" | "description" | "name" | "primary-region" | "tag-key" | "tag-value";
755
- /**
756
- * <p>Allows you to add filters when you use the search function in Secrets Manager.</p>
757
- */
758
- export interface Filter {
759
- /**
760
- * <p>Filters your list of secrets by a specific key.</p>
761
- */
762
- Key?: FilterNameStringType | string;
763
- /**
764
- * <p>Filters your list of secrets by a specific value.</p>
765
- * <p>You can prefix your search value with an exclamation mark (<code>!</code>) in order to perform negation filters. </p>
766
- */
767
- Values?: string[];
768
- }
769
- export declare namespace Filter {
770
- /**
771
- * @internal
772
- */
773
- const filterSensitiveLog: (obj: Filter) => any;
774
- }
775
- export interface GetRandomPasswordRequest {
776
- /**
777
- * <p>The desired length of the generated password. The default value if you do not include this
778
- * parameter is 32 characters.</p>
779
- */
780
- PasswordLength?: number;
781
- /**
782
- * <p>A string that includes characters that should not be included in the generated password.
783
- * The default is that all characters from the included sets can be used.</p>
784
- */
785
- ExcludeCharacters?: string;
786
- /**
787
- * <p>Specifies that the generated password should not include digits. The default if you do not
788
- * include this switch parameter is that digits can be included.</p>
789
- */
790
- ExcludeNumbers?: boolean;
791
- /**
792
- * <p>Specifies that the generated password should not include punctuation characters. The
793
- * default if you do not include this switch parameter is that punctuation characters can be
794
- * included.</p>
795
- * <p>The following are the punctuation characters that <i>can</i> be included in
796
- * the generated password if you don't explicitly exclude them with
797
- * <code>ExcludeCharacters</code> or <code>ExcludePunctuation</code>:</p>
798
- * <p>
799
- * <code>! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | }
800
- * ~</code>
801
- * </p>
802
- */
803
- ExcludePunctuation?: boolean;
804
- /**
805
- * <p>Specifies that the generated password should not include uppercase letters. The default if
806
- * you do not include this switch parameter is that uppercase letters can be included.</p>
807
- */
808
- ExcludeUppercase?: boolean;
809
- /**
810
- * <p>Specifies that the generated password should not include lowercase letters. The default if
811
- * you do not include this switch parameter is that lowercase letters can be included.</p>
812
- */
813
- ExcludeLowercase?: boolean;
814
- /**
815
- * <p>Specifies that the generated password can include the space character. The default if you
816
- * do not include this switch parameter is that the space character is not included.</p>
817
- */
818
- IncludeSpace?: boolean;
819
- /**
820
- * <p>A boolean value that specifies whether the generated password must include at least one of
821
- * every allowed character type. The default value is <code>True</code> and the operation
822
- * requires at least one of every character type.</p>
823
- */
824
- RequireEachIncludedType?: boolean;
825
- }
826
- export declare namespace GetRandomPasswordRequest {
827
- /**
828
- * @internal
829
- */
830
- const filterSensitiveLog: (obj: GetRandomPasswordRequest) => any;
831
- }
832
- export interface GetRandomPasswordResponse {
833
- /**
834
- * <p>A string with the generated password.</p>
835
- */
836
- RandomPassword?: string;
837
- }
838
- export declare namespace GetRandomPasswordResponse {
839
- /**
840
- * @internal
841
- */
842
- const filterSensitiveLog: (obj: GetRandomPasswordResponse) => any;
843
- }
844
- export interface GetResourcePolicyRequest {
845
- /**
846
- * <p>Specifies the secret that you want to retrieve the attached resource-based policy for. You
847
- * can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p>
848
- * <note>
849
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
850
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
851
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
852
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
853
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
854
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
855
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
856
- * results. To avoid this situation, we recommend that you don’t create secret names ending
857
- * with a hyphen followed by six characters.</p>
858
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
859
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
860
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
861
- * </note>
862
- */
863
- SecretId: string | undefined;
864
- }
865
- export declare namespace GetResourcePolicyRequest {
866
- /**
867
- * @internal
868
- */
869
- const filterSensitiveLog: (obj: GetResourcePolicyRequest) => any;
870
- }
871
- export interface GetResourcePolicyResponse {
872
- /**
873
- * <p>The ARN of the secret that the resource-based policy was retrieved for.</p>
874
- */
875
- ARN?: string;
876
- /**
877
- * <p>The friendly name of the secret that the resource-based policy was retrieved for.</p>
878
- */
879
- Name?: string;
880
- /**
881
- * <p>A JSON-formatted string that describes the permissions that are associated with the
882
- * attached secret. These permissions are combined with any permissions that are associated with
883
- * the user or role that attempts to access this secret. The combined permissions specify who can
884
- * access the secret and what actions they can perform. For more information, see <a href="http://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication and Access Control for
885
- * Amazon Web Services Secrets Manager</a> in the <i>Amazon Web Services Secrets Manager User Guide</i>.</p>
886
- */
887
- ResourcePolicy?: string;
888
- }
889
- export declare namespace GetResourcePolicyResponse {
890
- /**
891
- * @internal
892
- */
893
- const filterSensitiveLog: (obj: GetResourcePolicyResponse) => any;
894
- }
895
- export interface GetSecretValueRequest {
896
- /**
897
- * <p>Specifies the secret containing the version that you want to retrieve. You can specify
898
- * either the Amazon Resource Name (ARN) or the friendly name of the secret.</p>
899
- * <note>
900
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
901
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
902
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
903
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
904
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
905
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
906
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
907
- * results. To avoid this situation, we recommend that you don’t create secret names ending
908
- * with a hyphen followed by six characters.</p>
909
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
910
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
911
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
912
- * </note>
913
- */
914
- SecretId: string | undefined;
915
- /**
916
- * <p>Specifies the unique identifier of the version of the secret that you want to retrieve. If
917
- * you specify both this parameter and <code>VersionStage</code>, the two parameters must refer
918
- * to the same secret version. If you don't specify either a <code>VersionStage</code> or
919
- * <code>VersionId</code> then the default is to perform the operation on the version with the
920
- * <code>VersionStage</code> value of <code>AWSCURRENT</code>.</p>
921
- * <p>This value is typically a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value with
922
- * 32 hexadecimal digits.</p>
923
- */
924
- VersionId?: string;
925
- /**
926
- * <p>Specifies the secret version that you want to retrieve by the staging label attached to
927
- * the version.</p>
928
- * <p>Staging labels are used to keep track of different versions during the rotation process.
929
- * If you specify both this parameter and <code>VersionId</code>, the two parameters must refer
930
- * to the same secret version . If you don't specify either a <code>VersionStage</code> or
931
- * <code>VersionId</code>, then the default is to perform the operation on the version with the
932
- * <code>VersionStage</code> value of <code>AWSCURRENT</code>.</p>
933
- */
934
- VersionStage?: string;
935
- }
936
- export declare namespace GetSecretValueRequest {
937
- /**
938
- * @internal
939
- */
940
- const filterSensitiveLog: (obj: GetSecretValueRequest) => any;
941
- }
942
- export interface GetSecretValueResponse {
943
- /**
944
- * <p>The ARN of the secret.</p>
945
- */
946
- ARN?: string;
947
- /**
948
- * <p>The friendly name of the secret.</p>
949
- */
950
- Name?: string;
951
- /**
952
- * <p>The unique identifier of this version of the secret.</p>
953
- */
954
- VersionId?: string;
955
- /**
956
- * <p>The decrypted part of the protected secret information that was originally provided as
957
- * binary data in the form of a byte array. The response parameter represents the binary data as
958
- * a <a href="https://tools.ietf.org/html/rfc4648#section-4">base64-encoded</a>
959
- * string.</p>
960
- * <p>This parameter is not used if the secret is created by the Secrets Manager console.</p>
961
- * <p>If you store custom information in this field of the secret, then you must code your
962
- * Lambda rotation function to parse and interpret whatever you store in the
963
- * <code>SecretString</code> or <code>SecretBinary</code> fields.</p>
964
- */
965
- SecretBinary?: Uint8Array;
966
- /**
967
- * <p>The decrypted part of the protected secret information that was originally provided as a
968
- * string.</p>
969
- * <p>If you create this secret by using the Secrets Manager console then only the
970
- * <code>SecretString</code> parameter contains data. Secrets Manager stores the information as a
971
- * JSON structure of key/value pairs that the Lambda rotation function knows how to parse.</p>
972
- * <p>If you store custom information in the secret by using the <a>CreateSecret</a>,
973
- * <a>UpdateSecret</a>, or <a>PutSecretValue</a> API operations instead
974
- * of the Secrets Manager console, or by using the <b>Other secret type</b> in
975
- * the console, then you must code your Lambda rotation function to parse and interpret those
976
- * values.</p>
977
- */
978
- SecretString?: string;
979
- /**
980
- * <p>A list of all of the staging labels currently attached to this version of the
981
- * secret.</p>
982
- */
983
- VersionStages?: string[];
984
- /**
985
- * <p>The date and time that this version of the secret was created.</p>
986
- */
987
- CreatedDate?: Date;
988
- }
989
- export declare namespace GetSecretValueResponse {
990
- /**
991
- * @internal
992
- */
993
- const filterSensitiveLog: (obj: GetSecretValueResponse) => any;
994
- }
995
- /**
996
- * <p>You provided an invalid <code>NextToken</code> value.</p>
997
- */
998
- export interface InvalidNextTokenException extends __SmithyException, $MetadataBearer {
999
- name: "InvalidNextTokenException";
1000
- $fault: "client";
1001
- Message?: string;
1002
- }
1003
- export declare namespace InvalidNextTokenException {
1004
- /**
1005
- * @internal
1006
- */
1007
- const filterSensitiveLog: (obj: InvalidNextTokenException) => any;
1008
- }
1009
- export declare enum SortOrderType {
1010
- asc = "asc",
1011
- desc = "desc"
1012
- }
1013
- export interface ListSecretsRequest {
1014
- /**
1015
- * <p>(Optional) Limits the number of results you want to include in
1016
- * the response. If you don't include this parameter, it defaults to a value that's
1017
- * specific to the operation. If additional items exist beyond the maximum you specify, the
1018
- * <code>NextToken</code> response element is present and has a value (isn't null). Include
1019
- * that value as the <code>NextToken</code> request parameter in the next call to the operation to
1020
- * get the next part of the results. Note that Secrets Manager might return fewer results than the maximum
1021
- * even when there are more results available. You should check <code>NextToken</code> after every
1022
- * operation to ensure that you receive all of the results.</p>
1023
- */
1024
- MaxResults?: number;
1025
- /**
1026
- * <p>(Optional) Use this parameter in a request if you receive a
1027
- * <code>NextToken</code> response in a previous request indicating there's more
1028
- * output available. In a subsequent call, set it to the value of the previous call
1029
- * <code>NextToken</code> response to indicate where the output should continue from.</p>
1030
- */
1031
- NextToken?: string;
1032
- /**
1033
- * <p>Lists the secret request filters.</p>
1034
- */
1035
- Filters?: Filter[];
1036
- /**
1037
- * <p>Lists secrets in the requested order. </p>
1038
- */
1039
- SortOrder?: SortOrderType | string;
1040
- }
1041
- export declare namespace ListSecretsRequest {
1042
- /**
1043
- * @internal
1044
- */
1045
- const filterSensitiveLog: (obj: ListSecretsRequest) => any;
1046
- }
1047
- /**
1048
- * <p>A structure that contains the details about a secret. It does not include the encrypted
1049
- * <code>SecretString</code> and <code>SecretBinary</code> values. To get those values, use the
1050
- * <a>GetSecretValue</a> operation.</p>
1051
- */
1052
- export interface SecretListEntry {
1053
- /**
1054
- * <p>The Amazon Resource Name (ARN) of the secret.</p>
1055
- * <p>For more information about ARNs in Secrets Manager, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#iam-resources">Policy Resources</a> in the
1056
- * <i>Amazon Web Services Secrets Manager User Guide</i>.</p>
1057
- */
1058
- ARN?: string;
1059
- /**
1060
- * <p>The friendly name of the secret. You can use forward slashes in the name to represent a
1061
- * path hierarchy. For example, <code>/prod/databases/dbserver1</code> could represent the secret
1062
- * for a server named <code>dbserver1</code> in the folder <code>databases</code> in the folder
1063
- * <code>prod</code>. </p>
1064
- */
1065
- Name?: string;
1066
- /**
1067
- * <p>The user-provided description of the secret.</p>
1068
- */
1069
- Description?: string;
1070
- /**
1071
- * <p>The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the
1072
- * <code>SecretString</code> and <code>SecretBinary</code> fields in each version of the
1073
- * secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with
1074
- * the default KMS CMK, the key named <code>awssecretsmanager</code>, for this account.</p>
1075
- */
1076
- KmsKeyId?: string;
1077
- /**
1078
- * <p>Indicates whether automatic, scheduled rotation is enabled for this secret.</p>
1079
- */
1080
- RotationEnabled?: boolean;
1081
- /**
1082
- * <p>The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the
1083
- * secret either automatically per the schedule or manually by a call to <a>RotateSecret</a>.</p>
1084
- */
1085
- RotationLambdaARN?: string;
1086
- /**
1087
- * <p>A structure that defines the rotation configuration for the secret.</p>
1088
- */
1089
- RotationRules?: RotationRulesType;
1090
- /**
1091
- * <p>The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret hasn't ever rotated.</p>
1092
- */
1093
- LastRotatedDate?: Date;
1094
- /**
1095
- * <p>The last date and time that this secret was modified in any way.</p>
1096
- */
1097
- LastChangedDate?: Date;
1098
- /**
1099
- * <p>The last date that this secret was accessed. This value is truncated to midnight of the
1100
- * date and therefore shows only the date, not the time.</p>
1101
- */
1102
- LastAccessedDate?: Date;
1103
- /**
1104
- * <p>The date and time the deletion of the secret occurred. Not present on active secrets. The
1105
- * secret can be recovered until the number of days in the recovery window has passed, as
1106
- * specified in the <code>RecoveryWindowInDays</code> parameter of the <a>DeleteSecret</a> operation.</p>
1107
- */
1108
- DeletedDate?: Date;
1109
- /**
1110
- * <p>The list of user-defined tags associated with the secret. To add tags to a
1111
- * secret, use <a>TagResource</a>. To remove tags, use <a>UntagResource</a>.</p>
1112
- */
1113
- Tags?: Tag[];
1114
- /**
1115
- * <p>A list of all of the currently assigned <code>SecretVersionStage</code> staging labels and
1116
- * the <code>SecretVersionId</code> attached to each one. Staging labels are used to keep
1117
- * track of the different versions during the rotation process.</p>
1118
- * <note>
1119
- * <p>A version that does not have any <code>SecretVersionStage</code> is considered
1120
- * deprecated and subject to deletion. Such versions are not included in this list.</p>
1121
- * </note>
1122
- */
1123
- SecretVersionsToStages?: {
1124
- [key: string]: string[];
1125
- };
1126
- /**
1127
- * <p>Returns the name of the service that created the secret.</p>
1128
- */
1129
- OwningService?: string;
1130
- /**
1131
- * <p>The date and time when a secret was created.</p>
1132
- */
1133
- CreatedDate?: Date;
1134
- /**
1135
- * <p>The Region where Secrets Manager originated the secret.</p>
1136
- */
1137
- PrimaryRegion?: string;
1138
- }
1139
- export declare namespace SecretListEntry {
1140
- /**
1141
- * @internal
1142
- */
1143
- const filterSensitiveLog: (obj: SecretListEntry) => any;
1144
- }
1145
- export interface ListSecretsResponse {
1146
- /**
1147
- * <p>A list of the secrets in the account.</p>
1148
- */
1149
- SecretList?: SecretListEntry[];
1150
- /**
1151
- * <p>If present in the response, this value indicates that
1152
- * there's more output available than included in the current response. This can
1153
- * occur even when the response includes no values at all, such as when you ask for a filtered view
1154
- * of a very long list. Use this value in the <code>NextToken</code> request parameter in a
1155
- * subsequent call to the operation to continue processing and get the next part of the output. You
1156
- * should repeat this until the <code>NextToken</code> response element comes back empty (as
1157
- * <code>null</code>).</p>
1158
- */
1159
- NextToken?: string;
1160
- }
1161
- export declare namespace ListSecretsResponse {
1162
- /**
1163
- * @internal
1164
- */
1165
- const filterSensitiveLog: (obj: ListSecretsResponse) => any;
1166
- }
1167
- export interface ListSecretVersionIdsRequest {
1168
- /**
1169
- * <p>The identifier for the secret containing the versions you want to list. You can specify
1170
- * either the Amazon Resource Name (ARN) or the friendly name of the secret.</p>
1171
- * <note>
1172
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
1173
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
1174
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
1175
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
1176
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
1177
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
1178
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
1179
- * results. To avoid this situation, we recommend that you don’t create secret names ending
1180
- * with a hyphen followed by six characters.</p>
1181
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
1182
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
1183
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
1184
- * </note>
1185
- */
1186
- SecretId: string | undefined;
1187
- /**
1188
- * <p>(Optional) Limits the number of results you want to include in
1189
- * the response. If you don't include this parameter, it defaults to a value that's
1190
- * specific to the operation. If additional items exist beyond the maximum you specify, the
1191
- * <code>NextToken</code> response element is present and has a value (isn't null). Include
1192
- * that value as the <code>NextToken</code> request parameter in the next call to the operation to
1193
- * get the next part of the results. Note that Secrets Manager might return fewer results than the maximum
1194
- * even when there are more results available. You should check <code>NextToken</code> after every
1195
- * operation to ensure that you receive all of the results.</p>
1196
- */
1197
- MaxResults?: number;
1198
- /**
1199
- * <p>(Optional) Use this parameter in a request if you receive a
1200
- * <code>NextToken</code> response in a previous request indicating there's more
1201
- * output available. In a subsequent call, set it to the value of the previous call
1202
- * <code>NextToken</code> response to indicate where the output should continue from.</p>
1203
- */
1204
- NextToken?: string;
1205
- /**
1206
- * <p>(Optional) Specifies that you want the results to include versions that do not have any
1207
- * staging labels attached to them. Such versions are considered deprecated and are subject to
1208
- * deletion by Secrets Manager as needed.</p>
1209
- */
1210
- IncludeDeprecated?: boolean;
1211
- }
1212
- export declare namespace ListSecretVersionIdsRequest {
1213
- /**
1214
- * @internal
1215
- */
1216
- const filterSensitiveLog: (obj: ListSecretVersionIdsRequest) => any;
1217
- }
1218
- /**
1219
- * <p>A structure that contains information about one version of a secret.</p>
1220
- */
1221
- export interface SecretVersionsListEntry {
1222
- /**
1223
- * <p>The unique version identifier of this version of the secret.</p>
1224
- */
1225
- VersionId?: string;
1226
- /**
1227
- * <p>An array of staging labels that are currently associated with this version of the
1228
- * secret.</p>
1229
- */
1230
- VersionStages?: string[];
1231
- /**
1232
- * <p>The date that this version of the secret was last accessed. Note that the resolution of
1233
- * this field is at the date level and does not include the time.</p>
1234
- */
1235
- LastAccessedDate?: Date;
1236
- /**
1237
- * <p>The date and time this version of the secret was created.</p>
1238
- */
1239
- CreatedDate?: Date;
1240
- /**
1241
- * <p>The KMS keys used to encrypt the secret version.</p>
1242
- */
1243
- KmsKeyIds?: string[];
1244
- }
1245
- export declare namespace SecretVersionsListEntry {
1246
- /**
1247
- * @internal
1248
- */
1249
- const filterSensitiveLog: (obj: SecretVersionsListEntry) => any;
1250
- }
1251
- export interface ListSecretVersionIdsResponse {
1252
- /**
1253
- * <p>The list of the currently available versions of the specified secret.</p>
1254
- */
1255
- Versions?: SecretVersionsListEntry[];
1256
- /**
1257
- * <p>If present in the response, this value indicates that
1258
- * there's more output available than included in the current response. This can
1259
- * occur even when the response includes no values at all, such as when you ask for a filtered view
1260
- * of a very long list. Use this value in the <code>NextToken</code> request parameter in a
1261
- * subsequent call to the operation to continue processing and get the next part of the output. You
1262
- * should repeat this until the <code>NextToken</code> response element comes back empty (as
1263
- * <code>null</code>).</p>
1264
- */
1265
- NextToken?: string;
1266
- /**
1267
- * <p>The Amazon Resource Name (ARN) for the secret.</p>
1268
- * <note>
1269
- * <p>Secrets Manager automatically adds several random characters to the name at the end of the ARN when
1270
- * you initially create a secret. This affects only the ARN and not the actual friendly name.
1271
- * This ensures that if you create a new secret with the same name as an old secret that you
1272
- * previously deleted, then users with access to the old secret <i>don't</i>
1273
- * automatically get access to the new secret because the ARNs are different.</p>
1274
- * </note>
1275
- */
1276
- ARN?: string;
1277
- /**
1278
- * <p>The friendly name of the secret.</p>
1279
- */
1280
- Name?: string;
1281
- }
1282
- export declare namespace ListSecretVersionIdsResponse {
1283
- /**
1284
- * @internal
1285
- */
1286
- const filterSensitiveLog: (obj: ListSecretVersionIdsResponse) => any;
1287
- }
1288
- /**
1289
- * <p>The BlockPublicPolicy parameter is set to true and the resource policy did not prevent broad access to the secret.</p>
1290
- */
1291
- export interface PublicPolicyException extends __SmithyException, $MetadataBearer {
1292
- name: "PublicPolicyException";
1293
- $fault: "client";
1294
- Message?: string;
1295
- }
1296
- export declare namespace PublicPolicyException {
1297
- /**
1298
- * @internal
1299
- */
1300
- const filterSensitiveLog: (obj: PublicPolicyException) => any;
1301
- }
1302
- export interface PutResourcePolicyRequest {
1303
- /**
1304
- * <p>Specifies the secret that you want to attach the resource-based policy. You can specify
1305
- * either the ARN or the friendly name of the secret.</p>
1306
- * <note>
1307
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
1308
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
1309
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
1310
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
1311
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
1312
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
1313
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
1314
- * results. To avoid this situation, we recommend that you don’t create secret names ending
1315
- * with a hyphen followed by six characters.</p>
1316
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
1317
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
1318
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
1319
- * </note>
1320
- */
1321
- SecretId: string | undefined;
1322
- /**
1323
- * <p>A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services
1324
- * resource-based policy. The policy in the string identifies who can access or manage this
1325
- * secret and its versions. For information on how to format a JSON parameter for the various
1326
- * command line tool environments, see <a href="http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json">Using
1327
- * JSON for Parameters</a> in the <i>CLI User Guide</i>.</p>
1328
- */
1329
- ResourcePolicy: string | undefined;
1330
- /**
1331
- * <p>(Optional) If you set the parameter, <code>BlockPublicPolicy</code> to true, then you
1332
- * block resource-based policies that allow broad access to the secret.</p>
1333
- */
1334
- BlockPublicPolicy?: boolean;
1335
- }
1336
- export declare namespace PutResourcePolicyRequest {
1337
- /**
1338
- * @internal
1339
- */
1340
- const filterSensitiveLog: (obj: PutResourcePolicyRequest) => any;
1341
- }
1342
- export interface PutResourcePolicyResponse {
1343
- /**
1344
- * <p>The ARN of the secret retrieved by the resource-based policy.</p>
1345
- */
1346
- ARN?: string;
1347
- /**
1348
- * <p>The friendly name of the secret retrieved by the resource-based policy.</p>
1349
- */
1350
- Name?: string;
1351
- }
1352
- export declare namespace PutResourcePolicyResponse {
1353
- /**
1354
- * @internal
1355
- */
1356
- const filterSensitiveLog: (obj: PutResourcePolicyResponse) => any;
1357
- }
1358
- export interface PutSecretValueRequest {
1359
- /**
1360
- * <p>Specifies the secret to which you want to add a new version. You can specify either the
1361
- * Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already
1362
- * exist.</p>
1363
- * <note>
1364
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
1365
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
1366
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
1367
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
1368
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
1369
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
1370
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
1371
- * results. To avoid this situation, we recommend that you don’t create secret names ending
1372
- * with a hyphen followed by six characters.</p>
1373
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
1374
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
1375
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
1376
- * </note>
1377
- */
1378
- SecretId: string | undefined;
1379
- /**
1380
- * <p>(Optional) Specifies a unique identifier for the new version of the secret. </p>
1381
- * <note>
1382
- * <p>If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can
1383
- * leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that
1384
- * in the request. If you don't use the SDK and instead generate a raw HTTP request to the
1385
- * Secrets Manager service endpoint, then you must generate a <code>ClientRequestToken</code> yourself
1386
- * for new versions and include that value in the request. </p>
1387
- * </note>
1388
- * <p>This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental
1389
- * creation of duplicate versions if there are failures and retries during the Lambda rotation
1390
- * function's processing. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value to
1391
- * ensure uniqueness within the specified secret. </p>
1392
- * <ul>
1393
- * <li>
1394
- * <p>If the <code>ClientRequestToken</code> value isn't already associated with a version
1395
- * of the secret then a new version of the secret is created. </p>
1396
- * </li>
1397
- * <li>
1398
- * <p>If a version with this value already exists and that version's
1399
- * <code>SecretString</code> or <code>SecretBinary</code> values are the same as those in
1400
- * the request then the request is ignored (the operation is idempotent). </p>
1401
- * </li>
1402
- * <li>
1403
- * <p>If a version with this value already exists and the version of the
1404
- * <code>SecretString</code> and <code>SecretBinary</code> values are different from those
1405
- * in the request then the request fails because you cannot modify an existing secret
1406
- * version. You can only create new versions to store new secret values.</p>
1407
- * </li>
1408
- * </ul>
1409
- * <p>This value becomes the <code>VersionId</code> of the new version.</p>
1410
- */
1411
- ClientRequestToken?: string;
1412
- /**
1413
- * <p>(Optional) Specifies binary data that you want to encrypt and store in the new version of
1414
- * the secret. To use this parameter in the command-line tools, we recommend that you store your
1415
- * binary data in a file and then use the appropriate technique for your tool to pass the
1416
- * contents of the file as a parameter. Either <code>SecretBinary</code> or
1417
- * <code>SecretString</code> must have a value, but not both. They cannot both be empty.</p>
1418
- *
1419
- * <p>This parameter is not accessible if the secret using the Secrets Manager console.</p>
1420
- * <p></p>
1421
- */
1422
- SecretBinary?: Uint8Array;
1423
- /**
1424
- * <p>(Optional) Specifies text data that you want to encrypt and store in this new version of
1425
- * the secret. Either <code>SecretString</code> or <code>SecretBinary</code> must have a value,
1426
- * but not both. They cannot both be empty.</p>
1427
- *
1428
- * <p>If you create this secret by using the Secrets Manager console then Secrets Manager puts the
1429
- * protected secret text in only the <code>SecretString</code> parameter. The Secrets Manager console
1430
- * stores the information as a JSON structure of key/value pairs that the default Lambda rotation
1431
- * function knows how to parse.</p>
1432
- * <p>For storing multiple values, we recommend that you use a JSON text string argument and
1433
- * specify key/value pairs. For information on how to format a JSON parameter for the various
1434
- * command line tool environments, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json">Using JSON for
1435
- * Parameters</a> in the <i>CLI User Guide</i>.</p>
1436
- * <p> For example:</p>
1437
- * <p>
1438
- * <code>[{"username":"bob"},{"password":"abc123xyz456"}]</code>
1439
- * </p>
1440
- * <p>If your command-line tool or SDK requires quotation marks around the parameter, you should
1441
- * use single quotes to avoid confusion with the double quotes required in the JSON text.</p>
1442
- */
1443
- SecretString?: string;
1444
- /**
1445
- * <p>(Optional) Specifies a list of staging labels that are attached to this version of the
1446
- * secret. These staging labels are used to track the versions through the rotation process by
1447
- * the Lambda rotation function.</p>
1448
- * <p>A staging label must be unique to a single version of the secret. If you specify a staging
1449
- * label that's already associated with a different version of the same secret then that staging
1450
- * label is automatically removed from the other version and attached to this version.</p>
1451
- * <p>If you do not specify a value for <code>VersionStages</code> then Secrets Manager automatically
1452
- * moves the staging label <code>AWSCURRENT</code> to this new version.</p>
1453
- */
1454
- VersionStages?: string[];
1455
- }
1456
- export declare namespace PutSecretValueRequest {
1457
- /**
1458
- * @internal
1459
- */
1460
- const filterSensitiveLog: (obj: PutSecretValueRequest) => any;
1461
- }
1462
- export interface PutSecretValueResponse {
1463
- /**
1464
- * <p>The Amazon Resource Name (ARN) for the secret for which you just created a version.</p>
1465
- */
1466
- ARN?: string;
1467
- /**
1468
- * <p>The friendly name of the secret for which you just created or updated a version.</p>
1469
- */
1470
- Name?: string;
1471
- /**
1472
- * <p>The unique identifier of the version of the secret you just created or updated.</p>
1473
- */
1474
- VersionId?: string;
1475
- /**
1476
- * <p>The list of staging labels that are currently attached to this version of the secret.
1477
- * Staging labels are used to track a version as it progresses through the secret rotation
1478
- * process.</p>
1479
- */
1480
- VersionStages?: string[];
1481
- }
1482
- export declare namespace PutSecretValueResponse {
1483
- /**
1484
- * @internal
1485
- */
1486
- const filterSensitiveLog: (obj: PutSecretValueResponse) => any;
1487
- }
1488
- export interface RemoveRegionsFromReplicationRequest {
1489
- /**
1490
- * <p>Remove a secret by <code>SecretId</code> from replica Regions.</p>
1491
- */
1492
- SecretId: string | undefined;
1493
- /**
1494
- * <p>Remove replication from specific Regions.</p>
1495
- */
1496
- RemoveReplicaRegions: string[] | undefined;
1497
- }
1498
- export declare namespace RemoveRegionsFromReplicationRequest {
1499
- /**
1500
- * @internal
1501
- */
1502
- const filterSensitiveLog: (obj: RemoveRegionsFromReplicationRequest) => any;
1503
- }
1504
- export interface RemoveRegionsFromReplicationResponse {
1505
- /**
1506
- * <p>The secret <code>ARN</code> removed from replication regions.</p>
1507
- */
1508
- ARN?: string;
1509
- /**
1510
- * <p>Describes the remaining replication status after you remove regions from the replication list.</p>
1511
- */
1512
- ReplicationStatus?: ReplicationStatusType[];
1513
- }
1514
- export declare namespace RemoveRegionsFromReplicationResponse {
1515
- /**
1516
- * @internal
1517
- */
1518
- const filterSensitiveLog: (obj: RemoveRegionsFromReplicationResponse) => any;
1519
- }
1520
- export interface ReplicateSecretToRegionsRequest {
1521
- /**
1522
- * <p>Use the <code>Secret Id</code> to replicate a secret to regions.</p>
1523
- */
1524
- SecretId: string | undefined;
1525
- /**
1526
- * <p>Add Regions to replicate the secret.</p>
1527
- */
1528
- AddReplicaRegions: ReplicaRegionType[] | undefined;
1529
- /**
1530
- * <p>(Optional) If set, Secrets Manager replication overwrites a secret with the same name in the
1531
- * destination region.</p>
1532
- */
1533
- ForceOverwriteReplicaSecret?: boolean;
1534
- }
1535
- export declare namespace ReplicateSecretToRegionsRequest {
1536
- /**
1537
- * @internal
1538
- */
1539
- const filterSensitiveLog: (obj: ReplicateSecretToRegionsRequest) => any;
1540
- }
1541
- export interface ReplicateSecretToRegionsResponse {
1542
- /**
1543
- * <p>Replicate a secret based on the <code>ReplicaRegionType</code>> consisting of a
1544
- * Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias. </p>
1545
- */
1546
- ARN?: string;
1547
- /**
1548
- * <p>Describes the secret replication status as <code>PENDING</code>, <code>SUCCESS</code> or <code>FAIL</code>.</p>
1549
- */
1550
- ReplicationStatus?: ReplicationStatusType[];
1551
- }
1552
- export declare namespace ReplicateSecretToRegionsResponse {
1553
- /**
1554
- * @internal
1555
- */
1556
- const filterSensitiveLog: (obj: ReplicateSecretToRegionsResponse) => any;
1557
- }
1558
- export interface RestoreSecretRequest {
1559
- /**
1560
- * <p>Specifies the secret that you want to restore from a previously scheduled deletion. You
1561
- * can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p>
1562
- * <note>
1563
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
1564
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
1565
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
1566
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
1567
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
1568
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
1569
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
1570
- * results. To avoid this situation, we recommend that you don’t create secret names ending
1571
- * with a hyphen followed by six characters.</p>
1572
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
1573
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
1574
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
1575
- * </note>
1576
- */
1577
- SecretId: string | undefined;
1578
- }
1579
- export declare namespace RestoreSecretRequest {
1580
- /**
1581
- * @internal
1582
- */
1583
- const filterSensitiveLog: (obj: RestoreSecretRequest) => any;
1584
- }
1585
- export interface RestoreSecretResponse {
1586
- /**
1587
- * <p>The ARN of the secret that was restored.</p>
1588
- */
1589
- ARN?: string;
1590
- /**
1591
- * <p>The friendly name of the secret that was restored.</p>
1592
- */
1593
- Name?: string;
1594
- }
1595
- export declare namespace RestoreSecretResponse {
1596
- /**
1597
- * @internal
1598
- */
1599
- const filterSensitiveLog: (obj: RestoreSecretResponse) => any;
1600
- }
1601
- export interface RotateSecretRequest {
1602
- /**
1603
- * <p>Specifies the secret that you want to rotate. You can specify either the Amazon Resource
1604
- * Name (ARN) or the friendly name of the secret.</p>
1605
- * <note>
1606
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
1607
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
1608
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
1609
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
1610
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
1611
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
1612
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
1613
- * results. To avoid this situation, we recommend that you don’t create secret names ending
1614
- * with a hyphen followed by six characters.</p>
1615
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
1616
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
1617
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
1618
- * </note>
1619
- */
1620
- SecretId: string | undefined;
1621
- /**
1622
- * <p>(Optional) Specifies a unique identifier for the new version of the secret that helps
1623
- * ensure idempotency. </p>
1624
- * <p>If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can
1625
- * leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that
1626
- * in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP
1627
- * request to the Secrets Manager service endpoint, then you must generate a
1628
- * <code>ClientRequestToken</code> yourself for new versions and include that value in the
1629
- * request.</p>
1630
- * <p>You only need to specify your own value if you implement your own retry logic and want to
1631
- * ensure that a given secret is not created twice. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value to
1632
- * ensure uniqueness within the specified secret. </p>
1633
- * <p>Secrets Manager uses this value to prevent the accidental creation of duplicate versions if
1634
- * there are failures and retries during the function's processing. This value becomes the
1635
- * <code>VersionId</code> of the new version.</p>
1636
- */
1637
- ClientRequestToken?: string;
1638
- /**
1639
- * <p>(Optional) Specifies the ARN of the Lambda function that can rotate the secret.</p>
1640
- */
1641
- RotationLambdaARN?: string;
1642
- /**
1643
- * <p>A structure that defines the rotation configuration for this secret.</p>
1644
- */
1645
- RotationRules?: RotationRulesType;
1646
- }
1647
- export declare namespace RotateSecretRequest {
1648
- /**
1649
- * @internal
1650
- */
1651
- const filterSensitiveLog: (obj: RotateSecretRequest) => any;
1652
- }
1653
- export interface RotateSecretResponse {
1654
- /**
1655
- * <p>The ARN of the secret.</p>
1656
- */
1657
- ARN?: string;
1658
- /**
1659
- * <p>The friendly name of the secret.</p>
1660
- */
1661
- Name?: string;
1662
- /**
1663
- * <p>The ID of the new version of the secret created by the rotation started by this
1664
- * request.</p>
1665
- */
1666
- VersionId?: string;
1667
- }
1668
- export declare namespace RotateSecretResponse {
1669
- /**
1670
- * @internal
1671
- */
1672
- const filterSensitiveLog: (obj: RotateSecretResponse) => any;
1673
- }
1674
- export interface StopReplicationToReplicaRequest {
1675
- /**
1676
- * <p>Response to <code>StopReplicationToReplica</code> of a secret, based on the <code>SecretId</code>.</p>
1677
- */
1678
- SecretId: string | undefined;
1679
- }
1680
- export declare namespace StopReplicationToReplicaRequest {
1681
- /**
1682
- * @internal
1683
- */
1684
- const filterSensitiveLog: (obj: StopReplicationToReplicaRequest) => any;
1685
- }
1686
- export interface StopReplicationToReplicaResponse {
1687
- /**
1688
- * <p>Response <code>StopReplicationToReplica</code> of a secret, based on the <code>ARN,</code>.</p>
1689
- */
1690
- ARN?: string;
1691
- }
1692
- export declare namespace StopReplicationToReplicaResponse {
1693
- /**
1694
- * @internal
1695
- */
1696
- const filterSensitiveLog: (obj: StopReplicationToReplicaResponse) => any;
1697
- }
1698
- export interface TagResourceRequest {
1699
- /**
1700
- * <p>The identifier for the secret that you want to attach tags to. You can specify either the
1701
- * Amazon Resource Name (ARN) or the friendly name of the secret.</p>
1702
- * <note>
1703
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
1704
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
1705
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
1706
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
1707
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
1708
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
1709
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
1710
- * results. To avoid this situation, we recommend that you don’t create secret names ending
1711
- * with a hyphen followed by six characters.</p>
1712
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
1713
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
1714
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
1715
- * </note>
1716
- */
1717
- SecretId: string | undefined;
1718
- /**
1719
- * <p>The tags to attach to the secret. Each element in the list consists of a <code>Key</code>
1720
- * and a <code>Value</code>.</p>
1721
- * <p>This parameter to the API requires a JSON text string argument. For information on how to
1722
- * format a JSON parameter for the various command line tool environments, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json">Using JSON for Parameters</a> in the <i>CLI User Guide</i>. For the
1723
- * CLI, you can also use the syntax: <code>--Tags Key="Key1",Value="Value1"
1724
- * Key="Key2",Value="Value2"[,…]</code>
1725
- * </p>
1726
- */
1727
- Tags: Tag[] | undefined;
1728
- }
1729
- export declare namespace TagResourceRequest {
1730
- /**
1731
- * @internal
1732
- */
1733
- const filterSensitiveLog: (obj: TagResourceRequest) => any;
1734
- }
1735
- export interface UntagResourceRequest {
1736
- /**
1737
- * <p>The identifier for the secret that you want to remove tags from. You can specify either
1738
- * the Amazon Resource Name (ARN) or the friendly name of the secret.</p>
1739
- * <note>
1740
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
1741
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
1742
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
1743
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
1744
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
1745
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
1746
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
1747
- * results. To avoid this situation, we recommend that you don’t create secret names ending
1748
- * with a hyphen followed by six characters.</p>
1749
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
1750
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
1751
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
1752
- * </note>
1753
- */
1754
- SecretId: string | undefined;
1755
- /**
1756
- * <p>A list of tag key names to remove from the secret. You don't specify the value. Both the
1757
- * key and its associated value are removed.</p>
1758
- * <p>This parameter to the API requires a JSON text string argument. For information on how to
1759
- * format a JSON parameter for the various command line tool environments, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json">Using JSON for Parameters</a> in the <i>CLI User Guide</i>.</p>
1760
- */
1761
- TagKeys: string[] | undefined;
1762
- }
1763
- export declare namespace UntagResourceRequest {
1764
- /**
1765
- * @internal
1766
- */
1767
- const filterSensitiveLog: (obj: UntagResourceRequest) => any;
1768
- }
1769
- export interface UpdateSecretRequest {
1770
- /**
1771
- * <p>Specifies the secret that you want to modify or to which you want to add a new version.
1772
- * You can specify either the Amazon Resource Name (ARN) or the friendly name of the
1773
- * secret.</p>
1774
- * <note>
1775
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
1776
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
1777
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
1778
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
1779
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
1780
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
1781
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
1782
- * results. To avoid this situation, we recommend that you don’t create secret names ending
1783
- * with a hyphen followed by six characters.</p>
1784
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
1785
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
1786
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
1787
- * </note>
1788
- */
1789
- SecretId: string | undefined;
1790
- /**
1791
- * <p>(Optional) If you want to add a new version to the secret, this parameter specifies a
1792
- * unique identifier for the new version that helps ensure idempotency. </p>
1793
- * <p>If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can
1794
- * leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that
1795
- * in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager
1796
- * service endpoint, then you must generate a <code>ClientRequestToken</code> yourself for new
1797
- * versions and include that value in the request.</p>
1798
- * <p>You typically only need to interact with this value if you implement your own retry logic
1799
- * and want to ensure that a given secret is not created twice. We recommend that you generate a
1800
- * <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a>
1801
- * value to ensure uniqueness within the specified secret. </p>
1802
- * <p>Secrets Manager uses this value to prevent the accidental creation of duplicate versions if
1803
- * there are failures and retries during the Lambda rotation function's processing.</p>
1804
- * <ul>
1805
- * <li>
1806
- * <p>If the <code>ClientRequestToken</code> value isn't already associated with a version
1807
- * of the secret then a new version of the secret is created. </p>
1808
- * </li>
1809
- * <li>
1810
- * <p>If a version with this value already exists and that version's
1811
- * <code>SecretString</code> and <code>SecretBinary</code> values are the same as those in
1812
- * the request then the request is ignored (the operation is idempotent). </p>
1813
- * </li>
1814
- * <li>
1815
- * <p>If a version with this value already exists and that version's
1816
- * <code>SecretString</code> and <code>SecretBinary</code> values are different from the
1817
- * request then an error occurs because you cannot modify an existing secret value.</p>
1818
- * </li>
1819
- * </ul>
1820
- * <p>This value becomes the <code>VersionId</code> of the new version.</p>
1821
- */
1822
- ClientRequestToken?: string;
1823
- /**
1824
- * <p>(Optional) Specifies an updated user-provided description of the secret.</p>
1825
- */
1826
- Description?: string;
1827
- /**
1828
- * <p>(Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS customer master key (CMK) to be
1829
- * used to encrypt the protected text in new versions of this secret.</p>
1830
- * <important>
1831
- * <p>You can only use the account's default CMK to encrypt and decrypt if you call this
1832
- * operation using credentials from the same account that owns the secret. If the secret is in
1833
- * a different account, then you must create a custom CMK and provide the ARN of that CMK in
1834
- * this field. The user making the call must have permissions to both the secret and the CMK in
1835
- * their respective accounts.</p>
1836
- * </important>
1837
- */
1838
- KmsKeyId?: string;
1839
- /**
1840
- * <p>(Optional) Specifies updated binary data that you want to encrypt and store in the new
1841
- * version of the secret. To use this parameter in the command-line tools, we recommend that you
1842
- * store your binary data in a file and then use the appropriate technique for your tool to pass
1843
- * the contents of the file as a parameter. Either <code>SecretBinary</code> or
1844
- * <code>SecretString</code> must have a value, but not both. They cannot both be empty.</p>
1845
- * <p>This parameter is not accessible using the Secrets Manager console.</p>
1846
- */
1847
- SecretBinary?: Uint8Array;
1848
- /**
1849
- * <p>(Optional) Specifies updated text data that you want to encrypt and store in this new
1850
- * version of the secret. Either <code>SecretBinary</code> or <code>SecretString</code> must have
1851
- * a value, but not both. They cannot both be empty.</p>
1852
- * <p>If you create this secret by using the Secrets Manager console then Secrets Manager puts the
1853
- * protected secret text in only the <code>SecretString</code> parameter. The Secrets Manager console
1854
- * stores the information as a JSON structure of key/value pairs that the default Lambda rotation
1855
- * function knows how to parse.</p>
1856
- * <p>For storing multiple values, we recommend that you use a JSON text string argument and
1857
- * specify key/value pairs. For information on how to format a JSON parameter for the various
1858
- * command line tool environments, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json">Using JSON for
1859
- * Parameters</a> in the <i>CLI User Guide</i>. For example:</p>
1860
- * <p>
1861
- * <code>[{"username":"bob"},{"password":"abc123xyz456"}]</code>
1862
- * </p>
1863
- * <p>If your command-line tool or SDK requires quotation marks around the parameter, you should
1864
- * use single quotes to avoid confusion with the double quotes required in the JSON text. You can
1865
- * also 'escape' the double quote character in the embedded JSON text by prefacing each with a
1866
- * backslash. For example, the following string is surrounded by double-quotes. All of the
1867
- * embedded double quotes are escaped:</p>
1868
- * <p>
1869
- * <code>"[{\"username\":\"bob\"},{\"password\":\"abc123xyz456\"}]"</code>
1870
- * </p>
1871
- */
1872
- SecretString?: string;
1873
- }
1874
- export declare namespace UpdateSecretRequest {
1875
- /**
1876
- * @internal
1877
- */
1878
- const filterSensitiveLog: (obj: UpdateSecretRequest) => any;
1879
- }
1880
- export interface UpdateSecretResponse {
1881
- /**
1882
- * <p>The ARN of the secret that was updated.</p>
1883
- * <note>
1884
- * <p>Secrets Manager automatically adds several random characters to the name at the end of the ARN when
1885
- * you initially create a secret. This affects only the ARN and not the actual friendly name.
1886
- * This ensures that if you create a new secret with the same name as an old secret that you
1887
- * previously deleted, then users with access to the old secret <i>don't</i>
1888
- * automatically get access to the new secret because the ARNs are different.</p>
1889
- * </note>
1890
- */
1891
- ARN?: string;
1892
- /**
1893
- * <p>The friendly name of the secret that was updated.</p>
1894
- */
1895
- Name?: string;
1896
- /**
1897
- * <p>If a new version of the secret was created by this operation, then <code>VersionId</code>
1898
- * contains the unique identifier of the new version.</p>
1899
- */
1900
- VersionId?: string;
1901
- }
1902
- export declare namespace UpdateSecretResponse {
1903
- /**
1904
- * @internal
1905
- */
1906
- const filterSensitiveLog: (obj: UpdateSecretResponse) => any;
1907
- }
1908
- export interface UpdateSecretVersionStageRequest {
1909
- /**
1910
- * <p>Specifies the secret with the version with the list of staging labels you want to modify.
1911
- * You can specify either the Amazon Resource Name (ARN) or the friendly name of the
1912
- * secret.</p>
1913
- * <note>
1914
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
1915
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
1916
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
1917
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
1918
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
1919
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
1920
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
1921
- * results. To avoid this situation, we recommend that you don’t create secret names ending
1922
- * with a hyphen followed by six characters.</p>
1923
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
1924
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
1925
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
1926
- * </note>
1927
- */
1928
- SecretId: string | undefined;
1929
- /**
1930
- * <p>The staging label to add to this version.</p>
1931
- */
1932
- VersionStage: string | undefined;
1933
- /**
1934
- * <p>Specifies the secret version ID of the version that the staging label is to be removed
1935
- * from. If the staging label you are trying to attach to one version is already attached to a
1936
- * different version, then you must include this parameter and specify the version that the label
1937
- * is to be removed from. If the label is attached and you either do not specify this parameter,
1938
- * or the version ID does not match, then the operation fails.</p>
1939
- */
1940
- RemoveFromVersionId?: string;
1941
- /**
1942
- * <p>(Optional) The secret version ID that you want to add the staging label. If you want to
1943
- * remove a label from a version, then do not specify this parameter.</p>
1944
- * <p>If the staging label is already attached to a different version of the secret, then you
1945
- * must also specify the <code>RemoveFromVersionId</code> parameter. </p>
1946
- */
1947
- MoveToVersionId?: string;
1948
- }
1949
- export declare namespace UpdateSecretVersionStageRequest {
1950
- /**
1951
- * @internal
1952
- */
1953
- const filterSensitiveLog: (obj: UpdateSecretVersionStageRequest) => any;
1954
- }
1955
- export interface UpdateSecretVersionStageResponse {
1956
- /**
1957
- * <p>The ARN of the secret with the modified staging label.</p>
1958
- */
1959
- ARN?: string;
1960
- /**
1961
- * <p>The friendly name of the secret with the modified staging label.</p>
1962
- */
1963
- Name?: string;
1964
- }
1965
- export declare namespace UpdateSecretVersionStageResponse {
1966
- /**
1967
- * @internal
1968
- */
1969
- const filterSensitiveLog: (obj: UpdateSecretVersionStageResponse) => any;
1970
- }
1971
- export interface ValidateResourcePolicyRequest {
1972
- /**
1973
- * <p> (Optional) The identifier of the secret with the resource-based policy you want to
1974
- * validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the
1975
- * secret.</p>
1976
- * <note>
1977
- * <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can
1978
- * specify a partial ARN too—for example, if you don’t include the final hyphen and six random
1979
- * characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN
1980
- * match can work as long as it uniquely matches only one secret. However, if your secret has a
1981
- * name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six
1982
- * characters to the ARN) and you try to use that as a partial ARN, then those characters cause
1983
- * Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected
1984
- * results. To avoid this situation, we recommend that you don’t create secret names ending
1985
- * with a hyphen followed by six characters.</p>
1986
- * <p>If you specify an incomplete ARN without the random suffix, and instead provide the
1987
- * 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager,
1988
- * you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p>
1989
- * </note>
1990
- */
1991
- SecretId?: string;
1992
- /**
1993
- * <p>A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services
1994
- * resource-based policy. The policy in the string identifies who can access or manage this
1995
- * secret and its versions. For information on how to format a JSON parameter for the various
1996
- * command line tool environments, see <a href="http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json">Using
1997
- * JSON for Parameters</a> in the <i>CLI User Guide</i>.publi</p>
1998
- */
1999
- ResourcePolicy: string | undefined;
2000
- }
2001
- export declare namespace ValidateResourcePolicyRequest {
2002
- /**
2003
- * @internal
2004
- */
2005
- const filterSensitiveLog: (obj: ValidateResourcePolicyRequest) => any;
2006
- }
2007
- /**
2008
- * <p>Displays errors that occurred during validation of the resource policy.</p>
2009
- */
2010
- export interface ValidationErrorsEntry {
2011
- /**
2012
- * <p>Checks the name of the policy.</p>
2013
- */
2014
- CheckName?: string;
2015
- /**
2016
- * <p>Displays error messages if validation encounters problems during validation of the resource policy.</p>
2017
- */
2018
- ErrorMessage?: string;
2019
- }
2020
- export declare namespace ValidationErrorsEntry {
2021
- /**
2022
- * @internal
2023
- */
2024
- const filterSensitiveLog: (obj: ValidationErrorsEntry) => any;
2025
- }
2026
- export interface ValidateResourcePolicyResponse {
2027
- /**
2028
- * <p>Returns a message stating that your Reource Policy passed validation. </p>
2029
- */
2030
- PolicyValidationPassed?: boolean;
2031
- /**
2032
- * <p>Returns an error message if your policy doesn't pass validatation.</p>
2033
- */
2034
- ValidationErrors?: ValidationErrorsEntry[];
2035
- }
2036
- export declare namespace ValidateResourcePolicyResponse {
2037
- /**
2038
- * @internal
2039
- */
2040
- const filterSensitiveLog: (obj: ValidateResourcePolicyResponse) => any;
2041
- }