oci-keymanagement 2.70.1 → 2.70.3

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 (279) hide show
  1. package/index.d.ts +5 -3
  2. package/index.js +6 -4
  3. package/index.js.map +1 -1
  4. package/lib/client.d.ts +201 -49
  5. package/lib/client.js +595 -91
  6. package/lib/client.js.map +1 -1
  7. package/lib/ekm-waiter.d.ts +30 -0
  8. package/lib/ekm-waiter.js +66 -0
  9. package/lib/ekm-waiter.js.map +1 -0
  10. package/lib/kmsmanagement-waiter.d.ts +2 -3
  11. package/lib/kmsmanagement-waiter.js +2 -3
  12. package/lib/kmsmanagement-waiter.js.map +1 -1
  13. package/lib/kmsvault-waiter.d.ts +2 -3
  14. package/lib/kmsvault-waiter.js +2 -3
  15. package/lib/kmsvault-waiter.js.map +1 -1
  16. package/lib/model/backup-key-details.d.ts +5 -3
  17. package/lib/model/backup-key-details.js +2 -3
  18. package/lib/model/backup-key-details.js.map +1 -1
  19. package/lib/model/backup-location-bucket.d.ts +2 -3
  20. package/lib/model/backup-location-bucket.js +2 -3
  21. package/lib/model/backup-location-bucket.js.map +1 -1
  22. package/lib/model/backup-location-ur-i.d.ts +2 -3
  23. package/lib/model/backup-location-ur-i.js +2 -3
  24. package/lib/model/backup-location-ur-i.js.map +1 -1
  25. package/lib/model/backup-location.d.ts +2 -3
  26. package/lib/model/backup-location.js +2 -3
  27. package/lib/model/backup-location.js.map +1 -1
  28. package/lib/model/backup-vault-details.d.ts +8 -3
  29. package/lib/model/backup-vault-details.js +2 -3
  30. package/lib/model/backup-vault-details.js.map +1 -1
  31. package/lib/model/change-key-compartment-details.d.ts +5 -3
  32. package/lib/model/change-key-compartment-details.js +2 -3
  33. package/lib/model/change-key-compartment-details.js.map +1 -1
  34. package/lib/model/change-vault-compartment-details.d.ts +5 -3
  35. package/lib/model/change-vault-compartment-details.js +2 -3
  36. package/lib/model/change-vault-compartment-details.js.map +1 -1
  37. package/lib/model/create-ekms-private-endpoint-details.d.ts +67 -0
  38. package/lib/model/create-ekms-private-endpoint-details.js +30 -0
  39. package/lib/model/create-ekms-private-endpoint-details.js.map +1 -0
  40. package/lib/model/create-key-details.d.ts +11 -4
  41. package/lib/model/create-key-details.js +11 -5
  42. package/lib/model/create-key-details.js.map +1 -1
  43. package/lib/model/create-vault-details.d.ts +9 -4
  44. package/lib/model/create-vault-details.js +33 -5
  45. package/lib/model/create-vault-details.js.map +1 -1
  46. package/lib/model/create-vault-replica-details.d.ts +2 -3
  47. package/lib/model/create-vault-replica-details.js +2 -3
  48. package/lib/model/create-vault-replica-details.js.map +1 -1
  49. package/lib/model/decrypt-data-details.d.ts +5 -3
  50. package/lib/model/decrypt-data-details.js +2 -3
  51. package/lib/model/decrypt-data-details.js.map +1 -1
  52. package/lib/model/decrypted-data.d.ts +5 -3
  53. package/lib/model/decrypted-data.js +2 -3
  54. package/lib/model/decrypted-data.js.map +1 -1
  55. package/lib/model/delete-vault-replica-details.d.ts +2 -3
  56. package/lib/model/delete-vault-replica-details.js +2 -3
  57. package/lib/model/delete-vault-replica-details.js.map +1 -1
  58. package/lib/model/ekms-private-endpoint-summary.d.ts +80 -0
  59. package/lib/model/ekms-private-endpoint-summary.js +43 -0
  60. package/lib/model/ekms-private-endpoint-summary.js.map +1 -0
  61. package/lib/model/ekms-private-endpoint.d.ts +102 -0
  62. package/lib/model/ekms-private-endpoint.js +43 -0
  63. package/lib/model/ekms-private-endpoint.js.map +1 -0
  64. package/lib/model/encrypt-data-details.d.ts +5 -3
  65. package/lib/model/encrypt-data-details.js +2 -3
  66. package/lib/model/encrypt-data-details.js.map +1 -1
  67. package/lib/model/encrypted-data.d.ts +5 -3
  68. package/lib/model/encrypted-data.js +2 -3
  69. package/lib/model/encrypted-data.js.map +1 -1
  70. package/lib/model/export-key-details.d.ts +2 -3
  71. package/lib/model/export-key-details.js +2 -3
  72. package/lib/model/export-key-details.js.map +1 -1
  73. package/lib/model/exported-key-data.d.ts +2 -3
  74. package/lib/model/exported-key-data.js +2 -3
  75. package/lib/model/exported-key-data.js.map +1 -1
  76. package/lib/model/external-key-manager-metadata-summary.d.ts +36 -0
  77. package/lib/model/external-key-manager-metadata-summary.js +58 -0
  78. package/lib/model/external-key-manager-metadata-summary.js.map +1 -0
  79. package/lib/model/external-key-manager-metadata.d.ts +32 -0
  80. package/lib/model/external-key-manager-metadata.js +58 -0
  81. package/lib/model/external-key-manager-metadata.js.map +1 -0
  82. package/lib/model/external-key-reference-details.d.ts +30 -0
  83. package/lib/model/external-key-reference-details.js +30 -0
  84. package/lib/model/external-key-reference-details.js.map +1 -0
  85. package/lib/model/external-key-reference.d.ts +26 -0
  86. package/lib/model/external-key-reference.js +30 -0
  87. package/lib/model/external-key-reference.js.map +1 -0
  88. package/lib/model/external-key-version-reference.d.ts +26 -0
  89. package/lib/model/external-key-version-reference.js +30 -0
  90. package/lib/model/external-key-version-reference.js.map +1 -0
  91. package/lib/model/generate-key-details.d.ts +5 -3
  92. package/lib/model/generate-key-details.js +2 -3
  93. package/lib/model/generate-key-details.js.map +1 -1
  94. package/lib/model/generated-key.d.ts +5 -3
  95. package/lib/model/generated-key.js +2 -3
  96. package/lib/model/generated-key.js.map +1 -1
  97. package/lib/model/import-key-details.d.ts +5 -3
  98. package/lib/model/import-key-details.js +2 -3
  99. package/lib/model/import-key-details.js.map +1 -1
  100. package/lib/model/import-key-version-details.d.ts +5 -3
  101. package/lib/model/import-key-version-details.js +2 -3
  102. package/lib/model/import-key-version-details.js.map +1 -1
  103. package/lib/model/index.d.ts +24 -3
  104. package/lib/model/index.js +26 -4
  105. package/lib/model/index.js.map +1 -1
  106. package/lib/model/key-replica-details.d.ts +2 -3
  107. package/lib/model/key-replica-details.js +2 -3
  108. package/lib/model/key-replica-details.js.map +1 -1
  109. package/lib/model/key-shape.d.ts +3 -4
  110. package/lib/model/key-shape.js +2 -3
  111. package/lib/model/key-shape.js.map +1 -1
  112. package/lib/model/key-summary.d.ts +11 -3
  113. package/lib/model/key-summary.js +33 -5
  114. package/lib/model/key-summary.js.map +1 -1
  115. package/lib/model/key-version-replica-details.d.ts +2 -3
  116. package/lib/model/key-version-replica-details.js +2 -3
  117. package/lib/model/key-version-replica-details.js.map +1 -1
  118. package/lib/model/key-version-summary.d.ts +7 -3
  119. package/lib/model/key-version-summary.js +32 -5
  120. package/lib/model/key-version-summary.js.map +1 -1
  121. package/lib/model/key-version.d.ts +9 -3
  122. package/lib/model/key-version.js +8 -3
  123. package/lib/model/key-version.js.map +1 -1
  124. package/lib/model/key.d.ts +13 -3
  125. package/lib/model/key.js +9 -3
  126. package/lib/model/key.js.map +1 -1
  127. package/lib/model/oauth-metadata-summary.d.ts +30 -0
  128. package/lib/model/oauth-metadata-summary.js +30 -0
  129. package/lib/model/oauth-metadata-summary.js.map +1 -0
  130. package/lib/model/oauth-metadata.d.ts +34 -0
  131. package/lib/model/oauth-metadata.js +30 -0
  132. package/lib/model/oauth-metadata.js.map +1 -0
  133. package/lib/model/replica-details.d.ts +2 -3
  134. package/lib/model/replica-details.js +2 -3
  135. package/lib/model/replica-details.js.map +1 -1
  136. package/lib/model/replication-status-details.d.ts +5 -3
  137. package/lib/model/replication-status-details.js +2 -3
  138. package/lib/model/replication-status-details.js.map +1 -1
  139. package/lib/model/restore-key-from-object-store-details.d.ts +5 -3
  140. package/lib/model/restore-key-from-object-store-details.js +2 -3
  141. package/lib/model/restore-key-from-object-store-details.js.map +1 -1
  142. package/lib/model/restore-vault-from-object-store-details.d.ts +5 -3
  143. package/lib/model/restore-vault-from-object-store-details.js +2 -3
  144. package/lib/model/restore-vault-from-object-store-details.js.map +1 -1
  145. package/lib/model/schedule-key-deletion-details.d.ts +2 -3
  146. package/lib/model/schedule-key-deletion-details.js +2 -3
  147. package/lib/model/schedule-key-deletion-details.js.map +1 -1
  148. package/lib/model/schedule-key-version-deletion-details.d.ts +2 -3
  149. package/lib/model/schedule-key-version-deletion-details.js +2 -3
  150. package/lib/model/schedule-key-version-deletion-details.js.map +1 -1
  151. package/lib/model/schedule-vault-deletion-details.d.ts +2 -3
  152. package/lib/model/schedule-vault-deletion-details.js +2 -3
  153. package/lib/model/schedule-vault-deletion-details.js.map +1 -1
  154. package/lib/model/sign-data-details.d.ts +5 -3
  155. package/lib/model/sign-data-details.js +2 -3
  156. package/lib/model/sign-data-details.js.map +1 -1
  157. package/lib/model/signed-data.d.ts +5 -3
  158. package/lib/model/signed-data.js +2 -3
  159. package/lib/model/signed-data.js.map +1 -1
  160. package/lib/model/update-ekms-private-endpoint-details.d.ts +44 -0
  161. package/lib/model/update-ekms-private-endpoint-details.js +30 -0
  162. package/lib/model/update-ekms-private-endpoint-details.js.map +1 -0
  163. package/lib/model/update-key-details.d.ts +5 -3
  164. package/lib/model/update-key-details.js +2 -3
  165. package/lib/model/update-key-details.js.map +1 -1
  166. package/lib/model/update-vault-details.d.ts +5 -3
  167. package/lib/model/update-vault-details.js +2 -3
  168. package/lib/model/update-vault-details.js.map +1 -1
  169. package/lib/model/vault-replica-details.d.ts +2 -3
  170. package/lib/model/vault-replica-details.js +2 -3
  171. package/lib/model/vault-replica-details.js.map +1 -1
  172. package/lib/model/vault-replica-summary.d.ts +5 -3
  173. package/lib/model/vault-replica-summary.js +2 -3
  174. package/lib/model/vault-replica-summary.js.map +1 -1
  175. package/lib/model/vault-summary.d.ts +8 -3
  176. package/lib/model/vault-summary.js +33 -5
  177. package/lib/model/vault-summary.js.map +1 -1
  178. package/lib/model/vault-usage.d.ts +5 -3
  179. package/lib/model/vault-usage.js +2 -3
  180. package/lib/model/vault-usage.js.map +1 -1
  181. package/lib/model/vault.d.ts +10 -3
  182. package/lib/model/vault.js +9 -3
  183. package/lib/model/vault.js.map +1 -1
  184. package/lib/model/verified-data.d.ts +5 -3
  185. package/lib/model/verified-data.js +2 -3
  186. package/lib/model/verified-data.js.map +1 -1
  187. package/lib/model/verify-data-details.d.ts +5 -3
  188. package/lib/model/verify-data-details.js +2 -3
  189. package/lib/model/verify-data-details.js.map +1 -1
  190. package/lib/model/wrapped-import-key.d.ts +5 -3
  191. package/lib/model/wrapped-import-key.js +2 -3
  192. package/lib/model/wrapped-import-key.js.map +1 -1
  193. package/lib/model/wrapping-key.d.ts +5 -3
  194. package/lib/model/wrapping-key.js +2 -3
  195. package/lib/model/wrapping-key.js.map +1 -1
  196. package/lib/request/backup-key-request.d.ts +1 -1
  197. package/lib/request/backup-vault-request.d.ts +1 -1
  198. package/lib/request/cancel-key-deletion-request.d.ts +1 -1
  199. package/lib/request/cancel-key-version-deletion-request.d.ts +1 -1
  200. package/lib/request/cancel-vault-deletion-request.d.ts +1 -1
  201. package/lib/request/change-key-compartment-request.d.ts +2 -2
  202. package/lib/request/change-vault-compartment-request.d.ts +2 -2
  203. package/lib/request/create-ekms-private-endpoint-request.d.ts +40 -0
  204. package/lib/request/create-ekms-private-endpoint-request.js +15 -0
  205. package/lib/request/create-ekms-private-endpoint-request.js.map +1 -0
  206. package/lib/request/create-key-request.d.ts +1 -1
  207. package/lib/request/create-key-version-request.d.ts +6 -1
  208. package/lib/request/create-vault-replica-request.d.ts +1 -1
  209. package/lib/request/create-vault-request.d.ts +1 -1
  210. package/lib/request/decrypt-request.d.ts +1 -1
  211. package/lib/request/delete-ekms-private-endpoint-request.d.ts +38 -0
  212. package/lib/request/delete-ekms-private-endpoint-request.js +15 -0
  213. package/lib/request/delete-ekms-private-endpoint-request.js.map +1 -0
  214. package/lib/request/delete-vault-replica-request.d.ts +1 -1
  215. package/lib/request/disable-key-request.d.ts +1 -1
  216. package/lib/request/enable-key-request.d.ts +1 -1
  217. package/lib/request/encrypt-request.d.ts +1 -1
  218. package/lib/request/export-key-request.d.ts +1 -1
  219. package/lib/request/generate-data-encryption-key-request.d.ts +1 -1
  220. package/lib/request/get-ekms-private-endpoint-request.d.ts +29 -0
  221. package/lib/request/get-ekms-private-endpoint-request.js +15 -0
  222. package/lib/request/get-ekms-private-endpoint-request.js.map +1 -0
  223. package/lib/request/get-key-request.d.ts +1 -1
  224. package/lib/request/get-key-version-request.d.ts +1 -1
  225. package/lib/request/get-replication-status-request.d.ts +1 -1
  226. package/lib/request/get-vault-request.d.ts +1 -1
  227. package/lib/request/get-vault-usage-request.d.ts +1 -1
  228. package/lib/request/get-wrapping-key-request.d.ts +1 -1
  229. package/lib/request/import-key-request.d.ts +1 -1
  230. package/lib/request/import-key-version-request.d.ts +1 -1
  231. package/lib/request/index.d.ts +12 -3
  232. package/lib/request/index.js +5 -4
  233. package/lib/request/index.js.map +1 -1
  234. package/lib/request/list-ekms-private-endpoints-request.d.ts +62 -0
  235. package/lib/request/list-ekms-private-endpoints-request.js +29 -0
  236. package/lib/request/list-ekms-private-endpoints-request.js.map +1 -0
  237. package/lib/request/list-key-versions-request.d.ts +1 -1
  238. package/lib/request/list-keys-request.d.ts +5 -2
  239. package/lib/request/list-keys-request.js +1 -0
  240. package/lib/request/list-keys-request.js.map +1 -1
  241. package/lib/request/list-vault-replicas-request.d.ts +1 -1
  242. package/lib/request/list-vaults-request.d.ts +1 -1
  243. package/lib/request/restore-key-from-file-request.d.ts +1 -1
  244. package/lib/request/restore-key-from-object-store-request.d.ts +1 -1
  245. package/lib/request/restore-vault-from-file-request.d.ts +1 -1
  246. package/lib/request/restore-vault-from-object-store-request.d.ts +1 -1
  247. package/lib/request/schedule-key-deletion-request.d.ts +1 -1
  248. package/lib/request/schedule-key-version-deletion-request.d.ts +1 -1
  249. package/lib/request/schedule-vault-deletion-request.d.ts +1 -1
  250. package/lib/request/sign-request.d.ts +1 -1
  251. package/lib/request/update-ekms-private-endpoint-request.d.ts +43 -0
  252. package/lib/request/update-ekms-private-endpoint-request.js +15 -0
  253. package/lib/request/update-ekms-private-endpoint-request.js.map +1 -0
  254. package/lib/request/update-key-request.d.ts +1 -1
  255. package/lib/request/update-vault-request.d.ts +1 -1
  256. package/lib/request/verify-request.d.ts +1 -1
  257. package/lib/response/create-ekms-private-endpoint-response.d.ts +34 -0
  258. package/lib/response/create-ekms-private-endpoint-response.js +15 -0
  259. package/lib/response/create-ekms-private-endpoint-response.js.map +1 -0
  260. package/lib/response/delete-ekms-private-endpoint-response.d.ts +26 -0
  261. package/lib/response/delete-ekms-private-endpoint-response.js +15 -0
  262. package/lib/response/delete-ekms-private-endpoint-response.js.map +1 -0
  263. package/lib/response/get-ekms-private-endpoint-response.d.ts +29 -0
  264. package/lib/response/get-ekms-private-endpoint-response.js +15 -0
  265. package/lib/response/get-ekms-private-endpoint-response.js.map +1 -0
  266. package/lib/response/index.d.ts +12 -3
  267. package/lib/response/index.js +2 -3
  268. package/lib/response/index.js.map +1 -1
  269. package/lib/response/list-ekms-private-endpoints-response.d.ts +33 -0
  270. package/lib/response/list-ekms-private-endpoints-response.js +15 -0
  271. package/lib/response/list-ekms-private-endpoints-response.js.map +1 -0
  272. package/lib/response/list-key-versions-response.d.ts +1 -1
  273. package/lib/response/list-keys-response.d.ts +1 -1
  274. package/lib/response/list-vault-replicas-response.d.ts +1 -1
  275. package/lib/response/list-vaults-response.d.ts +1 -1
  276. package/lib/response/update-ekms-private-endpoint-response.d.ts +29 -0
  277. package/lib/response/update-ekms-private-endpoint-response.js +15 -0
  278. package/lib/response/update-ekms-private-endpoint-response.js.map +1 -0
  279. package/package.json +3 -3
