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