@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,1014 +0,0 @@
1
- import { SecretsManagerClient } from "./SecretsManagerClient";
2
- import { CancelRotateSecretCommandInput, CancelRotateSecretCommandOutput } from "./commands/CancelRotateSecretCommand";
3
- import { CreateSecretCommandInput, CreateSecretCommandOutput } from "./commands/CreateSecretCommand";
4
- import { DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput } from "./commands/DeleteResourcePolicyCommand";
5
- import { DeleteSecretCommandInput, DeleteSecretCommandOutput } from "./commands/DeleteSecretCommand";
6
- import { DescribeSecretCommandInput, DescribeSecretCommandOutput } from "./commands/DescribeSecretCommand";
7
- import { GetRandomPasswordCommandInput, GetRandomPasswordCommandOutput } from "./commands/GetRandomPasswordCommand";
8
- import { GetResourcePolicyCommandInput, GetResourcePolicyCommandOutput } from "./commands/GetResourcePolicyCommand";
9
- import { GetSecretValueCommandInput, GetSecretValueCommandOutput } from "./commands/GetSecretValueCommand";
10
- import { ListSecretVersionIdsCommandInput, ListSecretVersionIdsCommandOutput } from "./commands/ListSecretVersionIdsCommand";
11
- import { ListSecretsCommandInput, ListSecretsCommandOutput } from "./commands/ListSecretsCommand";
12
- import { PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput } from "./commands/PutResourcePolicyCommand";
13
- import { PutSecretValueCommandInput, PutSecretValueCommandOutput } from "./commands/PutSecretValueCommand";
14
- import { RemoveRegionsFromReplicationCommandInput, RemoveRegionsFromReplicationCommandOutput } from "./commands/RemoveRegionsFromReplicationCommand";
15
- import { ReplicateSecretToRegionsCommandInput, ReplicateSecretToRegionsCommandOutput } from "./commands/ReplicateSecretToRegionsCommand";
16
- import { RestoreSecretCommandInput, RestoreSecretCommandOutput } from "./commands/RestoreSecretCommand";
17
- import { RotateSecretCommandInput, RotateSecretCommandOutput } from "./commands/RotateSecretCommand";
18
- import { StopReplicationToReplicaCommandInput, StopReplicationToReplicaCommandOutput } from "./commands/StopReplicationToReplicaCommand";
19
- import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
20
- import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
21
- import { UpdateSecretCommandInput, UpdateSecretCommandOutput } from "./commands/UpdateSecretCommand";
22
- import { UpdateSecretVersionStageCommandInput, UpdateSecretVersionStageCommandOutput } from "./commands/UpdateSecretVersionStageCommand";
23
- import { ValidateResourcePolicyCommandInput, ValidateResourcePolicyCommandOutput } from "./commands/ValidateResourcePolicyCommand";
24
- import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
25
- /**
26
- * <fullname>Amazon Web Services Secrets Manager</fullname>
27
- * <p>Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.</p>
28
- *
29
- * <p>This guide provides descriptions of the Secrets Manager API. For more information about using this
30
- * service, see the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/introduction.html">Amazon Web Services Secrets Manager User Guide</a>.</p>
31
- *
32
- * <p>
33
- * <b>API Version</b>
34
- * </p>
35
- *
36
- * <p>This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.</p>
37
- * <note>
38
- * <p>As an alternative to using the API, you can use one of the Amazon Web Services SDKs, which consist of
39
- * libraries and sample code for various programming languages and platforms such as Java,
40
- * Ruby, .NET, iOS, and Android. The SDKs provide a convenient way to create programmatic
41
- * access to Amazon Web Services Secrets Manager. For example, the SDKs provide cryptographically signing requests,
42
- * managing errors, and retrying requests automatically. For more information about the Amazon Web Services
43
- * SDKs, including downloading and installing them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>.</p>
44
- * </note>
45
- * <p>We recommend you use the Amazon Web Services SDKs to make programmatic API calls to Secrets Manager. However, you
46
- * also can use the Secrets Manager HTTP Query API to make direct calls to the Secrets Manager web service. To learn
47
- * more about the Secrets Manager HTTP Query API, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/query-requests.html">Making Query Requests</a> in the
48
- * <i>Amazon Web Services Secrets Manager User Guide</i>. </p>
49
- * <p>Secrets Manager API supports GET and POST requests for all actions, and doesn't require you to use
50
- * GET for some actions and POST for others. However, GET requests are subject to the limitation
51
- * size of a URL. Therefore, for operations that require larger sizes, use a POST request.</p>
52
- *
53
- *
54
- *
55
- *
56
- *
57
- *
58
- *
59
- * <p>
60
- * <b>Support and Feedback for Amazon Web Services Secrets Manager</b>
61
- * </p>
62
- *
63
- * <p>We welcome your feedback. Send your comments to <a href="mailto:awssecretsmanager-feedback@amazon.com">awssecretsmanager-feedback@amazon.com</a>, or post your feedback and questions in the <a href="http://forums.aws.amazon.com/forum.jspa?forumID=296">Amazon Web Services Secrets Manager Discussion Forum</a>. For more
64
- * information about the Amazon Web Services Discussion Forums, see <a href="http://forums.aws.amazon.com/help.jspa">Forums
65
- * Help</a>.</p>
66
- *
67
- * <p>
68
- * <b>How examples are presented</b>
69
- * </p>
70
- *
71
- * <p>The JSON that Amazon Web Services Secrets Manager expects as your request parameters and the service returns as a
72
- * response to HTTP query requests contain single, long strings without line breaks or white
73
- * space formatting. The JSON shown in the examples displays the code formatted with both line
74
- * breaks and white space to improve readability. When example input parameters can also cause
75
- * long strings extending beyond the screen, you can insert line breaks to enhance readability.
76
- * You should always submit the input as a single JSON text string.</p>
77
- *
78
- *
79
- * <p>
80
- * <b>Logging API Requests</b>
81
- * </p>
82
- * <p>Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services
83
- * account and delivers log files to an Amazon S3 bucket. By using information that's collected
84
- * by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the
85
- * request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services
86
- * CloudTrail, see <a href="http://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring.html#monitoring_cloudtrail">Logging
87
- * Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail</a> in the <i>Amazon Web Services Secrets Manager User Guide</i>.
88
- * To learn more about CloudTrail, including enabling it and find your log files, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html">Amazon Web Services CloudTrail User Guide</a>.</p>
89
- */
90
- export declare class SecretsManager extends SecretsManagerClient {
91
- /**
92
- * <p>Disables automatic scheduled rotation and cancels the rotation of a secret if currently in
93
- * progress.</p>
94
- * <p>To re-enable scheduled rotation, call <a>RotateSecret</a> with
95
- * <code>AutomaticallyRotateAfterDays</code> set to a value greater than 0. This immediately
96
- * rotates your secret and then enables the automatic schedule.</p>
97
- * <note>
98
- * <p>If you cancel a rotation while in progress, it can leave the <code>VersionStage</code>
99
- * labels in an unexpected state. Depending on the step of the rotation in progress, you might
100
- * need to remove the staging label <code>AWSPENDING</code> from the partially created version, specified
101
- * by the <code>VersionId</code> response value. You should also evaluate the partially rotated
102
- * new version to see if it should be deleted, which you can do by removing all staging labels
103
- * from the new version <code>VersionStage</code> field.</p>
104
- * </note>
105
- * <p>To successfully start a rotation, the staging label <code>AWSPENDING</code> must be in one of the
106
- * following states:</p>
107
- * <ul>
108
- * <li>
109
- * <p>Not attached to any version at all</p>
110
- * </li>
111
- * <li>
112
- * <p>Attached to the same version as the staging label <code>AWSCURRENT</code>
113
- * </p>
114
- * </li>
115
- * </ul>
116
- * <p>If the staging label <code>AWSPENDING</code> attached to a different version than the version with
117
- * <code>AWSCURRENT</code> then the attempt to rotate fails.</p>
118
- *
119
- * <p>
120
- * <b>Minimum permissions</b>
121
- * </p>
122
- * <p>To run this command, you must have the following permissions:</p>
123
- * <ul>
124
- * <li>
125
- * <p>secretsmanager:CancelRotateSecret</p>
126
- * </li>
127
- * </ul>
128
- * <p>
129
- * <b>Related operations</b>
130
- * </p>
131
- * <ul>
132
- * <li>
133
- * <p>To configure rotation for a secret or to manually trigger a rotation, use <a>RotateSecret</a>.</p>
134
- * </li>
135
- * <li>
136
- * <p>To get the rotation configuration details for a secret, use <a>DescribeSecret</a>.</p>
137
- * </li>
138
- * <li>
139
- * <p>To list all of the currently available secrets, use <a>ListSecrets</a>.</p>
140
- * </li>
141
- * <li>
142
- * <p>To list all of the versions currently associated with a secret, use <a>ListSecretVersionIds</a>.</p>
143
- * </li>
144
- * </ul>
145
- */
146
- cancelRotateSecret(args: CancelRotateSecretCommandInput, options?: __HttpHandlerOptions): Promise<CancelRotateSecretCommandOutput>;
147
- cancelRotateSecret(args: CancelRotateSecretCommandInput, cb: (err: any, data?: CancelRotateSecretCommandOutput) => void): void;
148
- cancelRotateSecret(args: CancelRotateSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelRotateSecretCommandOutput) => void): void;
149
- /**
150
- * <p>Creates a new secret. A secret in Secrets Manager consists of both the protected secret data and the
151
- * important information needed to manage the secret.</p>
152
- * <p>Secrets Manager stores the encrypted secret data in one of a collection of "versions"
153
- * associated with the secret. Each version contains a copy of the encrypted secret data. Each
154
- * version is associated with one or more "staging labels" that identify where the version is in
155
- * the rotation cycle. The <code>SecretVersionsToStages</code> field of the secret contains the
156
- * mapping of staging labels to the active versions of the secret. Versions without a staging
157
- * label are considered deprecated and not included in the list.</p>
158
- * <p>You provide the secret data to be encrypted by putting text in either the
159
- * <code>SecretString</code> parameter or binary data in the <code>SecretBinary</code>
160
- * parameter, but not both. If you include <code>SecretString</code> or <code>SecretBinary</code>
161
- * then Secrets Manager also creates an initial secret version and automatically attaches the staging
162
- * label <code>AWSCURRENT</code> to the new version.</p>
163
- * <note>
164
- * <ul>
165
- * <li>
166
- * <p>If you call an operation to encrypt or decrypt the <code>SecretString</code>
167
- * or <code>SecretBinary</code> for a secret in the same account as the calling user and that
168
- * secret doesn't specify a Amazon Web Services KMS encryption key, Secrets Manager uses the account's default
169
- * Amazon Web Services managed customer master key (CMK) with the alias <code>aws/secretsmanager</code>. If this key
170
- * doesn't already exist in your account then Secrets Manager creates it for you automatically. All
171
- * users and roles in the same Amazon Web Services account automatically have access to use the default CMK.
172
- * Note that if an Secrets Manager API call results in Amazon Web Services creating the account's
173
- * Amazon Web Services-managed CMK, it can result in a one-time significant delay in returning the
174
- * result.</p>
175
- * </li>
176
- * <li>
177
- * <p>If the secret resides in a different Amazon Web Services account from the credentials calling an API that
178
- * requires encryption or decryption of the secret value then you must create and use a custom
179
- * Amazon Web Services KMS CMK because you can't access the default CMK for the account using credentials
180
- * from a different Amazon Web Services account. Store the ARN of the CMK in the secret when you create the
181
- * secret or when you update it by including it in the <code>KMSKeyId</code>. If you call an
182
- * API that must encrypt or decrypt <code>SecretString</code> or <code>SecretBinary</code>
183
- * using credentials from a different account then the Amazon Web Services KMS key policy must grant cross-account
184
- * access to that other account's user or role for both the kms:GenerateDataKey and
185
- * kms:Decrypt operations.</p>
186
- * </li>
187
- * </ul>
188
- * </note>
189
- * <p> </p>
190
- * <p>
191
- * <b>Minimum permissions</b>
192
- * </p>
193
- * <p>To run this command, you must have the following permissions:</p>
194
- * <ul>
195
- * <li>
196
- * <p>secretsmanager:CreateSecret</p>
197
- * </li>
198
- * <li>
199
- * <p>kms:GenerateDataKey - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt
200
- * the secret. You do not need this permission to use the account default Amazon Web Services managed CMK
201
- * for Secrets Manager.</p>
202
- * </li>
203
- * <li>
204
- * <p>kms:Decrypt - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt the
205
- * secret. You do not need this permission to use the account default Amazon Web Services managed CMK for
206
- * Secrets Manager.</p>
207
- * </li>
208
- * <li>
209
- * <p>secretsmanager:TagResource - needed only if you include the <code>Tags</code>
210
- * parameter. </p>
211
- * </li>
212
- * </ul>
213
- * <p>
214
- * <b>Related operations</b>
215
- * </p>
216
- * <ul>
217
- * <li>
218
- * <p>To delete a secret, use <a>DeleteSecret</a>.</p>
219
- * </li>
220
- * <li>
221
- * <p>To modify an existing secret, use <a>UpdateSecret</a>.</p>
222
- * </li>
223
- * <li>
224
- * <p>To create a new version of a secret, use <a>PutSecretValue</a>.</p>
225
- * </li>
226
- * <li>
227
- * <p>To retrieve the encrypted secure string and secure binary values, use <a>GetSecretValue</a>.</p>
228
- * </li>
229
- * <li>
230
- * <p>To retrieve all other details for a secret, use <a>DescribeSecret</a>. This
231
- * does not include the encrypted secure string and secure binary values.</p>
232
- * </li>
233
- * <li>
234
- * <p>To retrieve the list of secret versions associated with the current secret, use <a>DescribeSecret</a> and examine the <code>SecretVersionsToStages</code> response
235
- * value.</p>
236
- * </li>
237
- * </ul>
238
- */
239
- createSecret(args: CreateSecretCommandInput, options?: __HttpHandlerOptions): Promise<CreateSecretCommandOutput>;
240
- createSecret(args: CreateSecretCommandInput, cb: (err: any, data?: CreateSecretCommandOutput) => void): void;
241
- createSecret(args: CreateSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSecretCommandOutput) => void): void;
242
- /**
243
- * <p>Deletes the resource-based permission policy attached to the secret.</p>
244
- * <p>
245
- * <b>Minimum permissions</b>
246
- * </p>
247
- * <p>To run this command, you must have the following permissions:</p>
248
- * <ul>
249
- * <li>
250
- * <p>secretsmanager:DeleteResourcePolicy</p>
251
- * </li>
252
- * </ul>
253
- * <p>
254
- * <b>Related operations</b>
255
- * </p>
256
- * <ul>
257
- * <li>
258
- * <p>To attach a resource policy to a secret, use <a>PutResourcePolicy</a>.</p>
259
- * </li>
260
- * <li>
261
- * <p>To retrieve the current resource-based policy attached to a secret, use <a>GetResourcePolicy</a>.</p>
262
- * </li>
263
- * <li>
264
- * <p>To list all of the currently available secrets, use <a>ListSecrets</a>.</p>
265
- * </li>
266
- * </ul>
267
- */
268
- deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteResourcePolicyCommandOutput>;
269
- deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
270
- deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
271
- /**
272
- * <p>Deletes an entire secret and all of the versions. You can optionally include a recovery
273
- * window during which you can restore the secret. If you don't specify a recovery window value,
274
- * the operation defaults to 30 days. Secrets Manager attaches a <code>DeletionDate</code> stamp to
275
- * the secret that specifies the end of the recovery window. At the end of the recovery window,
276
- * Secrets Manager deletes the secret permanently.</p>
277
- * <p>At any time before recovery window ends, you can use <a>RestoreSecret</a> to
278
- * remove the <code>DeletionDate</code> and cancel the deletion of the secret.</p>
279
- * <p>You cannot access the encrypted secret information in any secret scheduled for deletion.
280
- * If you need to access that information, you must cancel the deletion with <a>RestoreSecret</a> and then retrieve the information.</p>
281
- * <note>
282
- * <ul>
283
- * <li>
284
- * <p>There is no explicit operation to delete a version of a secret. Instead, remove all
285
- * staging labels from the <code>VersionStage</code> field of a version. That marks the
286
- * version as deprecated and allows Secrets Manager to delete it as needed. Versions without any
287
- * staging labels do not show up in <a>ListSecretVersionIds</a> unless you
288
- * specify <code>IncludeDeprecated</code>.</p>
289
- * </li>
290
- * <li>
291
- * <p>The permanent secret deletion at the end of the waiting period is performed as a
292
- * background task with low priority. There is no guarantee of a specific time after the
293
- * recovery window for the actual delete operation to occur.</p>
294
- * </li>
295
- * </ul>
296
- * </note>
297
- * <p>
298
- * <b>Minimum permissions</b>
299
- * </p>
300
- * <p>To run this command, you must have the following permissions:</p>
301
- * <ul>
302
- * <li>
303
- * <p>secretsmanager:DeleteSecret</p>
304
- * </li>
305
- * </ul>
306
- * <p>
307
- * <b>Related operations</b>
308
- * </p>
309
- * <ul>
310
- * <li>
311
- * <p>To create a secret, use <a>CreateSecret</a>.</p>
312
- * </li>
313
- * <li>
314
- * <p>To cancel deletion of a version of a secret before the recovery window has expired,
315
- * use <a>RestoreSecret</a>.</p>
316
- * </li>
317
- * </ul>
318
- */
319
- deleteSecret(args: DeleteSecretCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSecretCommandOutput>;
320
- deleteSecret(args: DeleteSecretCommandInput, cb: (err: any, data?: DeleteSecretCommandOutput) => void): void;
321
- deleteSecret(args: DeleteSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSecretCommandOutput) => void): void;
322
- /**
323
- * <p>Retrieves the details of a secret. It does not include the encrypted fields. Secrets
324
- * Manager only returns fields populated with a value in the response. </p>
325
- * <p>
326
- * <b>Minimum permissions</b>
327
- * </p>
328
- * <p>To run this command, you must have the following permissions:</p>
329
- * <ul>
330
- * <li>
331
- * <p>secretsmanager:DescribeSecret</p>
332
- * </li>
333
- * </ul>
334
- * <p>
335
- * <b>Related operations</b>
336
- * </p>
337
- * <ul>
338
- * <li>
339
- * <p>To create a secret, use <a>CreateSecret</a>.</p>
340
- * </li>
341
- * <li>
342
- * <p>To modify a secret, use <a>UpdateSecret</a>.</p>
343
- * </li>
344
- * <li>
345
- * <p>To retrieve the encrypted secret information in a version of the secret, use <a>GetSecretValue</a>.</p>
346
- * </li>
347
- * <li>
348
- * <p>To list all of the secrets in the Amazon Web Services account, use <a>ListSecrets</a>.</p>
349
- * </li>
350
- * </ul>
351
- */
352
- describeSecret(args: DescribeSecretCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSecretCommandOutput>;
353
- describeSecret(args: DescribeSecretCommandInput, cb: (err: any, data?: DescribeSecretCommandOutput) => void): void;
354
- describeSecret(args: DescribeSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSecretCommandOutput) => void): void;
355
- /**
356
- * <p>Generates a random password of the specified complexity. This operation is intended for
357
- * use in the Lambda rotation function. Per best practice, we recommend that you specify the
358
- * maximum length and include every character type that the system you are generating a password
359
- * for can support.</p>
360
- * <p>
361
- * <b>Minimum permissions</b>
362
- * </p>
363
- * <p>To run this command, you must have the following permissions:</p>
364
- * <ul>
365
- * <li>
366
- * <p>secretsmanager:GetRandomPassword</p>
367
- * </li>
368
- * </ul>
369
- */
370
- getRandomPassword(args: GetRandomPasswordCommandInput, options?: __HttpHandlerOptions): Promise<GetRandomPasswordCommandOutput>;
371
- getRandomPassword(args: GetRandomPasswordCommandInput, cb: (err: any, data?: GetRandomPasswordCommandOutput) => void): void;
372
- getRandomPassword(args: GetRandomPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRandomPasswordCommandOutput) => void): void;
373
- /**
374
- * <p>Retrieves the JSON text of the resource-based policy document attached to the specified
375
- * secret. The JSON request string input and response output displays formatted code
376
- * with white space and line breaks for better readability. Submit your input as a single line
377
- * JSON string.</p>
378
- * <p>
379
- * <b>Minimum permissions</b>
380
- * </p>
381
- * <p>To run this command, you must have the following permissions:</p>
382
- * <ul>
383
- * <li>
384
- * <p>secretsmanager:GetResourcePolicy</p>
385
- * </li>
386
- * </ul>
387
- * <p>
388
- * <b>Related operations</b>
389
- * </p>
390
- * <ul>
391
- * <li>
392
- * <p>To attach a resource policy to a secret, use <a>PutResourcePolicy</a>.</p>
393
- * </li>
394
- * <li>
395
- * <p>To delete the resource-based policy attached to a secret, use <a>DeleteResourcePolicy</a>.</p>
396
- * </li>
397
- * <li>
398
- * <p>To list all of the currently available secrets, use <a>ListSecrets</a>.</p>
399
- * </li>
400
- * </ul>
401
- */
402
- getResourcePolicy(args: GetResourcePolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetResourcePolicyCommandOutput>;
403
- getResourcePolicy(args: GetResourcePolicyCommandInput, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void): void;
404
- getResourcePolicy(args: GetResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void): void;
405
- /**
406
- * <p>Retrieves the contents of the encrypted fields <code>SecretString</code> or
407
- * <code>SecretBinary</code> from the specified version of a secret, whichever contains
408
- * content.</p>
409
- * <p>
410
- * <b>Minimum permissions</b>
411
- * </p>
412
- * <p>To run this command, you must have the following permissions:</p>
413
- * <ul>
414
- * <li>
415
- * <p>secretsmanager:GetSecretValue</p>
416
- * </li>
417
- * <li>
418
- * <p>kms:Decrypt - required only if you use a customer-managed Amazon Web Services KMS key to encrypt the
419
- * secret. You do not need this permission to use the account's default Amazon Web Services managed CMK for
420
- * Secrets Manager.</p>
421
- * </li>
422
- * </ul>
423
- * <p>
424
- * <b>Related operations</b>
425
- * </p>
426
- * <ul>
427
- * <li>
428
- * <p>To create a new version of the secret with different encrypted information, use <a>PutSecretValue</a>.</p>
429
- * </li>
430
- * <li>
431
- * <p>To retrieve the non-encrypted details for the secret, use <a>DescribeSecret</a>.</p>
432
- * </li>
433
- * </ul>
434
- */
435
- getSecretValue(args: GetSecretValueCommandInput, options?: __HttpHandlerOptions): Promise<GetSecretValueCommandOutput>;
436
- getSecretValue(args: GetSecretValueCommandInput, cb: (err: any, data?: GetSecretValueCommandOutput) => void): void;
437
- getSecretValue(args: GetSecretValueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSecretValueCommandOutput) => void): void;
438
- /**
439
- * <p>Lists all of the secrets that are stored by Secrets Manager in the Amazon Web Services account. To list the
440
- * versions currently stored for a specific secret, use <a>ListSecretVersionIds</a>.
441
- * The encrypted fields <code>SecretString</code> and <code>SecretBinary</code> are not included
442
- * in the output. To get that information, call the <a>GetSecretValue</a>
443
- * operation.</p>
444
- * <note>
445
- * <p>Always check the <code>NextToken</code> response parameter
446
- * when calling any of the <code>List*</code> operations. These operations can occasionally return
447
- * an empty or shorter than expected list of results even when there more results become available.
448
- * When this happens, the <code>NextToken</code> response parameter contains a value to pass to the
449
- * next call to the same API to request the next part of the list.</p>
450
- * </note>
451
- * <p>
452
- * <b>Minimum
453
- * permissions</b>
454
- * </p>
455
- * <p>To run this command, you must have the following permissions:</p>
456
- * <ul>
457
- * <li>
458
- * <p>secretsmanager:ListSecrets</p>
459
- * </li>
460
- * </ul>
461
- * <p>
462
- * <b>Related operations</b>
463
- * </p>
464
- * <ul>
465
- * <li>
466
- * <p>To list the versions attached to a secret, use <a>ListSecretVersionIds</a>.</p>
467
- * </li>
468
- * </ul>
469
- */
470
- listSecrets(args: ListSecretsCommandInput, options?: __HttpHandlerOptions): Promise<ListSecretsCommandOutput>;
471
- listSecrets(args: ListSecretsCommandInput, cb: (err: any, data?: ListSecretsCommandOutput) => void): void;
472
- listSecrets(args: ListSecretsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSecretsCommandOutput) => void): void;
473
- /**
474
- * <p>Lists all of the versions attached to the specified secret. The output does not include
475
- * the <code>SecretString</code> or <code>SecretBinary</code> fields. By default, the list
476
- * includes only versions that have at least one staging label in <code>VersionStage</code>
477
- * attached.</p>
478
- * <note>
479
- * <p>Always check the <code>NextToken</code> response parameter
480
- * when calling any of the <code>List*</code> operations. These operations can occasionally return
481
- * an empty or shorter than expected list of results even when there more results become available.
482
- * When this happens, the <code>NextToken</code> response parameter contains a value to pass to the
483
- * next call to the same API to request the next part of the list.</p>
484
- * </note>
485
- * <p>
486
- * <b>Minimum
487
- * permissions</b>
488
- * </p>
489
- * <p>To run this command, you must have the following permissions:</p>
490
- * <ul>
491
- * <li>
492
- * <p>secretsmanager:ListSecretVersionIds</p>
493
- * </li>
494
- * </ul>
495
- * <p>
496
- * <b>Related operations</b>
497
- * </p>
498
- * <ul>
499
- * <li>
500
- * <p>To list the secrets in an account, use <a>ListSecrets</a>.</p>
501
- * </li>
502
- * </ul>
503
- */
504
- listSecretVersionIds(args: ListSecretVersionIdsCommandInput, options?: __HttpHandlerOptions): Promise<ListSecretVersionIdsCommandOutput>;
505
- listSecretVersionIds(args: ListSecretVersionIdsCommandInput, cb: (err: any, data?: ListSecretVersionIdsCommandOutput) => void): void;
506
- listSecretVersionIds(args: ListSecretVersionIdsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSecretVersionIdsCommandOutput) => void): void;
507
- /**
508
- * <p>Attaches the contents of the specified resource-based permission policy to a secret. A
509
- * resource-based policy is optional. Alternatively, you can use IAM identity-based policies
510
- * that specify the secret's Amazon Resource Name (ARN) in the policy statement's
511
- * <code>Resources</code> element. You can also use a combination of both identity-based and
512
- * resource-based policies. The affected users and roles receive the permissions that are
513
- * permitted by all of the relevant policies. For more information, see <a href="http://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html">Using Resource-Based
514
- * Policies for Amazon Web Services Secrets Manager</a>. For the complete description of the Amazon Web Services policy syntax and
515
- * grammar, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html">IAM JSON
516
- * Policy Reference</a> in the <i>IAM User Guide</i>.</p>
517
- * <p>
518
- * <b>Minimum permissions</b>
519
- * </p>
520
- * <p>To run this command, you must have the following permissions:</p>
521
- * <ul>
522
- * <li>
523
- * <p>secretsmanager:PutResourcePolicy</p>
524
- * </li>
525
- * </ul>
526
- * <p>
527
- * <b>Related operations</b>
528
- * </p>
529
- * <ul>
530
- * <li>
531
- * <p>To retrieve the resource policy attached to a secret, use <a>GetResourcePolicy</a>.</p>
532
- * </li>
533
- * <li>
534
- * <p>To delete the resource-based policy attached to a secret, use <a>DeleteResourcePolicy</a>.</p>
535
- * </li>
536
- * <li>
537
- * <p>To list all of the currently available secrets, use <a>ListSecrets</a>.</p>
538
- * </li>
539
- * </ul>
540
- */
541
- putResourcePolicy(args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutResourcePolicyCommandOutput>;
542
- putResourcePolicy(args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void): void;
543
- putResourcePolicy(args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void): void;
544
- /**
545
- * <p>Stores a new encrypted secret value in the specified secret. To do this, the operation
546
- * creates a new version and attaches it to the secret. The version can contain a new
547
- * <code>SecretString</code> value or a new <code>SecretBinary</code> value. You can also
548
- * specify the staging labels that are initially attached to the new version.</p>
549
- * <note>
550
- * <p>The Secrets Manager console uses only the <code>SecretString</code> field. To add binary data to a
551
- * secret with the <code>SecretBinary</code> field you must use the Amazon Web Services CLI or one of the
552
- * Amazon Web Services SDKs.</p>
553
- * </note>
554
- * <ul>
555
- * <li>
556
- * <p>If this operation creates the first version for the secret then Secrets Manager
557
- * automatically attaches the staging label <code>AWSCURRENT</code> to the new version.</p>
558
- * </li>
559
- * <li>
560
- * <p>If you do not specify a value for VersionStages then Secrets Manager automatically
561
- * moves the staging label <code>AWSCURRENT</code> to this new version.</p>
562
- * </li>
563
- * <li>
564
- * <p>If this operation moves the staging label <code>AWSCURRENT</code> from another version to this
565
- * version, then Secrets Manager also automatically moves the staging label <code>AWSPREVIOUS</code> to
566
- * the version that <code>AWSCURRENT</code> was removed from.</p>
567
- * </li>
568
- * <li>
569
- * <p>This operation is idempotent. If a version with a <code>VersionId</code> with the same
570
- * value as the <code>ClientRequestToken</code> parameter already exists and you specify the
571
- * same secret data, the operation succeeds but does nothing. However, if the secret data is
572
- * different, then the operation fails because you cannot modify an existing version; you can
573
- * only create new ones.</p>
574
- * </li>
575
- * </ul>
576
- * <note>
577
- * <ul>
578
- * <li>
579
- * <p>If you call an operation to encrypt or decrypt the <code>SecretString</code>
580
- * or <code>SecretBinary</code> for a secret in the same account as the calling user and that
581
- * secret doesn't specify a Amazon Web Services KMS encryption key, Secrets Manager uses the account's default
582
- * Amazon Web Services managed customer master key (CMK) with the alias <code>aws/secretsmanager</code>. If this key
583
- * doesn't already exist in your account then Secrets Manager creates it for you automatically. All
584
- * users and roles in the same Amazon Web Services account automatically have access to use the default CMK.
585
- * Note that if an Secrets Manager API call results in Amazon Web Services creating the account's
586
- * Amazon Web Services-managed CMK, it can result in a one-time significant delay in returning the
587
- * result.</p>
588
- * </li>
589
- * <li>
590
- * <p>If the secret resides in a different Amazon Web Services account from the credentials calling an API that
591
- * requires encryption or decryption of the secret value then you must create and use a custom
592
- * Amazon Web Services KMS CMK because you can't access the default CMK for the account using credentials
593
- * from a different Amazon Web Services account. Store the ARN of the CMK in the secret when you create the
594
- * secret or when you update it by including it in the <code>KMSKeyId</code>. If you call an
595
- * API that must encrypt or decrypt <code>SecretString</code> or <code>SecretBinary</code>
596
- * using credentials from a different account then the Amazon Web Services KMS key policy must grant cross-account
597
- * access to that other account's user or role for both the kms:GenerateDataKey and
598
- * kms:Decrypt operations.</p>
599
- * </li>
600
- * </ul>
601
- * </note>
602
- * <p>
603
- * <b>Minimum permissions</b>
604
- * </p>
605
- * <p>To run this command, you must have the following permissions:</p>
606
- * <ul>
607
- * <li>
608
- * <p>secretsmanager:PutSecretValue</p>
609
- * </li>
610
- * <li>
611
- * <p>kms:GenerateDataKey - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt
612
- * the secret. You do not need this permission to use the account's default Amazon Web Services managed CMK
613
- * for Secrets Manager.</p>
614
- * </li>
615
- * </ul>
616
- * <p>
617
- * <b>Related operations</b>
618
- * </p>
619
- * <ul>
620
- * <li>
621
- * <p>To retrieve the encrypted value you store in the version of a secret, use <a>GetSecretValue</a>.</p>
622
- * </li>
623
- * <li>
624
- * <p>To create a secret, use <a>CreateSecret</a>.</p>
625
- * </li>
626
- * <li>
627
- * <p>To get the details for a secret, use <a>DescribeSecret</a>.</p>
628
- * </li>
629
- * <li>
630
- * <p>To list the versions attached to a secret, use <a>ListSecretVersionIds</a>.</p>
631
- * </li>
632
- * </ul>
633
- */
634
- putSecretValue(args: PutSecretValueCommandInput, options?: __HttpHandlerOptions): Promise<PutSecretValueCommandOutput>;
635
- putSecretValue(args: PutSecretValueCommandInput, cb: (err: any, data?: PutSecretValueCommandOutput) => void): void;
636
- putSecretValue(args: PutSecretValueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSecretValueCommandOutput) => void): void;
637
- /**
638
- * <p>Remove regions from replication.</p>
639
- */
640
- removeRegionsFromReplication(args: RemoveRegionsFromReplicationCommandInput, options?: __HttpHandlerOptions): Promise<RemoveRegionsFromReplicationCommandOutput>;
641
- removeRegionsFromReplication(args: RemoveRegionsFromReplicationCommandInput, cb: (err: any, data?: RemoveRegionsFromReplicationCommandOutput) => void): void;
642
- removeRegionsFromReplication(args: RemoveRegionsFromReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveRegionsFromReplicationCommandOutput) => void): void;
643
- /**
644
- * <p>Converts an existing secret to a multi-Region secret and begins replication the secret to a
645
- * list of new regions. </p>
646
- */
647
- replicateSecretToRegions(args: ReplicateSecretToRegionsCommandInput, options?: __HttpHandlerOptions): Promise<ReplicateSecretToRegionsCommandOutput>;
648
- replicateSecretToRegions(args: ReplicateSecretToRegionsCommandInput, cb: (err: any, data?: ReplicateSecretToRegionsCommandOutput) => void): void;
649
- replicateSecretToRegions(args: ReplicateSecretToRegionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReplicateSecretToRegionsCommandOutput) => void): void;
650
- /**
651
- * <p>Cancels the scheduled deletion of a secret by removing the <code>DeletedDate</code> time
652
- * stamp. This makes the secret accessible to query once again.</p>
653
- * <p>
654
- * <b>Minimum permissions</b>
655
- * </p>
656
- * <p>To run this command, you must have the following permissions:</p>
657
- * <ul>
658
- * <li>
659
- * <p>secretsmanager:RestoreSecret</p>
660
- * </li>
661
- * </ul>
662
- * <p>
663
- * <b>Related operations</b>
664
- * </p>
665
- * <ul>
666
- * <li>
667
- * <p>To delete a secret, use <a>DeleteSecret</a>.</p>
668
- * </li>
669
- * </ul>
670
- */
671
- restoreSecret(args: RestoreSecretCommandInput, options?: __HttpHandlerOptions): Promise<RestoreSecretCommandOutput>;
672
- restoreSecret(args: RestoreSecretCommandInput, cb: (err: any, data?: RestoreSecretCommandOutput) => void): void;
673
- restoreSecret(args: RestoreSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreSecretCommandOutput) => void): void;
674
- /**
675
- * <p>Configures and starts the asynchronous process of rotating this secret. If you include the
676
- * configuration parameters, the operation sets those values for the secret and then immediately
677
- * starts a rotation. If you do not include the configuration parameters, the operation starts a
678
- * rotation with the values already stored in the secret. After the rotation completes, the
679
- * protected service and its clients all use the new version of the secret. </p>
680
- * <p>This required configuration information includes the ARN of an Amazon Web Services Lambda function and
681
- * optionally, the time between scheduled rotations. The Lambda rotation function creates a new
682
- * version of the secret and creates or updates the credentials on the protected service to
683
- * match. After testing the new credentials, the function marks the new secret with the staging
684
- * label <code>AWSCURRENT</code> so that your clients all immediately begin to use the new version. For more
685
- * information about rotating secrets and how to configure a Lambda function to rotate the
686
- * secrets for your protected service, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html">Rotating Secrets in Amazon Web Services Secrets Manager</a> in the
687
- * <i>Amazon Web Services Secrets Manager User Guide</i>.</p>
688
- * <p>Secrets Manager schedules the next rotation when the previous
689
- * one completes. Secrets Manager schedules the date by adding the rotation interval (number of days) to the
690
- * actual date of the last rotation. The service chooses the hour within that 24-hour date window
691
- * randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour
692
- * and influenced by a variety of factors that help distribute load.</p>
693
- * <p>The
694
- * rotation function must end with the versions of the secret in one of two states:</p>
695
- * <ul>
696
- * <li>
697
- * <p>The <code>AWSPENDING</code> and <code>AWSCURRENT</code> staging labels are attached to the same version of
698
- * the secret, or</p>
699
- * </li>
700
- * <li>
701
- * <p>The <code>AWSPENDING</code> staging label is not attached to any version of the secret.</p>
702
- * </li>
703
- * </ul>
704
- * <p>If the <code>AWSPENDING</code> staging label is present but not attached to the same version as
705
- * <code>AWSCURRENT</code> then any later invocation of <code>RotateSecret</code> assumes that a previous
706
- * rotation request is still in progress and returns an error.</p>
707
- * <p>
708
- * <b>Minimum permissions</b>
709
- * </p>
710
- * <p>To run this command, you must have the following permissions:</p>
711
- * <ul>
712
- * <li>
713
- * <p>secretsmanager:RotateSecret</p>
714
- * </li>
715
- * <li>
716
- * <p>lambda:InvokeFunction (on the function specified in the secret's metadata)</p>
717
- * </li>
718
- * </ul>
719
- * <p>
720
- * <b>Related operations</b>
721
- * </p>
722
- * <ul>
723
- * <li>
724
- * <p>To list the secrets in your account, use <a>ListSecrets</a>.</p>
725
- * </li>
726
- * <li>
727
- * <p>To get the details for a version of a secret, use <a>DescribeSecret</a>.</p>
728
- * </li>
729
- * <li>
730
- * <p>To create a new version of a secret, use <a>CreateSecret</a>.</p>
731
- * </li>
732
- * <li>
733
- * <p>To attach staging labels to or remove staging labels from a version of a secret, use
734
- * <a>UpdateSecretVersionStage</a>.</p>
735
- * </li>
736
- * </ul>
737
- */
738
- rotateSecret(args: RotateSecretCommandInput, options?: __HttpHandlerOptions): Promise<RotateSecretCommandOutput>;
739
- rotateSecret(args: RotateSecretCommandInput, cb: (err: any, data?: RotateSecretCommandOutput) => void): void;
740
- rotateSecret(args: RotateSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RotateSecretCommandOutput) => void): void;
741
- /**
742
- * <p>Removes the secret from replication and promotes the secret to a regional secret in the replica Region.</p>
743
- */
744
- stopReplicationToReplica(args: StopReplicationToReplicaCommandInput, options?: __HttpHandlerOptions): Promise<StopReplicationToReplicaCommandOutput>;
745
- stopReplicationToReplica(args: StopReplicationToReplicaCommandInput, cb: (err: any, data?: StopReplicationToReplicaCommandOutput) => void): void;
746
- stopReplicationToReplica(args: StopReplicationToReplicaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopReplicationToReplicaCommandOutput) => void): void;
747
- /**
748
- * <p>Attaches one or more tags, each consisting of a key name and a value, to the specified
749
- * secret. Tags are part of the secret's overall metadata, and are not associated with any
750
- * specific version of the secret. This operation only appends tags to the existing list of tags.
751
- * To remove tags, you must use <a>UntagResource</a>.</p>
752
- * <p>The following basic restrictions apply to tags:</p>
753
- * <ul>
754
- * <li>
755
- * <p>Maximum number of tags per secret—50</p>
756
- * </li>
757
- * <li>
758
- * <p>Maximum key length—127 Unicode characters in UTF-8</p>
759
- * </li>
760
- * <li>
761
- * <p>Maximum value length—255 Unicode characters in UTF-8</p>
762
- * </li>
763
- * <li>
764
- * <p>Tag keys and values are case sensitive.</p>
765
- * </li>
766
- * <li>
767
- * <p>Do not use the <code>aws:</code> prefix in your tag names or values because Amazon Web Services reserves it
768
- * for Amazon Web Services use. You can't edit or delete tag names or values with this
769
- * prefix. Tags with this prefix do not count against your tags per secret limit.</p>
770
- * </li>
771
- * <li>
772
- * <p>If you use your tagging schema across multiple services and resources,
773
- * remember other services might have restrictions on allowed characters. Generally
774
- * allowed characters: letters, spaces, and numbers representable in UTF-8, plus the
775
- * following special characters: + - = . _ : / @.</p>
776
- * </li>
777
- * </ul>
778
- * <important>
779
- * <p>If you use tags as part of your security strategy, then adding or removing a tag can
780
- * change permissions. If successfully completing this operation would result in you losing
781
- * your permissions for this secret, then the operation is blocked and returns an Access Denied
782
- * error.</p>
783
- * </important>
784
- * <p>
785
- * <b>Minimum permissions</b>
786
- * </p>
787
- * <p>To run this command, you must have the following permissions:</p>
788
- * <ul>
789
- * <li>
790
- * <p>secretsmanager:TagResource</p>
791
- * </li>
792
- * </ul>
793
- * <p>
794
- * <b>Related operations</b>
795
- * </p>
796
- * <ul>
797
- * <li>
798
- * <p>To remove one or more tags from the collection attached to a secret, use <a>UntagResource</a>.</p>
799
- * </li>
800
- * <li>
801
- * <p>To view the list of tags attached to a secret, use <a>DescribeSecret</a>.</p>
802
- * </li>
803
- * </ul>
804
- */
805
- tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
806
- tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
807
- tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
808
- /**
809
- * <p>Removes one or more tags from the specified secret.</p>
810
- * <p>This operation is idempotent. If a requested tag is not attached to the secret, no error
811
- * is returned and the secret metadata is unchanged.</p>
812
- * <important>
813
- * <p>If you use tags as part of your security strategy, then removing a tag can change
814
- * permissions. If successfully completing this operation would result in you losing your
815
- * permissions for this secret, then the operation is blocked and returns an Access Denied
816
- * error.</p>
817
- * </important>
818
- * <p>
819
- * <b>Minimum permissions</b>
820
- * </p>
821
- * <p>To run this command, you must have the following permissions:</p>
822
- * <ul>
823
- * <li>
824
- * <p>secretsmanager:UntagResource</p>
825
- * </li>
826
- * </ul>
827
- * <p>
828
- * <b>Related operations</b>
829
- * </p>
830
- * <ul>
831
- * <li>
832
- * <p>To add one or more tags to the collection attached to a secret, use <a>TagResource</a>.</p>
833
- * </li>
834
- * <li>
835
- * <p>To view the list of tags attached to a secret, use <a>DescribeSecret</a>.</p>
836
- * </li>
837
- * </ul>
838
- */
839
- untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
840
- untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
841
- untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
842
- /**
843
- * <p>Modifies many of the details of the specified secret. If you include a
844
- * <code>ClientRequestToken</code> and <i>either</i>
845
- * <code>SecretString</code> or <code>SecretBinary</code> then it also creates a new version
846
- * attached to the secret.</p>
847
- * <p>To modify the rotation configuration of a secret, use <a>RotateSecret</a>
848
- * instead.</p>
849
- * <note>
850
- * <p>The Secrets Manager console uses only the <code>SecretString</code> parameter and therefore limits
851
- * you to encrypting and storing only a text string. To encrypt and store binary data as part
852
- * of the version of a secret, you must use either the Amazon Web Services CLI or one of the Amazon Web Services
853
- * SDKs.</p>
854
- * </note>
855
- * <ul>
856
- * <li>
857
- * <p>If a version with a <code>VersionId</code> with the same value as the
858
- * <code>ClientRequestToken</code> parameter already exists, the operation results in an
859
- * error. You cannot modify an existing version, you can only create a new version.</p>
860
- * </li>
861
- * <li>
862
- * <p>If you include <code>SecretString</code> or <code>SecretBinary</code> to create a new
863
- * secret version, Secrets Manager automatically attaches the staging label <code>AWSCURRENT</code> to the new
864
- * version. </p>
865
- * </li>
866
- * </ul>
867
- * <note>
868
- * <ul>
869
- * <li>
870
- * <p>If you call an operation to encrypt or decrypt the <code>SecretString</code>
871
- * or <code>SecretBinary</code> for a secret in the same account as the calling user and that
872
- * secret doesn't specify a Amazon Web Services KMS encryption key, Secrets Manager uses the account's default
873
- * Amazon Web Services managed customer master key (CMK) with the alias <code>aws/secretsmanager</code>. If this key
874
- * doesn't already exist in your account then Secrets Manager creates it for you automatically. All
875
- * users and roles in the same Amazon Web Services account automatically have access to use the default CMK.
876
- * Note that if an Secrets Manager API call results in Amazon Web Services creating the account's
877
- * Amazon Web Services-managed CMK, it can result in a one-time significant delay in returning the
878
- * result.</p>
879
- * </li>
880
- * <li>
881
- * <p>If the secret resides in a different Amazon Web Services account from the credentials calling an API that
882
- * requires encryption or decryption of the secret value then you must create and use a custom
883
- * Amazon Web Services KMS CMK because you can't access the default CMK for the account using credentials
884
- * from a different Amazon Web Services account. Store the ARN of the CMK in the secret when you create the
885
- * secret or when you update it by including it in the <code>KMSKeyId</code>. If you call an
886
- * API that must encrypt or decrypt <code>SecretString</code> or <code>SecretBinary</code>
887
- * using credentials from a different account then the Amazon Web Services KMS key policy must grant cross-account
888
- * access to that other account's user or role for both the kms:GenerateDataKey and
889
- * kms:Decrypt operations.</p>
890
- * </li>
891
- * </ul>
892
- * </note>
893
- * <p>
894
- * <b>Minimum permissions</b>
895
- * </p>
896
- * <p>To run this command, you must have the following permissions:</p>
897
- * <ul>
898
- * <li>
899
- * <p>secretsmanager:UpdateSecret</p>
900
- * </li>
901
- * <li>
902
- * <p>kms:GenerateDataKey - needed only if you use a custom Amazon Web Services KMS key to encrypt the secret.
903
- * You do not need this permission to use the account's Amazon Web Services managed CMK for
904
- * Secrets Manager.</p>
905
- * </li>
906
- * <li>
907
- * <p>kms:Decrypt - needed only if you use a custom Amazon Web Services KMS key to encrypt the secret. You do
908
- * not need this permission to use the account's Amazon Web Services managed CMK for Secrets Manager.</p>
909
- * </li>
910
- * </ul>
911
- * <p>
912
- * <b>Related operations</b>
913
- * </p>
914
- * <ul>
915
- * <li>
916
- * <p>To create a new secret, use <a>CreateSecret</a>.</p>
917
- * </li>
918
- * <li>
919
- * <p>To add only a new version to an existing secret, use <a>PutSecretValue</a>.</p>
920
- * </li>
921
- * <li>
922
- * <p>To get the details for a secret, use <a>DescribeSecret</a>.</p>
923
- * </li>
924
- * <li>
925
- * <p>To list the versions contained in a secret, use <a>ListSecretVersionIds</a>.</p>
926
- * </li>
927
- * </ul>
928
- */
929
- updateSecret(args: UpdateSecretCommandInput, options?: __HttpHandlerOptions): Promise<UpdateSecretCommandOutput>;
930
- updateSecret(args: UpdateSecretCommandInput, cb: (err: any, data?: UpdateSecretCommandOutput) => void): void;
931
- updateSecret(args: UpdateSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSecretCommandOutput) => void): void;
932
- /**
933
- * <p>Modifies the staging labels attached to a version of a secret. Staging labels are used to
934
- * track a version as it progresses through the secret rotation process. You can attach a staging
935
- * label to only one version of a secret at a time. If a staging label to be added is already
936
- * attached to another version, then it is moved--removed from the other version first and
937
- * then attached to this one. For more information about staging labels, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/terms-concepts.html#term_staging-label">Staging
938
- * Labels</a> in the <i>Amazon Web Services Secrets Manager User Guide</i>. </p>
939
- * <p>The staging labels that you specify in the <code>VersionStage</code> parameter are added
940
- * to the existing list of staging labels--they don't replace it.</p>
941
- * <p>You can move the <code>AWSCURRENT</code> staging label to this version by including it in this
942
- * call.</p>
943
- * <note>
944
- * <p>Whenever you move <code>AWSCURRENT</code>, Secrets Manager automatically moves the label <code>AWSPREVIOUS</code>
945
- * to the version that <code>AWSCURRENT</code> was removed from.</p>
946
- * </note>
947
- * <p>If this action results in the last label being removed from a version, then the version is
948
- * considered to be 'deprecated' and can be deleted by Secrets Manager.</p>
949
- * <p>
950
- * <b>Minimum permissions</b>
951
- * </p>
952
- * <p>To run this command, you must have the following permissions:</p>
953
- * <ul>
954
- * <li>
955
- * <p>secretsmanager:UpdateSecretVersionStage</p>
956
- * </li>
957
- * </ul>
958
- * <p>
959
- * <b>Related operations</b>
960
- * </p>
961
- * <ul>
962
- * <li>
963
- * <p>To get the list of staging labels that are currently associated with a version of a
964
- * secret, use <code>
965
- * <a>DescribeSecret</a>
966
- * </code> and examine the
967
- * <code>SecretVersionsToStages</code> response value. </p>
968
- * </li>
969
- * </ul>
970
- */
971
- updateSecretVersionStage(args: UpdateSecretVersionStageCommandInput, options?: __HttpHandlerOptions): Promise<UpdateSecretVersionStageCommandOutput>;
972
- updateSecretVersionStage(args: UpdateSecretVersionStageCommandInput, cb: (err: any, data?: UpdateSecretVersionStageCommandOutput) => void): void;
973
- updateSecretVersionStage(args: UpdateSecretVersionStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSecretVersionStageCommandOutput) => void): void;
974
- /**
975
- * <p>Validates that the resource policy does not grant a wide range of IAM principals access to
976
- * your secret. The JSON request string input and response output displays formatted code
977
- * with white space and line breaks for better readability. Submit your input as a single line
978
- * JSON string. A resource-based policy is optional for secrets.</p>
979
- * <p>The API performs three checks when validating the secret:</p>
980
- * <ul>
981
- * <li>
982
- * <p>Sends a call to <a href="https://aws.amazon.com/blogs/security/protect-sensitive-data-in-the-cloud-with-automated-reasoning-zelkova/">Zelkova</a>, an automated reasoning engine, to ensure your Resource Policy does not
983
- * allow broad access to your secret.</p>
984
- * </li>
985
- * <li>
986
- * <p>Checks for correct syntax in a policy.</p>
987
- * </li>
988
- * <li>
989
- * <p>Verifies the policy does not lock out a caller.</p>
990
- * </li>
991
- * </ul>
992
- *
993
- *
994
- * <p>
995
- * <b>Minimum Permissions</b>
996
- * </p>
997
- * <p>You must have the permissions required to access the following APIs:</p>
998
- * <ul>
999
- * <li>
1000
- * <p>
1001
- * <code>secretsmanager:PutResourcePolicy</code>
1002
- * </p>
1003
- * </li>
1004
- * <li>
1005
- * <p>
1006
- * <code>secretsmanager:ValidateResourcePolicy</code>
1007
- * </p>
1008
- * </li>
1009
- * </ul>
1010
- */
1011
- validateResourcePolicy(args: ValidateResourcePolicyCommandInput, options?: __HttpHandlerOptions): Promise<ValidateResourcePolicyCommandOutput>;
1012
- validateResourcePolicy(args: ValidateResourcePolicyCommandInput, cb: (err: any, data?: ValidateResourcePolicyCommandOutput) => void): void;
1013
- validateResourcePolicy(args: ValidateResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidateResourcePolicyCommandOutput) => void): void;
1014
- }