package/index.d.ts CHANGED
@@ -1,7 +1,6 @@
1
1
  /**
2
- * Vault Service Key Management API
3
- * API for managing and performing operations with keys and vaults. (For the API for managing secrets, see the Vault Service
4
- Secret Management API. For the API for retrieving secrets, see the Vault Service Secret Retrieval API.)
2
+ * Vault Key Management API
3
+ * Use the Key Management API to manage vaults and keys. For more information, see [Managing Vaults](/Content/KeyManagement/Tasks/managingvaults.htm) and [Managing Keys](/Content/KeyManagement/Tasks/managingkeys.htm).
5
4
 
6
5
  * OpenAPI spec version: release
7
6
  * Contact: sparta_kms_us_grp@oracle.com
@@ -16,11 +15,14 @@ import * as requests from "./lib/request";
16
15
  import * as models from "./lib/model";
17
16
  import * as responses from "./lib/response";
18
17
  import * as client from "./lib/client";
18
+ import * as ekm_waiter from "./lib/ekm-waiter";
19
19
  import * as kmsmanagement_waiter from "./lib/kmsmanagement-waiter";
20
20
  import * as kmsvault_waiter from "./lib/kmsvault-waiter";
21
21
  export { models };
22
22
  export { requests };
23
23
  export { responses };
24
+ export import EkmClient = client.EkmClient;
25
+ export import EkmWaiter = ekm_waiter.EkmWaiter;
24
26
  export import KmsCryptoClient = client.KmsCryptoClient;
25
27
  export import KmsManagementClient = client.KmsManagementClient;
26
28
  export import KmsManagementWaiter = kmsmanagement_waiter.KmsManagementWaiter;
package/index.js CHANGED
@@ -1,8 +1,7 @@
1
1
  "use strict";
2
2
  /**
3
- * Vault Service Key Management API
4
- * API for managing and performing operations with keys and vaults. (For the API for managing secrets, see the Vault Service
5
- Secret Management API. For the API for retrieving secrets, see the Vault Service Secret Retrieval API.)
3
+ * Vault Key Management API
4
+ * Use the Key Management API to manage vaults and keys. For more information, see [Managing Vaults](/Content/KeyManagement/Tasks/managingvaults.htm) and [Managing Keys](/Content/KeyManagement/Tasks/managingkeys.htm).
6
5
 
7
6
  * OpenAPI spec version: release
8
7
  * Contact: sparta_kms_us_grp@oracle.com
@@ -33,7 +32,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
33
32
  return result;
34
33
  };
35
34
  Object.defineProperty(exports, "__esModule", { value: true });
36
- exports.KmsVaultWaiter = exports.KmsVaultClient = exports.KmsManagementWaiter = exports.KmsManagementClient = exports.KmsCryptoClient = exports.responses = exports.requests = exports.models = void 0;
35
+ exports.KmsVaultWaiter = exports.KmsVaultClient = exports.KmsManagementWaiter = exports.KmsManagementClient = exports.KmsCryptoClient = exports.EkmWaiter = exports.EkmClient = exports.responses = exports.requests = exports.models = void 0;
37
36
  const requests = __importStar(require("./lib/request"));
38
37
  exports.requests = requests;
39
38
  const models = __importStar(require("./lib/model"));
@@ -41,8 +40,11 @@ exports.models = models;
41
40
  const responses = __importStar(require("./lib/response"));
42
41
  exports.responses = responses;
43
42
  const client = __importStar(require("./lib/client"));
43
+ const ekm_waiter = __importStar(require("./lib/ekm-waiter"));
44
44
  const kmsmanagement_waiter = __importStar(require("./lib/kmsmanagement-waiter"));
45
45
  const kmsvault_waiter = __importStar(require("./lib/kmsvault-waiter"));
46
+ exports.EkmClient = client.EkmClient;
47
+ exports.EkmWaiter = ekm_waiter.EkmWaiter;
46
48
  exports.KmsCryptoClient = client.KmsCryptoClient;
47
49
  exports.KmsManagementClient = client.KmsManagementClient;
48
50
  exports.KmsManagementWaiter = kmsmanagement_waiter.KmsManagementWaiter;
package/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/keymanagement/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;GAaG;;;;;;;;;;;;;;;;;;;;;;AAEH,wDAA0C;AAQjC,4BAAQ;AAPjB,oDAAsC;AAM7B,wBAAM;AALf,0DAA4C;AAOnC,8BAAS;AANlB,qDAAuC;AACvC,iFAAmE;AACnE,uEAAyD;AAK3C,QAAA,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,QAAA,mBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,QAAA,mBAAmB,GAAG,oBAAoB,CAAC,mBAAmB,CAAC;AAC/D,QAAA,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;AACvC,QAAA,cAAc,GAAG,eAAe,CAAC,cAAc,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/keymanagement/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;GAYG;;;;;;;;;;;;;;;;;;;;;;AAEH,wDAA0C;AASjC,4BAAQ;AARjB,oDAAsC;AAO7B,wBAAM;AANf,0DAA4C;AAQnC,8BAAS;AAPlB,qDAAuC;AACvC,6DAA+C;AAC/C,iFAAmE;AACnE,uEAAyD;AAK3C,QAAA,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;AAC7B,QAAA,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC;AACjC,QAAA,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,QAAA,mBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,QAAA,mBAAmB,GAAG,oBAAoB,CAAC,mBAAmB,CAAC;AAC/D,QAAA,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;AACvC,QAAA,cAAc,GAAG,eAAe,CAAC,cAAc,CAAC"}
package/lib/client.d.ts CHANGED
@@ -1,7 +1,6 @@
1
1
  /**
2
- * Vault Service Key Management API
3
- * API for managing and performing operations with keys and vaults. (For the API for managing secrets, see the Vault Service
4
- Secret Management API. For the API for retrieving secrets, see the Vault Service Secret Retrieval API.)
2
+ * Vault Key Management API
3
+ * Use the Key Management API to manage vaults and keys. For more information, see [Managing Vaults](/Content/KeyManagement/Tasks/managingvaults.htm) and [Managing Keys](/Content/KeyManagement/Tasks/managingkeys.htm).
5
4
 
6
5
  * OpenAPI spec version: release
7
6
  * Contact: sparta_kms_us_grp@oracle.com
@@ -16,8 +15,154 @@ import common = require("oci-common");
16
15
  import * as requests from "./request";
17
16
  import * as model from "./model";
18
17
  import * as responses from "./response";
18
+ import { EkmWaiter } from "./ekm-waiter";
19
19
  import { KmsManagementWaiter } from "./kmsmanagement-waiter";
20
20
  import { KmsVaultWaiter } from "./kmsvault-waiter";
21
+ export declare enum EkmApiKeys {
22
+ }
23
+ /**
24
+ * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
25
+ */
26
+ export declare class EkmClient {
27
+ protected static serviceEndpointTemplate: string;
28
+ protected static endpointServiceName: string;
29
+ protected "_realmSpecificEndpointTemplateEnabled": boolean;
30
+ protected "_endpoint": string;
31
+ protected "_defaultHeaders": any;
32
+ protected "_waiters": EkmWaiter;
33
+ protected "_clientConfiguration": common.ClientConfiguration;
34
+ protected _circuitBreaker: null;
35
+ protected _httpOptions: any;
36
+ protected _bodyDuplexMode: any;
37
+ targetService: string;
38
+ protected _regionId: string;
39
+ protected "_region": common.Region;
40
+ protected _lastSetRegionOrRegionId: string;
41
+ protected _httpClient: common.HttpClient;
42
+ constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
43
+ /**
44
+ * Get the endpoint that is being used to call (ex, https://www.example.com).
45
+ */
46
+ get endpoint(): string;
47
+ /**
48
+ * Sets the endpoint to call (ex, https://www.example.com).
49
+ * @param endpoint The endpoint of the service.
50
+ */
51
+ set endpoint(endpoint: string);
52
+ get logger(): import("oci-common/lib/log").Logger;
53
+ /**
54
+ * Determines whether realm specific endpoint should be used or not.
55
+ * Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"
56
+ * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template
57
+ */
58
+ set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean);
59
+ /**
60
+ * Sets the region to call (ex, Region.US_PHOENIX_1).
61
+ * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
62
+ * @param region The region of the service.
63
+ */
64
+ set region(region: common.Region);
65
+ /**
66
+ * Sets the regionId to call (ex, 'us-phoenix-1').
67
+ *
68
+ * Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}.
69
+ * If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1
70
+ * and then call {@link #endpoint(String) endpoint}.
71
+ * @param regionId The public region ID.
72
+ */
73
+ set regionId(regionId: string);
74
+ /**
75
+ * Creates a new EkmWaiter for resources for this service.
76
+ *
77
+ * @param config The waiter configuration for termination and delay strategy
78
+ * @return The service waiters.
79
+ */
80
+ createWaiters(config?: common.WaiterConfiguration): EkmWaiter;
81
+ /**
82
+ * Gets the waiters available for resources for this service.
83
+ *
84
+ * @return The service waiters.
85
+ */
86
+ getWaiters(): EkmWaiter;
87
+ /**
88
+ * Create a new EKMS private endpoint used to connect to external key manager system
89
+ * This operation does not retry by default if the user has not defined a retry configuration.
90
+ * @param CreateEkmsPrivateEndpointRequest
91
+ * @return CreateEkmsPrivateEndpointResponse
92
+ * @throws OciError when an error occurs
93
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/CreateEkmsPrivateEndpoint.ts.html |here} to see how to use CreateEkmsPrivateEndpoint API.
94
+ */
95
+ createEkmsPrivateEndpoint(createEkmsPrivateEndpointRequest: requests.CreateEkmsPrivateEndpointRequest): Promise<responses.CreateEkmsPrivateEndpointResponse>;
96
+ /**
97
+ * Deletes EKMS private endpoint by identifier.
98
+ * This operation does not retry by default if the user has not defined a retry configuration.
99
+ * @param DeleteEkmsPrivateEndpointRequest
100
+ * @return DeleteEkmsPrivateEndpointResponse
101
+ * @throws OciError when an error occurs
102
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/DeleteEkmsPrivateEndpoint.ts.html |here} to see how to use DeleteEkmsPrivateEndpoint API.
103
+ */
104
+ deleteEkmsPrivateEndpoint(deleteEkmsPrivateEndpointRequest: requests.DeleteEkmsPrivateEndpointRequest): Promise<responses.DeleteEkmsPrivateEndpointResponse>;
105
+ /**
106
+ * Gets a specific EKMS private by identifier.
107
+ * This operation does not retry by default if the user has not defined a retry configuration.
108
+ * @param GetEkmsPrivateEndpointRequest
109
+ * @return GetEkmsPrivateEndpointResponse
110
+ * @throws OciError when an error occurs
111
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/GetEkmsPrivateEndpoint.ts.html |here} to see how to use GetEkmsPrivateEndpoint API.
112
+ */
113
+ getEkmsPrivateEndpoint(getEkmsPrivateEndpointRequest: requests.GetEkmsPrivateEndpointRequest): Promise<responses.GetEkmsPrivateEndpointResponse>;
114
+ /**
115
+ * Returns a list of all the EKMS private endpoints in the specified compartment.
116
+ *
117
+ * This operation does not retry by default if the user has not defined a retry configuration.
118
+ * @param ListEkmsPrivateEndpointsRequest
119
+ * @return ListEkmsPrivateEndpointsResponse
120
+ * @throws OciError when an error occurs
121
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/ListEkmsPrivateEndpoints.ts.html |here} to see how to use ListEkmsPrivateEndpoints API.
122
+ */
123
+ listEkmsPrivateEndpoints(listEkmsPrivateEndpointsRequest: requests.ListEkmsPrivateEndpointsRequest): Promise<responses.ListEkmsPrivateEndpointsResponse>;
124
+ /**
125
+ * NOTE: This function is deprecated in favor of listEkmsPrivateEndpointsRecordIterator function.
126
+ * Creates a new async iterator which will iterate over the models.EkmsPrivateEndpointSummary objects
127
+ * contained in responses from the listEkmsPrivateEndpoints operation. This iterator will fetch more data from the
128
+ * server as needed.
129
+ *
130
+ * @param request a request which can be sent to the service operation
131
+ */
132
+ listAllEkmsPrivateEndpoints(request: requests.ListEkmsPrivateEndpointsRequest): AsyncIterableIterator<model.EkmsPrivateEndpointSummary>;
133
+ /**
134
+ * NOTE: This function is deprecated in favor of listEkmsPrivateEndpointsResponseIterator function.
135
+ * Creates a new async iterator which will iterate over the responses received from the listEkmsPrivateEndpoints operation. This iterator
136
+ * will fetch more data from the server as needed.
137
+ *
138
+ * @param request a request which can be sent to the service operation
139
+ */
140
+ listAllEkmsPrivateEndpointsResponses(request: requests.ListEkmsPrivateEndpointsRequest): AsyncIterableIterator<responses.ListEkmsPrivateEndpointsResponse>;
141
+ /**
142
+ * Creates a new async iterator which will iterate over the models.EkmsPrivateEndpointSummary objects
143
+ * contained in responses from the listEkmsPrivateEndpoints operation. This iterator will fetch more data from the
144
+ * server as needed.
145
+ *
146
+ * @param request a request which can be sent to the service operation
147
+ */
148
+ listEkmsPrivateEndpointsRecordIterator(request: requests.ListEkmsPrivateEndpointsRequest): AsyncIterableIterator<model.EkmsPrivateEndpointSummary>;
149
+ /**
150
+ * Creates a new async iterator which will iterate over the responses received from the listEkmsPrivateEndpoints operation. This iterator
151
+ * will fetch more data from the server as needed.
152
+ *
153
+ * @param request a request which can be sent to the service operation
154
+ */
155
+ listEkmsPrivateEndpointsResponseIterator(request: requests.ListEkmsPrivateEndpointsRequest): AsyncIterableIterator<responses.ListEkmsPrivateEndpointsResponse>;
156
+ /**
157
+ * Updates EKMS private endpoint.
158
+ * This operation does not retry by default if the user has not defined a retry configuration.
159
+ * @param UpdateEkmsPrivateEndpointRequest
160
+ * @return UpdateEkmsPrivateEndpointResponse
161
+ * @throws OciError when an error occurs
162
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/UpdateEkmsPrivateEndpoint.ts.html |here} to see how to use UpdateEkmsPrivateEndpoint API.
163
+ */
164
+ updateEkmsPrivateEndpoint(updateEkmsPrivateEndpointRequest: requests.UpdateEkmsPrivateEndpointRequest): Promise<responses.UpdateEkmsPrivateEndpointResponse>;
165
+ }
21
166
  export declare enum KmsCryptoApiKeys {
22
167
  }
23
168
  /**
@@ -59,7 +204,7 @@ export declare class KmsCryptoClient {
59
204
  * @param DecryptRequest
60
205
  * @return DecryptResponse
61
206
  * @throws OciError when an error occurs
62
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/Decrypt.ts.html |here} to see how to use Decrypt API.
207
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/Decrypt.ts.html |here} to see how to use Decrypt API.
63
208
  */
64
209
  decrypt(decryptRequest: requests.DecryptRequest): Promise<responses.DecryptResponse>;
65
210
  /**
@@ -70,19 +215,20 @@ export declare class KmsCryptoClient {
70
215
  * @param EncryptRequest
71
216
  * @return EncryptResponse
72
217
  * @throws OciError when an error occurs
73
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/Encrypt.ts.html |here} to see how to use Encrypt API.
218
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/Encrypt.ts.html |here} to see how to use Encrypt API.
74
219
  */
75
220
  encrypt(encryptRequest: requests.EncryptRequest): Promise<responses.EncryptResponse>;
76
221
  /**
77
222
  * Exports a specific version of a master encryption key according to the details of the request. For their protection,
78
223
  * keys that you create and store on a hardware security module (HSM) can never leave the HSM. You can only export keys
79
224
  * stored on the server. For export, the key version is encrypted by an RSA public key that you provide.
225
+ * This operation is not supported for keys having protection mode `EXTERNAL`.
80
226
  *
81
227
  * This operation does not retry by default if the user has not defined a retry configuration.
82
228
  * @param ExportKeyRequest
83
229
  * @return ExportKeyResponse
84
230
  * @throws OciError when an error occurs
85
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/ExportKey.ts.html |here} to see how to use ExportKey API.
231
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/ExportKey.ts.html |here} to see how to use ExportKey API.
86
232
  */
87
233
  exportKey(exportKeyRequest: requests.ExportKeyRequest): Promise<responses.ExportKeyResponse>;
88
234
  /**
@@ -92,31 +238,33 @@ export declare class KmsCryptoClient {
92
238
  * @param GenerateDataEncryptionKeyRequest
93
239
  * @return GenerateDataEncryptionKeyResponse
94
240
  * @throws OciError when an error occurs
95
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/GenerateDataEncryptionKey.ts.html |here} to see how to use GenerateDataEncryptionKey API.
241
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/GenerateDataEncryptionKey.ts.html |here} to see how to use GenerateDataEncryptionKey API.
96
242
  */
97
243
  generateDataEncryptionKey(generateDataEncryptionKeyRequest: requests.GenerateDataEncryptionKeyRequest): Promise<responses.GenerateDataEncryptionKeyResponse>;
98
244
  /**
99
245
  * Creates a digital signature for a message or message digest by using the private key of a public-private key pair,
100
246
  * also known as an asymmetric key. To verify the generated signature, you can use the [Verify](https://docs.cloud.oracle.com/api/#/en/key/latest/VerifiedData/Verify)
101
247
  * operation. Or, if you want to validate the signature outside of the service, you can do so by using the public key of the same asymmetric key.
248
+ * This operation is not supported for keys having protection mode `EXTERNAL`.
102
249
  *
103
250
  * This operation does not retry by default if the user has not defined a retry configuration.
104
251
  * @param SignRequest
105
252
  * @return SignResponse
106
253
  * @throws OciError when an error occurs
107
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/Sign.ts.html |here} to see how to use Sign API.
254
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/Sign.ts.html |here} to see how to use Sign API.
108
255
  */
109
256
  sign(signRequest: requests.SignRequest): Promise<responses.SignResponse>;
110
257
  /**
111
258
  * Verifies a digital signature that was generated by the [Sign](https://docs.cloud.oracle.com/api/#/en/key/latest/SignedData/Sign) operation
112
259
  * by using the public key of the same asymmetric key that was used to sign the data. If you want to validate the
113
260
  * digital signature outside of the service, you can do so by using the public key of the asymmetric key.
261
+ * This operation is not supported for keys having protection mode `EXTERNAL`.
114
262
  *
115
263
  * This operation does not retry by default if the user has not defined a retry configuration.
116
264
  * @param VerifyRequest
117
265
  * @return VerifyResponse
118
266
  * @throws OciError when an error occurs
119
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/Verify.ts.html |here} to see how to use Verify API.
267
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/Verify.ts.html |here} to see how to use Verify API.
120
268
  */
121
269
  verify(verifyRequest: requests.VerifyRequest): Promise<responses.VerifyResponse>;
122
270
  }
@@ -176,7 +324,7 @@ export declare class KmsManagementClient {
176
324
  * @param BackupKeyRequest
177
325
  * @return BackupKeyResponse
178
326
  * @throws OciError when an error occurs
179
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/BackupKey.ts.html |here} to see how to use BackupKey API.
327
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/BackupKey.ts.html |here} to see how to use BackupKey API.
180
328
  */
181
329
  backupKey(backupKeyRequest: requests.BackupKeyRequest): Promise<responses.BackupKeyResponse>;
182
330
  /**
@@ -193,7 +341,7 @@ export declare class KmsManagementClient {
193
341
  * @param CancelKeyDeletionRequest
194
342
  * @return CancelKeyDeletionResponse
195
343
  * @throws OciError when an error occurs
196
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/CancelKeyDeletion.ts.html |here} to see how to use CancelKeyDeletion API.
344
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/CancelKeyDeletion.ts.html |here} to see how to use CancelKeyDeletion API.
197
345
  */
198
346
  cancelKeyDeletion(cancelKeyDeletionRequest: requests.CancelKeyDeletionRequest): Promise<responses.CancelKeyDeletionResponse>;
199
347
  /**
@@ -210,7 +358,7 @@ export declare class KmsManagementClient {
210
358
  * @param CancelKeyVersionDeletionRequest
211
359
  * @return CancelKeyVersionDeletionResponse
212
360
  * @throws OciError when an error occurs
213
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/CancelKeyVersionDeletion.ts.html |here} to see how to use CancelKeyVersionDeletion API.
361
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/CancelKeyVersionDeletion.ts.html |here} to see how to use CancelKeyVersionDeletion API.
214
362
  */
215
363
  cancelKeyVersionDeletion(cancelKeyVersionDeletionRequest: requests.CancelKeyVersionDeletionRequest): Promise<responses.CancelKeyVersionDeletionResponse>;
216
364
  /**
@@ -228,7 +376,7 @@ export declare class KmsManagementClient {
228
376
  * @param ChangeKeyCompartmentRequest
229
377
  * @return ChangeKeyCompartmentResponse
230
378
  * @throws OciError when an error occurs
231
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/ChangeKeyCompartment.ts.html |here} to see how to use ChangeKeyCompartment API.
379
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/ChangeKeyCompartment.ts.html |here} to see how to use ChangeKeyCompartment API.
232
380
  */
233
381
  changeKeyCompartment(changeKeyCompartmentRequest: requests.ChangeKeyCompartmentRequest): Promise<responses.ChangeKeyCompartmentResponse>;
234
382
  /**
@@ -243,7 +391,7 @@ export declare class KmsManagementClient {
243
391
  * @param CreateKeyRequest
244
392
  * @return CreateKeyResponse
245
393
  * @throws OciError when an error occurs
246
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/CreateKey.ts.html |here} to see how to use CreateKey API.
394
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/CreateKey.ts.html |here} to see how to use CreateKey API.
247
395
  */
248
396
  createKey(createKeyRequest: requests.CreateKeyRequest): Promise<responses.CreateKeyResponse>;
249
397
  /**
@@ -259,7 +407,7 @@ export declare class KmsManagementClient {
259
407
  * @param CreateKeyVersionRequest
260
408
  * @return CreateKeyVersionResponse
261
409
  * @throws OciError when an error occurs
262
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/CreateKeyVersion.ts.html |here} to see how to use CreateKeyVersion API.
410
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/CreateKeyVersion.ts.html |here} to see how to use CreateKeyVersion API.
263
411
  */
264
412
  createKeyVersion(createKeyVersionRequest: requests.CreateKeyVersionRequest): Promise<responses.CreateKeyVersionResponse>;
265
413
  /**
@@ -275,7 +423,7 @@ export declare class KmsManagementClient {
275
423
  * @param DisableKeyRequest
276
424
  * @return DisableKeyResponse
277
425
  * @throws OciError when an error occurs
278
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/DisableKey.ts.html |here} to see how to use DisableKey API.
426
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/DisableKey.ts.html |here} to see how to use DisableKey API.
279
427
  */
280
428
  disableKey(disableKeyRequest: requests.DisableKeyRequest): Promise<responses.DisableKeyResponse>;
281
429
  /**
@@ -291,7 +439,7 @@ export declare class KmsManagementClient {
291
439
  * @param EnableKeyRequest
292
440
  * @return EnableKeyResponse
293
441
  * @throws OciError when an error occurs
294
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/EnableKey.ts.html |here} to see how to use EnableKey API.
442
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/EnableKey.ts.html |here} to see how to use EnableKey API.
295
443
  */
296
444
  enableKey(enableKeyRequest: requests.EnableKeyRequest): Promise<responses.EnableKeyResponse>;
297
445
  /**
@@ -306,7 +454,7 @@ export declare class KmsManagementClient {
306
454
  * @param GetKeyRequest
307
455
  * @return GetKeyResponse
308
456
  * @throws OciError when an error occurs
309
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/GetKey.ts.html |here} to see how to use GetKey API.
457
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/GetKey.ts.html |here} to see how to use GetKey API.
310
458
  */
311
459
  getKey(getKeyRequest: requests.GetKeyRequest): Promise<responses.GetKeyResponse>;
312
460
  /**
@@ -321,7 +469,7 @@ export declare class KmsManagementClient {
321
469
  * @param GetKeyVersionRequest
322
470
  * @return GetKeyVersionResponse
323
471
  * @throws OciError when an error occurs
324
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/GetKeyVersion.ts.html |here} to see how to use GetKeyVersion API.
472
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/GetKeyVersion.ts.html |here} to see how to use GetKeyVersion API.
325
473
  */
326
474
  getKeyVersion(getKeyVersionRequest: requests.GetKeyVersionRequest): Promise<responses.GetKeyVersionResponse>;
327
475
  /**
@@ -334,7 +482,7 @@ export declare class KmsManagementClient {
334
482
  * @param GetReplicationStatusRequest
335
483
  * @return GetReplicationStatusResponse
336
484
  * @throws OciError when an error occurs
337
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/GetReplicationStatus.ts.html |here} to see how to use GetReplicationStatus API.
485
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/GetReplicationStatus.ts.html |here} to see how to use GetReplicationStatus API.
338
486
  */
339
487
  getReplicationStatus(getReplicationStatusRequest: requests.GetReplicationStatusRequest): Promise<responses.GetReplicationStatusResponse>;
340
488
  /**
@@ -345,33 +493,37 @@ export declare class KmsManagementClient {
345
493
  * @param GetWrappingKeyRequest
346
494
  * @return GetWrappingKeyResponse
347
495
  * @throws OciError when an error occurs
348
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/GetWrappingKey.ts.html |here} to see how to use GetWrappingKey API.
496
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/GetWrappingKey.ts.html |here} to see how to use GetWrappingKey API.
349
497
  */
350
498
  getWrappingKey(getWrappingKeyRequest: requests.GetWrappingKeyRequest): Promise<responses.GetWrappingKeyResponse>;
351
499
  /**
352
- * Imports AES key material to create a new key with. The key material must be base64-encoded and
353
- * wrapped by the vault's public RSA wrapping key before you can import it. Key Management supports AES symmetric keys
354
- * that are exactly 16, 24, or 32 bytes. Furthermore, the key length must match what you specify at the time of import.
500
+ * Imports AES and RSA keys to create a new key. The key material must be base64-encoded
501
+ * and wrapped by the vault's public RSA wrapping key before you can import it.
502
+ * Key Management supports both RSA and AES keys. The AES keys are symmetric keys
503
+ * of length 128 bits (16 bytes), 192 bits (24 bytes), or 256 bits (32 bytes), and the RSA keys are asymmetric keys of length 2048 bits (256 bytes), 3072 bits (384 bytes), and 4096 bits (512 bytes).
504
+ * Furthermore, the key length must match what you specify at the time of import. When importing an asymmetric key,
505
+ * only private key must be wrapped in PKCS8 format while the corresponding public key is generated internally by KMS.
355
506
  *
356
507
  * This operation does not retry by default if the user has not defined a retry configuration.
357
508
  * @param ImportKeyRequest
358
509
  * @return ImportKeyResponse
359
510
  * @throws OciError when an error occurs
360
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/ImportKey.ts.html |here} to see how to use ImportKey API.
511
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/ImportKey.ts.html |here} to see how to use ImportKey API.
361
512
  */
362
513
  importKey(importKeyRequest: requests.ImportKeyRequest): Promise<responses.ImportKeyResponse>;
363
514
  /**
364
- * Imports AES key material to create a new key version with, and then rotates the key to begin using the new
515
+ * Imports AES key material to create a new key version and then rotate the key to begin using the new
365
516
  * key version. The key material must be base64-encoded and wrapped by the vault's public RSA wrapping key
366
517
  * before you can import it. Key Management supports AES symmetric keys that are exactly 16, 24, or 32 bytes.
367
518
  * Furthermore, the key length must match the length of the specified key and what you specify as the length
368
- * at the time of import.
519
+ * at the time of import. When importing an asymmetric key, only the private key must be wrapped in PKCS8 format
520
+ * while the corresponding public key is generated internally by KMS.
369
521
  *
370
522
  * This operation does not retry by default if the user has not defined a retry configuration.
371
523
  * @param ImportKeyVersionRequest
372
524
  * @return ImportKeyVersionResponse
373
525
  * @throws OciError when an error occurs
374
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/ImportKeyVersion.ts.html |here} to see how to use ImportKeyVersion API.
526
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/ImportKeyVersion.ts.html |here} to see how to use ImportKeyVersion API.
375
527
  */
376
528
  importKeyVersion(importKeyVersionRequest: requests.ImportKeyVersionRequest): Promise<responses.ImportKeyVersionResponse>;
377
529
  /**
@@ -387,7 +539,7 @@ export declare class KmsManagementClient {
387
539
  * @param ListKeyVersionsRequest
388
540
  * @return ListKeyVersionsResponse
389
541
  * @throws OciError when an error occurs
390
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/ListKeyVersions.ts.html |here} to see how to use ListKeyVersions API.
542
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/ListKeyVersions.ts.html |here} to see how to use ListKeyVersions API.
391
543
  */
392
544
  listKeyVersions(listKeyVersionsRequest: requests.ListKeyVersionsRequest): Promise<responses.ListKeyVersionsResponse>;
393
545
  /**
@@ -434,7 +586,7 @@ export declare class KmsManagementClient {
434
586
  * @param ListKeysRequest
435
587
  * @return ListKeysResponse
436
588
  * @throws OciError when an error occurs
437
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/ListKeys.ts.html |here} to see how to use ListKeys API.
589
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/ListKeys.ts.html |here} to see how to use ListKeys API.
438
590
  */
439
591
  listKeys(listKeysRequest: requests.ListKeysRequest): Promise<responses.ListKeysResponse>;
440
592
  /**
@@ -478,7 +630,7 @@ export declare class KmsManagementClient {
478
630
  * @param RestoreKeyFromFileRequest
479
631
  * @return RestoreKeyFromFileResponse
480
632
  * @throws OciError when an error occurs
481
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/RestoreKeyFromFile.ts.html |here} to see how to use RestoreKeyFromFile API.
633
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/RestoreKeyFromFile.ts.html |here} to see how to use RestoreKeyFromFile API.
482
634
  */
483
635
  restoreKeyFromFile(restoreKeyFromFileRequest: requests.RestoreKeyFromFileRequest): Promise<responses.RestoreKeyFromFileResponse>;
484
636
  /**
@@ -490,7 +642,7 @@ export declare class KmsManagementClient {
490
642
  * @param RestoreKeyFromObjectStoreRequest
491
643
  * @return RestoreKeyFromObjectStoreResponse
492
644
  * @throws OciError when an error occurs
493
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/RestoreKeyFromObjectStore.ts.html |here} to see how to use RestoreKeyFromObjectStore API.
645
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/RestoreKeyFromObjectStore.ts.html |here} to see how to use RestoreKeyFromObjectStore API.
494
646
  */
495
647
  restoreKeyFromObjectStore(restoreKeyFromObjectStoreRequest: requests.RestoreKeyFromObjectStoreRequest): Promise<responses.RestoreKeyFromObjectStoreResponse>;
496
648
  /**
@@ -506,7 +658,7 @@ export declare class KmsManagementClient {
506
658
  * @param ScheduleKeyDeletionRequest
507
659
  * @return ScheduleKeyDeletionResponse
508
660
  * @throws OciError when an error occurs
509
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/ScheduleKeyDeletion.ts.html |here} to see how to use ScheduleKeyDeletion API.
661
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/ScheduleKeyDeletion.ts.html |here} to see how to use ScheduleKeyDeletion API.
510
662
  */
511
663
  scheduleKeyDeletion(scheduleKeyDeletionRequest: requests.ScheduleKeyDeletionRequest): Promise<responses.ScheduleKeyDeletionResponse>;
512
664
  /**
@@ -522,7 +674,7 @@ export declare class KmsManagementClient {
522
674
  * @param ScheduleKeyVersionDeletionRequest
523
675
  * @return ScheduleKeyVersionDeletionResponse
524
676
  * @throws OciError when an error occurs
525
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/ScheduleKeyVersionDeletion.ts.html |here} to see how to use ScheduleKeyVersionDeletion API.
677
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/ScheduleKeyVersionDeletion.ts.html |here} to see how to use ScheduleKeyVersionDeletion API.
526
678
  */
527
679
  scheduleKeyVersionDeletion(scheduleKeyVersionDeletionRequest: requests.ScheduleKeyVersionDeletionRequest): Promise<responses.ScheduleKeyVersionDeletionResponse>;
528
680
  /**
@@ -539,7 +691,7 @@ export declare class KmsManagementClient {
539
691
  * @param UpdateKeyRequest
540
692
  * @return UpdateKeyResponse
541
693
  * @throws OciError when an error occurs
542
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/UpdateKey.ts.html |here} to see how to use UpdateKey API.
694
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/UpdateKey.ts.html |here} to see how to use UpdateKey API.
543
695
  */
544
696
  updateKey(updateKeyRequest: requests.UpdateKeyRequest): Promise<responses.UpdateKeyResponse>;
545
697
  }
@@ -618,7 +770,7 @@ export declare class KmsVaultClient {
618
770
  * @param BackupVaultRequest
619
771
  * @return BackupVaultResponse
620
772
  * @throws OciError when an error occurs
621
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/BackupVault.ts.html |here} to see how to use BackupVault API.
773
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/BackupVault.ts.html |here} to see how to use BackupVault API.
622
774
  */
623
775
  backupVault(backupVaultRequest: requests.BackupVaultRequest): Promise<responses.BackupVaultResponse>;
624
776
  /**
@@ -636,7 +788,7 @@ export declare class KmsVaultClient {
636
788
  * @param CancelVaultDeletionRequest
637
789
  * @return CancelVaultDeletionResponse
638
790
  * @throws OciError when an error occurs
639
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/CancelVaultDeletion.ts.html |here} to see how to use CancelVaultDeletion API.
791
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/CancelVaultDeletion.ts.html |here} to see how to use CancelVaultDeletion API.
640
792
  */
641
793
  cancelVaultDeletion(cancelVaultDeletionRequest: requests.CancelVaultDeletionRequest): Promise<responses.CancelVaultDeletionResponse>;
642
794
  /**
@@ -654,7 +806,7 @@ export declare class KmsVaultClient {
654
806
  * @param ChangeVaultCompartmentRequest
655
807
  * @return ChangeVaultCompartmentResponse
656
808
  * @throws OciError when an error occurs
657
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/ChangeVaultCompartment.ts.html |here} to see how to use ChangeVaultCompartment API.
809
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/ChangeVaultCompartment.ts.html |here} to see how to use ChangeVaultCompartment API.
658
810
  */
659
811
  changeVaultCompartment(changeVaultCompartmentRequest: requests.ChangeVaultCompartmentRequest): Promise<responses.ChangeVaultCompartmentResponse>;
660
812
  /**
@@ -672,7 +824,7 @@ export declare class KmsVaultClient {
672
824
  * @param CreateVaultRequest
673
825
  * @return CreateVaultResponse
674
826
  * @throws OciError when an error occurs
675
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/CreateVault.ts.html |here} to see how to use CreateVault API.
827
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/CreateVault.ts.html |here} to see how to use CreateVault API.
676
828
  */
677
829
  createVault(createVaultRequest: requests.CreateVaultRequest): Promise<responses.CreateVaultResponse>;
678
830
  /**
@@ -691,7 +843,7 @@ export declare class KmsVaultClient {
691
843
  * @param CreateVaultReplicaRequest
692
844
  * @return CreateVaultReplicaResponse
693
845
  * @throws OciError when an error occurs
694
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/CreateVaultReplica.ts.html |here} to see how to use CreateVaultReplica API.
846
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/CreateVaultReplica.ts.html |here} to see how to use CreateVaultReplica API.
695
847
  */
696
848
  createVaultReplica(createVaultReplicaRequest: requests.CreateVaultReplicaRequest): Promise<responses.CreateVaultReplicaResponse>;
697
849
  /**
@@ -706,7 +858,7 @@ export declare class KmsVaultClient {
706
858
  * @param DeleteVaultReplicaRequest
707
859
  * @return DeleteVaultReplicaResponse
708
860
  * @throws OciError when an error occurs
709
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/DeleteVaultReplica.ts.html |here} to see how to use DeleteVaultReplica API.
861
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/DeleteVaultReplica.ts.html |here} to see how to use DeleteVaultReplica API.
710
862
  */
711
863
  deleteVaultReplica(deleteVaultReplicaRequest: requests.DeleteVaultReplicaRequest): Promise<responses.DeleteVaultReplicaResponse>;
712
864
  /**
@@ -721,7 +873,7 @@ export declare class KmsVaultClient {
721
873
  * @param GetVaultRequest
722
874
  * @return GetVaultResponse
723
875
  * @throws OciError when an error occurs
724
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/GetVault.ts.html |here} to see how to use GetVault API.
876
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/GetVault.ts.html |here} to see how to use GetVault API.
725
877
  */
726
878
  getVault(getVaultRequest: requests.GetVaultRequest): Promise<responses.GetVaultResponse>;
727
879
  /**
@@ -731,7 +883,7 @@ export declare class KmsVaultClient {
731
883
  * @param GetVaultUsageRequest
732
884
  * @return GetVaultUsageResponse
733
885
  * @throws OciError when an error occurs
734
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/GetVaultUsage.ts.html |here} to see how to use GetVaultUsage API.
886
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/GetVaultUsage.ts.html |here} to see how to use GetVaultUsage API.
735
887
  */
736
888
  getVaultUsage(getVaultUsageRequest: requests.GetVaultUsageRequest): Promise<responses.GetVaultUsageResponse>;
737
889
  /**
@@ -746,7 +898,7 @@ export declare class KmsVaultClient {
746
898
  * @param ListVaultReplicasRequest
747
899
  * @return ListVaultReplicasResponse
748
900
  * @throws OciError when an error occurs
749
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/ListVaultReplicas.ts.html |here} to see how to use ListVaultReplicas API.
901
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/ListVaultReplicas.ts.html |here} to see how to use ListVaultReplicas API.
750
902
  */
751
903
  listVaultReplicas(listVaultReplicasRequest: requests.ListVaultReplicasRequest): Promise<responses.ListVaultReplicasResponse>;
752
904
  /**
@@ -793,7 +945,7 @@ export declare class KmsVaultClient {
793
945
  * @param ListVaultsRequest
794
946
  * @return ListVaultsResponse
795
947
  * @throws OciError when an error occurs
796
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/ListVaults.ts.html |here} to see how to use ListVaults API.
948
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/ListVaults.ts.html |here} to see how to use ListVaults API.
797
949
  */
798
950
  listVaults(listVaultsRequest: requests.ListVaultsRequest): Promise<responses.ListVaultsResponse>;
799
951
  /**
@@ -837,7 +989,7 @@ export declare class KmsVaultClient {
837
989
  * @param RestoreVaultFromFileRequest
838
990
  * @return RestoreVaultFromFileResponse
839
991
  * @throws OciError when an error occurs
840
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/RestoreVaultFromFile.ts.html |here} to see how to use RestoreVaultFromFile API.
992
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/RestoreVaultFromFile.ts.html |here} to see how to use RestoreVaultFromFile API.
841
993
  */
842
994
  restoreVaultFromFile(restoreVaultFromFileRequest: requests.RestoreVaultFromFileRequest): Promise<responses.RestoreVaultFromFileResponse>;
843
995
  /**
@@ -849,7 +1001,7 @@ export declare class KmsVaultClient {
849
1001
  * @param RestoreVaultFromObjectStoreRequest
850
1002
  * @return RestoreVaultFromObjectStoreResponse
851
1003
  * @throws OciError when an error occurs
852
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/RestoreVaultFromObjectStore.ts.html |here} to see how to use RestoreVaultFromObjectStore API.
1004
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/RestoreVaultFromObjectStore.ts.html |here} to see how to use RestoreVaultFromObjectStore API.
853
1005
  */
854
1006
  restoreVaultFromObjectStore(restoreVaultFromObjectStoreRequest: requests.RestoreVaultFromObjectStoreRequest): Promise<responses.RestoreVaultFromObjectStoreResponse>;
855
1007
  /**
@@ -868,7 +1020,7 @@ export declare class KmsVaultClient {
868
1020
  * @param ScheduleVaultDeletionRequest
869
1021
  * @return ScheduleVaultDeletionResponse
870
1022
  * @throws OciError when an error occurs
871
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/ScheduleVaultDeletion.ts.html |here} to see how to use ScheduleVaultDeletion API.
1023
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/ScheduleVaultDeletion.ts.html |here} to see how to use ScheduleVaultDeletion API.
872
1024
  */
873
1025
  scheduleVaultDeletion(scheduleVaultDeletionRequest: requests.ScheduleVaultDeletionRequest): Promise<responses.ScheduleVaultDeletionResponse>;
874
1026
  /**
@@ -885,7 +1037,7 @@ export declare class KmsVaultClient {
885
1037
  * @param UpdateVaultRequest
886
1038
  * @return UpdateVaultResponse
887
1039
  * @throws OciError when an error occurs
888
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.1/keymanagement/UpdateVault.ts.html |here} to see how to use UpdateVault API.
1040
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.70.3/keymanagement/UpdateVault.ts.html |here} to see how to use UpdateVault API.
889
1041
  */
890
1042
  updateVault(updateVaultRequest: requests.UpdateVaultRequest): Promise<responses.UpdateVaultResponse>;
891
1043
  }