oci-keymanagement 2.4.0 → 2.6.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.
- package/LICENSE.txt +6 -0
- package/lib/client.d.ts +159 -41
- package/lib/client.js +278 -82
- package/lib/client.js.map +1 -1
- package/lib/request/backup-key-request.d.ts +1 -1
- package/lib/request/backup-vault-request.d.ts +1 -1
- package/lib/request/cancel-key-deletion-request.d.ts +1 -1
- package/lib/request/cancel-key-version-deletion-request.d.ts +1 -1
- package/lib/request/cancel-vault-deletion-request.d.ts +1 -1
- package/lib/request/change-key-compartment-request.d.ts +1 -1
- package/lib/request/change-vault-compartment-request.d.ts +1 -1
- package/lib/request/create-key-request.d.ts +1 -1
- package/lib/request/create-key-version-request.d.ts +1 -1
- package/lib/request/create-vault-replica-request.d.ts +1 -1
- package/lib/request/create-vault-request.d.ts +1 -1
- package/lib/request/decrypt-request.d.ts +1 -1
- package/lib/request/delete-vault-replica-request.d.ts +1 -1
- package/lib/request/disable-key-request.d.ts +1 -1
- package/lib/request/enable-key-request.d.ts +1 -1
- package/lib/request/encrypt-request.d.ts +1 -1
- package/lib/request/export-key-request.d.ts +1 -1
- package/lib/request/generate-data-encryption-key-request.d.ts +1 -1
- package/lib/request/get-key-request.d.ts +1 -1
- package/lib/request/get-key-version-request.d.ts +1 -1
- package/lib/request/get-replication-status-request.d.ts +1 -1
- package/lib/request/get-vault-request.d.ts +1 -1
- package/lib/request/get-vault-usage-request.d.ts +1 -1
- package/lib/request/get-wrapping-key-request.d.ts +1 -1
- package/lib/request/import-key-request.d.ts +1 -1
- package/lib/request/import-key-version-request.d.ts +1 -1
- package/lib/request/list-key-versions-request.d.ts +1 -1
- package/lib/request/list-keys-request.d.ts +1 -1
- package/lib/request/list-vault-replicas-request.d.ts +1 -1
- package/lib/request/list-vaults-request.d.ts +1 -1
- package/lib/request/restore-key-from-file-request.d.ts +1 -1
- package/lib/request/restore-key-from-object-store-request.d.ts +1 -1
- package/lib/request/restore-vault-from-file-request.d.ts +1 -1
- package/lib/request/restore-vault-from-object-store-request.d.ts +1 -1
- package/lib/request/schedule-key-deletion-request.d.ts +1 -1
- package/lib/request/schedule-key-version-deletion-request.d.ts +1 -1
- package/lib/request/schedule-vault-deletion-request.d.ts +1 -1
- package/lib/request/sign-request.d.ts +1 -1
- package/lib/request/update-key-request.d.ts +1 -1
- package/lib/request/update-vault-request.d.ts +1 -1
- package/lib/request/verify-request.d.ts +1 -1
- package/package.json +3 -3
package/lib/client.d.ts
CHANGED
|
@@ -20,6 +20,9 @@ import { KmsManagementWaiter } from "./kmsmanagement-waiter";
|
|
|
20
20
|
import { KmsVaultWaiter } from "./kmsvault-waiter";
|
|
21
21
|
export declare enum KmsCryptoApiKeys {
|
|
22
22
|
}
|
|
23
|
+
/**
|
|
24
|
+
* This service client does not use circuit breakers by default if the user has not defined a circuit breaker configuration.
|
|
25
|
+
*/
|
|
23
26
|
export declare class KmsCryptoClient {
|
|
24
27
|
protected static serviceEndpointTemplate: string;
|
|
25
28
|
protected "_endpoint": string;
|
|
@@ -41,20 +44,22 @@ export declare class KmsCryptoClient {
|
|
|
41
44
|
/**
|
|
42
45
|
* Decrypts data using the given [DecryptDataDetails](https://docs.cloud.oracle.com/api/#/en/key/latest/datatypes/DecryptDataDetails) resource.
|
|
43
46
|
*
|
|
47
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
44
48
|
* @param DecryptRequest
|
|
45
49
|
* @return DecryptResponse
|
|
46
50
|
* @throws OciError when an error occurs
|
|
47
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
51
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/Decrypt.ts.html |here} to see how to use Decrypt API.
|
|
48
52
|
*/
|
|
49
53
|
decrypt(decryptRequest: requests.DecryptRequest): Promise<responses.DecryptResponse>;
|
|
50
54
|
/**
|
|
51
55
|
* Encrypts data using the given [EncryptDataDetails](https://docs.cloud.oracle.com/api/#/en/key/latest/datatypes/EncryptDataDetails) resource.
|
|
52
56
|
* Plaintext included in the example request is a base64-encoded value of a UTF-8 string.
|
|
53
57
|
*
|
|
58
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
54
59
|
* @param EncryptRequest
|
|
55
60
|
* @return EncryptResponse
|
|
56
61
|
* @throws OciError when an error occurs
|
|
57
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
62
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/Encrypt.ts.html |here} to see how to use Encrypt API.
|
|
58
63
|
*/
|
|
59
64
|
encrypt(encryptRequest: requests.EncryptRequest): Promise<responses.EncryptResponse>;
|
|
60
65
|
/**
|
|
@@ -62,19 +67,21 @@ export declare class KmsCryptoClient {
|
|
|
62
67
|
* keys that you create and store on a hardware security module (HSM) can never leave the HSM. You can only export keys
|
|
63
68
|
* stored on the server. For export, the key version is encrypted by an RSA public key that you provide.
|
|
64
69
|
*
|
|
70
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
65
71
|
* @param ExportKeyRequest
|
|
66
72
|
* @return ExportKeyResponse
|
|
67
73
|
* @throws OciError when an error occurs
|
|
68
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
74
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/ExportKey.ts.html |here} to see how to use ExportKey API.
|
|
69
75
|
*/
|
|
70
76
|
exportKey(exportKeyRequest: requests.ExportKeyRequest): Promise<responses.ExportKeyResponse>;
|
|
71
77
|
/**
|
|
72
78
|
* Generates a key that you can use to encrypt or decrypt data.
|
|
73
79
|
*
|
|
80
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
74
81
|
* @param GenerateDataEncryptionKeyRequest
|
|
75
82
|
* @return GenerateDataEncryptionKeyResponse
|
|
76
83
|
* @throws OciError when an error occurs
|
|
77
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
84
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/GenerateDataEncryptionKey.ts.html |here} to see how to use GenerateDataEncryptionKey API.
|
|
78
85
|
*/
|
|
79
86
|
generateDataEncryptionKey(generateDataEncryptionKeyRequest: requests.GenerateDataEncryptionKeyRequest): Promise<responses.GenerateDataEncryptionKeyResponse>;
|
|
80
87
|
/**
|
|
@@ -82,10 +89,11 @@ export declare class KmsCryptoClient {
|
|
|
82
89
|
* 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)
|
|
83
90
|
* 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.
|
|
84
91
|
*
|
|
92
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
85
93
|
* @param SignRequest
|
|
86
94
|
* @return SignResponse
|
|
87
95
|
* @throws OciError when an error occurs
|
|
88
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
96
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/Sign.ts.html |here} to see how to use Sign API.
|
|
89
97
|
*/
|
|
90
98
|
sign(signRequest: requests.SignRequest): Promise<responses.SignResponse>;
|
|
91
99
|
/**
|
|
@@ -93,15 +101,19 @@ export declare class KmsCryptoClient {
|
|
|
93
101
|
* by using the public key of the same asymmetric key that was used to sign the data. If you want to validate the
|
|
94
102
|
* digital signature outside of the service, you can do so by using the public key of the asymmetric key.
|
|
95
103
|
*
|
|
104
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
96
105
|
* @param VerifyRequest
|
|
97
106
|
* @return VerifyResponse
|
|
98
107
|
* @throws OciError when an error occurs
|
|
99
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
108
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/Verify.ts.html |here} to see how to use Verify API.
|
|
100
109
|
*/
|
|
101
110
|
verify(verifyRequest: requests.VerifyRequest): Promise<responses.VerifyResponse>;
|
|
102
111
|
}
|
|
103
112
|
export declare enum KmsManagementApiKeys {
|
|
104
113
|
}
|
|
114
|
+
/**
|
|
115
|
+
* This service client does not use circuit breakers by default if the user has not defined a circuit breaker configuration.
|
|
116
|
+
*/
|
|
105
117
|
export declare class KmsManagementClient {
|
|
106
118
|
protected static serviceEndpointTemplate: string;
|
|
107
119
|
protected "_endpoint": string;
|
|
@@ -138,10 +150,11 @@ export declare class KmsManagementClient {
|
|
|
138
150
|
* Backs up an encrypted file that contains all key versions and metadata of the specified key so that you can restore
|
|
139
151
|
* the key later. The file also contains the metadata of the vault that the key belonged to.
|
|
140
152
|
*
|
|
153
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
141
154
|
* @param BackupKeyRequest
|
|
142
155
|
* @return BackupKeyResponse
|
|
143
156
|
* @throws OciError when an error occurs
|
|
144
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
157
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/BackupKey.ts.html |here} to see how to use BackupKey API.
|
|
145
158
|
*/
|
|
146
159
|
backupKey(backupKeyRequest: requests.BackupKeyRequest): Promise<responses.BackupKeyResponse>;
|
|
147
160
|
/**
|
|
@@ -154,10 +167,11 @@ export declare class KmsManagementClient {
|
|
|
154
167
|
* throttle this call to reject an otherwise valid request when the total rate of provisioning
|
|
155
168
|
* write operations exceeds 10 requests per second for a given tenancy.
|
|
156
169
|
*
|
|
170
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
157
171
|
* @param CancelKeyDeletionRequest
|
|
158
172
|
* @return CancelKeyDeletionResponse
|
|
159
173
|
* @throws OciError when an error occurs
|
|
160
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
174
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/CancelKeyDeletion.ts.html |here} to see how to use CancelKeyDeletion API.
|
|
161
175
|
*/
|
|
162
176
|
cancelKeyDeletion(cancelKeyDeletionRequest: requests.CancelKeyDeletionRequest): Promise<responses.CancelKeyDeletionResponse>;
|
|
163
177
|
/**
|
|
@@ -170,10 +184,11 @@ export declare class KmsManagementClient {
|
|
|
170
184
|
* throttle this call to reject an otherwise valid request when the total rate of provisioning
|
|
171
185
|
* write operations exceeds 10 requests per second for a given tenancy.
|
|
172
186
|
*
|
|
187
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
173
188
|
* @param CancelKeyVersionDeletionRequest
|
|
174
189
|
* @return CancelKeyVersionDeletionResponse
|
|
175
190
|
* @throws OciError when an error occurs
|
|
176
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
191
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/CancelKeyVersionDeletion.ts.html |here} to see how to use CancelKeyVersionDeletion API.
|
|
177
192
|
*/
|
|
178
193
|
cancelKeyVersionDeletion(cancelKeyVersionDeletionRequest: requests.CancelKeyVersionDeletionRequest): Promise<responses.CancelKeyVersionDeletionResponse>;
|
|
179
194
|
/**
|
|
@@ -187,10 +202,11 @@ export declare class KmsManagementClient {
|
|
|
187
202
|
* throttle this call to reject an otherwise valid request when the total rate of provisioning
|
|
188
203
|
* write operations exceeds 10 requests per second for a given tenancy.
|
|
189
204
|
*
|
|
205
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
190
206
|
* @param ChangeKeyCompartmentRequest
|
|
191
207
|
* @return ChangeKeyCompartmentResponse
|
|
192
208
|
* @throws OciError when an error occurs
|
|
193
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
209
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/ChangeKeyCompartment.ts.html |here} to see how to use ChangeKeyCompartment API.
|
|
194
210
|
*/
|
|
195
211
|
changeKeyCompartment(changeKeyCompartmentRequest: requests.ChangeKeyCompartmentRequest): Promise<responses.ChangeKeyCompartmentResponse>;
|
|
196
212
|
/**
|
|
@@ -201,10 +217,11 @@ export declare class KmsManagementClient {
|
|
|
201
217
|
* to reject an otherwise valid request when the total rate of management write operations exceeds 10
|
|
202
218
|
* requests per second for a given tenancy.
|
|
203
219
|
*
|
|
220
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
204
221
|
* @param CreateKeyRequest
|
|
205
222
|
* @return CreateKeyResponse
|
|
206
223
|
* @throws OciError when an error occurs
|
|
207
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
224
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/CreateKey.ts.html |here} to see how to use CreateKey API.
|
|
208
225
|
*/
|
|
209
226
|
createKey(createKeyRequest: requests.CreateKeyRequest): Promise<responses.CreateKeyResponse>;
|
|
210
227
|
/**
|
|
@@ -216,10 +233,11 @@ export declare class KmsManagementClient {
|
|
|
216
233
|
* otherwise valid request when the total rate of management write operations exceeds 10 requests per second
|
|
217
234
|
* for a given tenancy.
|
|
218
235
|
*
|
|
236
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
219
237
|
* @param CreateKeyVersionRequest
|
|
220
238
|
* @return CreateKeyVersionResponse
|
|
221
239
|
* @throws OciError when an error occurs
|
|
222
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
240
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/CreateKeyVersion.ts.html |here} to see how to use CreateKeyVersion API.
|
|
223
241
|
*/
|
|
224
242
|
createKeyVersion(createKeyVersionRequest: requests.CreateKeyVersionRequest): Promise<responses.CreateKeyVersionResponse>;
|
|
225
243
|
/**
|
|
@@ -231,10 +249,11 @@ export declare class KmsManagementClient {
|
|
|
231
249
|
* otherwise valid request when the total rate of management write operations exceeds 10 requests per second
|
|
232
250
|
* for a given tenancy.
|
|
233
251
|
*
|
|
252
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
234
253
|
* @param DisableKeyRequest
|
|
235
254
|
* @return DisableKeyResponse
|
|
236
255
|
* @throws OciError when an error occurs
|
|
237
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
256
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/DisableKey.ts.html |here} to see how to use DisableKey API.
|
|
238
257
|
*/
|
|
239
258
|
disableKey(disableKeyRequest: requests.DisableKeyRequest): Promise<responses.DisableKeyResponse>;
|
|
240
259
|
/**
|
|
@@ -246,10 +265,11 @@ export declare class KmsManagementClient {
|
|
|
246
265
|
* otherwise valid request when the total rate of management write operations exceeds 10 requests per second
|
|
247
266
|
* for a given tenancy.
|
|
248
267
|
*
|
|
268
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
249
269
|
* @param EnableKeyRequest
|
|
250
270
|
* @return EnableKeyResponse
|
|
251
271
|
* @throws OciError when an error occurs
|
|
252
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
272
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/EnableKey.ts.html |here} to see how to use EnableKey API.
|
|
253
273
|
*/
|
|
254
274
|
enableKey(enableKeyRequest: requests.EnableKeyRequest): Promise<responses.EnableKeyResponse>;
|
|
255
275
|
/**
|
|
@@ -260,10 +280,11 @@ export declare class KmsManagementClient {
|
|
|
260
280
|
* otherwise valid request when the total rate of management read operations exceeds 10 requests per second for
|
|
261
281
|
* a given tenancy.
|
|
262
282
|
*
|
|
283
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
263
284
|
* @param GetKeyRequest
|
|
264
285
|
* @return GetKeyResponse
|
|
265
286
|
* @throws OciError when an error occurs
|
|
266
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
287
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/GetKey.ts.html |here} to see how to use GetKey API.
|
|
267
288
|
*/
|
|
268
289
|
getKey(getKeyRequest: requests.GetKeyRequest): Promise<responses.GetKeyResponse>;
|
|
269
290
|
/**
|
|
@@ -274,10 +295,11 @@ export declare class KmsManagementClient {
|
|
|
274
295
|
* otherwise valid request when the total rate of management read operations exceeds 10 requests per second
|
|
275
296
|
* for a given tenancy.
|
|
276
297
|
*
|
|
298
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
277
299
|
* @param GetKeyVersionRequest
|
|
278
300
|
* @return GetKeyVersionResponse
|
|
279
301
|
* @throws OciError when an error occurs
|
|
280
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
302
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/GetKeyVersion.ts.html |here} to see how to use GetKeyVersion API.
|
|
281
303
|
*/
|
|
282
304
|
getKeyVersion(getKeyVersionRequest: requests.GetKeyVersionRequest): Promise<responses.GetKeyVersionResponse>;
|
|
283
305
|
/**
|
|
@@ -286,20 +308,22 @@ export declare class KmsManagementClient {
|
|
|
286
308
|
* details about whether the operation associated with the given replicationId has been
|
|
287
309
|
* successfully applied across replicas.
|
|
288
310
|
*
|
|
311
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
289
312
|
* @param GetReplicationStatusRequest
|
|
290
313
|
* @return GetReplicationStatusResponse
|
|
291
314
|
* @throws OciError when an error occurs
|
|
292
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
315
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/GetReplicationStatus.ts.html |here} to see how to use GetReplicationStatus API.
|
|
293
316
|
*/
|
|
294
317
|
getReplicationStatus(getReplicationStatusRequest: requests.GetReplicationStatusRequest): Promise<responses.GetReplicationStatusResponse>;
|
|
295
318
|
/**
|
|
296
319
|
* Gets details about the public RSA wrapping key associated with the vault in the endpoint. Each vault has an RSA key-pair that wraps and
|
|
297
320
|
* unwraps AES key material for import into Key Management.
|
|
298
321
|
*
|
|
322
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
299
323
|
* @param GetWrappingKeyRequest
|
|
300
324
|
* @return GetWrappingKeyResponse
|
|
301
325
|
* @throws OciError when an error occurs
|
|
302
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
326
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/GetWrappingKey.ts.html |here} to see how to use GetWrappingKey API.
|
|
303
327
|
*/
|
|
304
328
|
getWrappingKey(getWrappingKeyRequest: requests.GetWrappingKeyRequest): Promise<responses.GetWrappingKeyResponse>;
|
|
305
329
|
/**
|
|
@@ -307,10 +331,11 @@ export declare class KmsManagementClient {
|
|
|
307
331
|
* wrapped by the vault's public RSA wrapping key before you can import it. Key Management supports AES symmetric keys
|
|
308
332
|
* that are exactly 16, 24, or 32 bytes. Furthermore, the key length must match what you specify at the time of import.
|
|
309
333
|
*
|
|
334
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
310
335
|
* @param ImportKeyRequest
|
|
311
336
|
* @return ImportKeyResponse
|
|
312
337
|
* @throws OciError when an error occurs
|
|
313
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
338
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/ImportKey.ts.html |here} to see how to use ImportKey API.
|
|
314
339
|
*/
|
|
315
340
|
importKey(importKeyRequest: requests.ImportKeyRequest): Promise<responses.ImportKeyResponse>;
|
|
316
341
|
/**
|
|
@@ -320,10 +345,11 @@ export declare class KmsManagementClient {
|
|
|
320
345
|
* Furthermore, the key length must match the length of the specified key and what you specify as the length
|
|
321
346
|
* at the time of import.
|
|
322
347
|
*
|
|
348
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
323
349
|
* @param ImportKeyVersionRequest
|
|
324
350
|
* @return ImportKeyVersionResponse
|
|
325
351
|
* @throws OciError when an error occurs
|
|
326
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
352
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/ImportKeyVersion.ts.html |here} to see how to use ImportKeyVersion API.
|
|
327
353
|
*/
|
|
328
354
|
importKeyVersion(importKeyVersionRequest: requests.ImportKeyVersionRequest): Promise<responses.ImportKeyVersionResponse>;
|
|
329
355
|
/**
|
|
@@ -335,13 +361,15 @@ export declare class KmsManagementClient {
|
|
|
335
361
|
* otherwise valid request when the total rate of management read operations exceeds 10 requests per second
|
|
336
362
|
* for a given tenancy.
|
|
337
363
|
*
|
|
364
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
338
365
|
* @param ListKeyVersionsRequest
|
|
339
366
|
* @return ListKeyVersionsResponse
|
|
340
367
|
* @throws OciError when an error occurs
|
|
341
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
368
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/ListKeyVersions.ts.html |here} to see how to use ListKeyVersions API.
|
|
342
369
|
*/
|
|
343
370
|
listKeyVersions(listKeyVersionsRequest: requests.ListKeyVersionsRequest): Promise<responses.ListKeyVersionsResponse>;
|
|
344
371
|
/**
|
|
372
|
+
* NOTE: This function is deprecated in favor of listKeyVersionsRecordIterator function.
|
|
345
373
|
* Creates a new async iterator which will iterate over the models.KeyVersionSummary objects
|
|
346
374
|
* contained in responses from the listKeyVersions operation. This iterator will fetch more data from the
|
|
347
375
|
* server as needed.
|
|
@@ -350,12 +378,28 @@ export declare class KmsManagementClient {
|
|
|
350
378
|
*/
|
|
351
379
|
listAllKeyVersions(request: requests.ListKeyVersionsRequest): AsyncIterableIterator<model.KeyVersionSummary>;
|
|
352
380
|
/**
|
|
381
|
+
* NOTE: This function is deprecated in favor of listKeyVersionsResponseIterator function.
|
|
353
382
|
* Creates a new async iterator which will iterate over the responses received from the listKeyVersions operation. This iterator
|
|
354
383
|
* will fetch more data from the server as needed.
|
|
355
384
|
*
|
|
356
385
|
* @param request a request which can be sent to the service operation
|
|
357
386
|
*/
|
|
358
387
|
listAllKeyVersionsResponses(request: requests.ListKeyVersionsRequest): AsyncIterableIterator<responses.ListKeyVersionsResponse>;
|
|
388
|
+
/**
|
|
389
|
+
* Creates a new async iterator which will iterate over the models.KeyVersionSummary objects
|
|
390
|
+
* contained in responses from the listKeyVersions operation. This iterator will fetch more data from the
|
|
391
|
+
* server as needed.
|
|
392
|
+
*
|
|
393
|
+
* @param request a request which can be sent to the service operation
|
|
394
|
+
*/
|
|
395
|
+
listKeyVersionsRecordIterator(request: requests.ListKeyVersionsRequest): AsyncIterableIterator<model.KeyVersionSummary>;
|
|
396
|
+
/**
|
|
397
|
+
* Creates a new async iterator which will iterate over the responses received from the listKeyVersions operation. This iterator
|
|
398
|
+
* will fetch more data from the server as needed.
|
|
399
|
+
*
|
|
400
|
+
* @param request a request which can be sent to the service operation
|
|
401
|
+
*/
|
|
402
|
+
listKeyVersionsResponseIterator(request: requests.ListKeyVersionsRequest): AsyncIterableIterator<responses.ListKeyVersionsResponse>;
|
|
359
403
|
/**
|
|
360
404
|
* Lists the master encryption keys in the specified vault and compartment.
|
|
361
405
|
* <p>
|
|
@@ -364,13 +408,15 @@ export declare class KmsManagementClient {
|
|
|
364
408
|
* otherwise valid request when the total rate of management read operations exceeds 10 requests per second
|
|
365
409
|
* for a given tenancy.
|
|
366
410
|
*
|
|
411
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
367
412
|
* @param ListKeysRequest
|
|
368
413
|
* @return ListKeysResponse
|
|
369
414
|
* @throws OciError when an error occurs
|
|
370
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
415
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/ListKeys.ts.html |here} to see how to use ListKeys API.
|
|
371
416
|
*/
|
|
372
417
|
listKeys(listKeysRequest: requests.ListKeysRequest): Promise<responses.ListKeysResponse>;
|
|
373
418
|
/**
|
|
419
|
+
* NOTE: This function is deprecated in favor of listKeysRecordIterator function.
|
|
374
420
|
* Creates a new async iterator which will iterate over the models.KeySummary objects
|
|
375
421
|
* contained in responses from the listKeys operation. This iterator will fetch more data from the
|
|
376
422
|
* server as needed.
|
|
@@ -379,21 +425,38 @@ export declare class KmsManagementClient {
|
|
|
379
425
|
*/
|
|
380
426
|
listAllKeys(request: requests.ListKeysRequest): AsyncIterableIterator<model.KeySummary>;
|
|
381
427
|
/**
|
|
428
|
+
* NOTE: This function is deprecated in favor of listKeysResponseIterator function.
|
|
382
429
|
* Creates a new async iterator which will iterate over the responses received from the listKeys operation. This iterator
|
|
383
430
|
* will fetch more data from the server as needed.
|
|
384
431
|
*
|
|
385
432
|
* @param request a request which can be sent to the service operation
|
|
386
433
|
*/
|
|
387
434
|
listAllKeysResponses(request: requests.ListKeysRequest): AsyncIterableIterator<responses.ListKeysResponse>;
|
|
435
|
+
/**
|
|
436
|
+
* Creates a new async iterator which will iterate over the models.KeySummary objects
|
|
437
|
+
* contained in responses from the listKeys operation. This iterator will fetch more data from the
|
|
438
|
+
* server as needed.
|
|
439
|
+
*
|
|
440
|
+
* @param request a request which can be sent to the service operation
|
|
441
|
+
*/
|
|
442
|
+
listKeysRecordIterator(request: requests.ListKeysRequest): AsyncIterableIterator<model.KeySummary>;
|
|
443
|
+
/**
|
|
444
|
+
* Creates a new async iterator which will iterate over the responses received from the listKeys operation. This iterator
|
|
445
|
+
* will fetch more data from the server as needed.
|
|
446
|
+
*
|
|
447
|
+
* @param request a request which can be sent to the service operation
|
|
448
|
+
*/
|
|
449
|
+
listKeysResponseIterator(request: requests.ListKeysRequest): AsyncIterableIterator<responses.ListKeysResponse>;
|
|
388
450
|
/**
|
|
389
451
|
* Restores the specified key to the specified vault, based on information in the backup file provided.
|
|
390
452
|
* If the vault doesn't exist, the operation returns a response with a 404 HTTP status error code. You
|
|
391
453
|
* need to first restore the vault associated with the key.
|
|
392
454
|
*
|
|
455
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
393
456
|
* @param RestoreKeyFromFileRequest
|
|
394
457
|
* @return RestoreKeyFromFileResponse
|
|
395
458
|
* @throws OciError when an error occurs
|
|
396
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
459
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/RestoreKeyFromFile.ts.html |here} to see how to use RestoreKeyFromFile API.
|
|
397
460
|
*/
|
|
398
461
|
restoreKeyFromFile(restoreKeyFromFileRequest: requests.RestoreKeyFromFileRequest): Promise<responses.RestoreKeyFromFileResponse>;
|
|
399
462
|
/**
|
|
@@ -401,10 +464,11 @@ export declare class KmsManagementClient {
|
|
|
401
464
|
* Object Storage location. If the vault doesn't exist, the operation returns a response with a
|
|
402
465
|
* 404 HTTP status error code. You need to first restore the vault associated with the key.
|
|
403
466
|
*
|
|
467
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
404
468
|
* @param RestoreKeyFromObjectStoreRequest
|
|
405
469
|
* @return RestoreKeyFromObjectStoreResponse
|
|
406
470
|
* @throws OciError when an error occurs
|
|
407
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
471
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/RestoreKeyFromObjectStore.ts.html |here} to see how to use RestoreKeyFromObjectStore API.
|
|
408
472
|
*/
|
|
409
473
|
restoreKeyFromObjectStore(restoreKeyFromObjectStoreRequest: requests.RestoreKeyFromObjectStoreRequest): Promise<responses.RestoreKeyFromObjectStoreResponse>;
|
|
410
474
|
/**
|
|
@@ -416,10 +480,11 @@ export declare class KmsManagementClient {
|
|
|
416
480
|
* throttle this call to reject an otherwise valid request when the total rate of provisioning
|
|
417
481
|
* write operations exceeds 10 requests per second for a given tenancy.
|
|
418
482
|
*
|
|
483
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
419
484
|
* @param ScheduleKeyDeletionRequest
|
|
420
485
|
* @return ScheduleKeyDeletionResponse
|
|
421
486
|
* @throws OciError when an error occurs
|
|
422
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
487
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/ScheduleKeyDeletion.ts.html |here} to see how to use ScheduleKeyDeletion API.
|
|
423
488
|
*/
|
|
424
489
|
scheduleKeyDeletion(scheduleKeyDeletionRequest: requests.ScheduleKeyDeletionRequest): Promise<responses.ScheduleKeyDeletionResponse>;
|
|
425
490
|
/**
|
|
@@ -431,10 +496,11 @@ export declare class KmsManagementClient {
|
|
|
431
496
|
* throttle this call to reject an otherwise valid request when the total rate of provisioning
|
|
432
497
|
* write operations exceeds 10 requests per second for a given tenancy.
|
|
433
498
|
*
|
|
499
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
434
500
|
* @param ScheduleKeyVersionDeletionRequest
|
|
435
501
|
* @return ScheduleKeyVersionDeletionResponse
|
|
436
502
|
* @throws OciError when an error occurs
|
|
437
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
503
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/ScheduleKeyVersionDeletion.ts.html |here} to see how to use ScheduleKeyVersionDeletion API.
|
|
438
504
|
*/
|
|
439
505
|
scheduleKeyVersionDeletion(scheduleKeyVersionDeletionRequest: requests.ScheduleKeyVersionDeletionRequest): Promise<responses.ScheduleKeyVersionDeletionResponse>;
|
|
440
506
|
/**
|
|
@@ -447,15 +513,19 @@ export declare class KmsManagementClient {
|
|
|
447
513
|
* otherwise valid request when the total rate of management write operations exceeds 10 requests per second
|
|
448
514
|
* for a given tenancy.
|
|
449
515
|
*
|
|
516
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
450
517
|
* @param UpdateKeyRequest
|
|
451
518
|
* @return UpdateKeyResponse
|
|
452
519
|
* @throws OciError when an error occurs
|
|
453
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
520
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/UpdateKey.ts.html |here} to see how to use UpdateKey API.
|
|
454
521
|
*/
|
|
455
522
|
updateKey(updateKeyRequest: requests.UpdateKeyRequest): Promise<responses.UpdateKeyResponse>;
|
|
456
523
|
}
|
|
457
524
|
export declare enum KmsVaultApiKeys {
|
|
458
525
|
}
|
|
526
|
+
/**
|
|
527
|
+
* This service client does not use circuit breakers by default if the user has not defined a circuit breaker configuration.
|
|
528
|
+
*/
|
|
459
529
|
export declare class KmsVaultClient {
|
|
460
530
|
protected static serviceEndpointTemplate: string;
|
|
461
531
|
protected "_endpoint": string;
|
|
@@ -508,10 +578,11 @@ export declare class KmsVaultClient {
|
|
|
508
578
|
* You can backup a vault whether or not it contains keys. This operation only backs up the
|
|
509
579
|
* metadata of the vault, and does not include key metadata.
|
|
510
580
|
*
|
|
581
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
511
582
|
* @param BackupVaultRequest
|
|
512
583
|
* @return BackupVaultResponse
|
|
513
584
|
* @throws OciError when an error occurs
|
|
514
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
585
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/BackupVault.ts.html |here} to see how to use BackupVault API.
|
|
515
586
|
*/
|
|
516
587
|
backupVault(backupVaultRequest: requests.BackupVaultRequest): Promise<responses.BackupVaultResponse>;
|
|
517
588
|
/**
|
|
@@ -525,10 +596,11 @@ export declare class KmsVaultClient {
|
|
|
525
596
|
* throttle this call to reject an otherwise valid request when the total rate of provisioning
|
|
526
597
|
* write operations exceeds 10 requests per second for a given tenancy.
|
|
527
598
|
*
|
|
599
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
528
600
|
* @param CancelVaultDeletionRequest
|
|
529
601
|
* @return CancelVaultDeletionResponse
|
|
530
602
|
* @throws OciError when an error occurs
|
|
531
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
603
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/CancelVaultDeletion.ts.html |here} to see how to use CancelVaultDeletion API.
|
|
532
604
|
*/
|
|
533
605
|
cancelVaultDeletion(cancelVaultDeletionRequest: requests.CancelVaultDeletionRequest): Promise<responses.CancelVaultDeletionResponse>;
|
|
534
606
|
/**
|
|
@@ -542,10 +614,11 @@ export declare class KmsVaultClient {
|
|
|
542
614
|
* throttle this call to reject an otherwise valid request when the total rate of provisioning
|
|
543
615
|
* write operations exceeds 10 requests per second for a given tenancy.
|
|
544
616
|
*
|
|
617
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
545
618
|
* @param ChangeVaultCompartmentRequest
|
|
546
619
|
* @return ChangeVaultCompartmentResponse
|
|
547
620
|
* @throws OciError when an error occurs
|
|
548
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
621
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/ChangeVaultCompartment.ts.html |here} to see how to use ChangeVaultCompartment API.
|
|
549
622
|
*/
|
|
550
623
|
changeVaultCompartment(changeVaultCompartmentRequest: requests.ChangeVaultCompartmentRequest): Promise<responses.ChangeVaultCompartmentResponse>;
|
|
551
624
|
/**
|
|
@@ -559,10 +632,11 @@ export declare class KmsVaultClient {
|
|
|
559
632
|
* throttle this call to reject an otherwise valid request when the total rate of provisioning
|
|
560
633
|
* write operations exceeds 10 requests per second for a given tenancy.
|
|
561
634
|
*
|
|
635
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
562
636
|
* @param CreateVaultRequest
|
|
563
637
|
* @return CreateVaultResponse
|
|
564
638
|
* @throws OciError when an error occurs
|
|
565
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
639
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/CreateVault.ts.html |here} to see how to use CreateVault API.
|
|
566
640
|
*/
|
|
567
641
|
createVault(createVaultRequest: requests.CreateVaultRequest): Promise<responses.CreateVaultResponse>;
|
|
568
642
|
/**
|
|
@@ -577,10 +651,11 @@ export declare class KmsVaultClient {
|
|
|
577
651
|
* throttle this call to reject an otherwise valid request when the total rate of provisioning
|
|
578
652
|
* write operations exceeds 10 requests per second for a given tenancy.
|
|
579
653
|
*
|
|
654
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
580
655
|
* @param CreateVaultReplicaRequest
|
|
581
656
|
* @return CreateVaultReplicaResponse
|
|
582
657
|
* @throws OciError when an error occurs
|
|
583
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
658
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/CreateVaultReplica.ts.html |here} to see how to use CreateVaultReplica API.
|
|
584
659
|
*/
|
|
585
660
|
createVaultReplica(createVaultReplicaRequest: requests.CreateVaultReplicaRequest): Promise<responses.CreateVaultReplicaResponse>;
|
|
586
661
|
/**
|
|
@@ -591,10 +666,11 @@ export declare class KmsVaultClient {
|
|
|
591
666
|
* throttle this call to reject an otherwise valid request when the total rate of provisioning
|
|
592
667
|
* write operations exceeds 10 requests per second for a given tenancy.
|
|
593
668
|
*
|
|
669
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
594
670
|
* @param DeleteVaultReplicaRequest
|
|
595
671
|
* @return DeleteVaultReplicaResponse
|
|
596
672
|
* @throws OciError when an error occurs
|
|
597
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
673
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/DeleteVaultReplica.ts.html |here} to see how to use DeleteVaultReplica API.
|
|
598
674
|
*/
|
|
599
675
|
deleteVaultReplica(deleteVaultReplicaRequest: requests.DeleteVaultReplicaRequest): Promise<responses.DeleteVaultReplicaResponse>;
|
|
600
676
|
/**
|
|
@@ -605,19 +681,21 @@ export declare class KmsVaultClient {
|
|
|
605
681
|
* throttle this call to reject an otherwise valid request when the total rate of provisioning
|
|
606
682
|
* read operations exceeds 10 requests per second for a given tenancy.
|
|
607
683
|
*
|
|
684
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
608
685
|
* @param GetVaultRequest
|
|
609
686
|
* @return GetVaultResponse
|
|
610
687
|
* @throws OciError when an error occurs
|
|
611
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
688
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/GetVault.ts.html |here} to see how to use GetVault API.
|
|
612
689
|
*/
|
|
613
690
|
getVault(getVaultRequest: requests.GetVaultRequest): Promise<responses.GetVaultResponse>;
|
|
614
691
|
/**
|
|
615
692
|
* Gets the count of keys and key versions in the specified vault to calculate usage against service limits.
|
|
616
693
|
*
|
|
694
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
617
695
|
* @param GetVaultUsageRequest
|
|
618
696
|
* @return GetVaultUsageResponse
|
|
619
697
|
* @throws OciError when an error occurs
|
|
620
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
698
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/GetVaultUsage.ts.html |here} to see how to use GetVaultUsage API.
|
|
621
699
|
*/
|
|
622
700
|
getVaultUsage(getVaultUsageRequest: requests.GetVaultUsageRequest): Promise<responses.GetVaultUsageResponse>;
|
|
623
701
|
/**
|
|
@@ -628,13 +706,15 @@ export declare class KmsVaultClient {
|
|
|
628
706
|
* throttle this call to reject an otherwise valid request when the total rate of provisioning
|
|
629
707
|
* write operations exceeds 10 requests per second for a given tenancy.
|
|
630
708
|
*
|
|
709
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
631
710
|
* @param ListVaultReplicasRequest
|
|
632
711
|
* @return ListVaultReplicasResponse
|
|
633
712
|
* @throws OciError when an error occurs
|
|
634
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
713
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/ListVaultReplicas.ts.html |here} to see how to use ListVaultReplicas API.
|
|
635
714
|
*/
|
|
636
715
|
listVaultReplicas(listVaultReplicasRequest: requests.ListVaultReplicasRequest): Promise<responses.ListVaultReplicasResponse>;
|
|
637
716
|
/**
|
|
717
|
+
* NOTE: This function is deprecated in favor of listVaultReplicasRecordIterator function.
|
|
638
718
|
* Creates a new async iterator which will iterate over the models.VaultReplicaSummary objects
|
|
639
719
|
* contained in responses from the listVaultReplicas operation. This iterator will fetch more data from the
|
|
640
720
|
* server as needed.
|
|
@@ -643,12 +723,28 @@ export declare class KmsVaultClient {
|
|
|
643
723
|
*/
|
|
644
724
|
listAllVaultReplicas(request: requests.ListVaultReplicasRequest): AsyncIterableIterator<model.VaultReplicaSummary>;
|
|
645
725
|
/**
|
|
726
|
+
* NOTE: This function is deprecated in favor of listVaultReplicasResponseIterator function.
|
|
646
727
|
* Creates a new async iterator which will iterate over the responses received from the listVaultReplicas operation. This iterator
|
|
647
728
|
* will fetch more data from the server as needed.
|
|
648
729
|
*
|
|
649
730
|
* @param request a request which can be sent to the service operation
|
|
650
731
|
*/
|
|
651
732
|
listAllVaultReplicasResponses(request: requests.ListVaultReplicasRequest): AsyncIterableIterator<responses.ListVaultReplicasResponse>;
|
|
733
|
+
/**
|
|
734
|
+
* Creates a new async iterator which will iterate over the models.VaultReplicaSummary objects
|
|
735
|
+
* contained in responses from the listVaultReplicas operation. This iterator will fetch more data from the
|
|
736
|
+
* server as needed.
|
|
737
|
+
*
|
|
738
|
+
* @param request a request which can be sent to the service operation
|
|
739
|
+
*/
|
|
740
|
+
listVaultReplicasRecordIterator(request: requests.ListVaultReplicasRequest): AsyncIterableIterator<model.VaultReplicaSummary>;
|
|
741
|
+
/**
|
|
742
|
+
* Creates a new async iterator which will iterate over the responses received from the listVaultReplicas operation. This iterator
|
|
743
|
+
* will fetch more data from the server as needed.
|
|
744
|
+
*
|
|
745
|
+
* @param request a request which can be sent to the service operation
|
|
746
|
+
*/
|
|
747
|
+
listVaultReplicasResponseIterator(request: requests.ListVaultReplicasRequest): AsyncIterableIterator<responses.ListVaultReplicasResponse>;
|
|
652
748
|
/**
|
|
653
749
|
* Lists the vaults in the specified compartment.
|
|
654
750
|
* <p>
|
|
@@ -657,13 +753,15 @@ export declare class KmsVaultClient {
|
|
|
657
753
|
* throttle this call to reject an otherwise valid request when the total rate of provisioning
|
|
658
754
|
* read operations exceeds 10 requests per second for a given tenancy.
|
|
659
755
|
*
|
|
756
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
660
757
|
* @param ListVaultsRequest
|
|
661
758
|
* @return ListVaultsResponse
|
|
662
759
|
* @throws OciError when an error occurs
|
|
663
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
760
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/ListVaults.ts.html |here} to see how to use ListVaults API.
|
|
664
761
|
*/
|
|
665
762
|
listVaults(listVaultsRequest: requests.ListVaultsRequest): Promise<responses.ListVaultsResponse>;
|
|
666
763
|
/**
|
|
764
|
+
* NOTE: This function is deprecated in favor of listVaultsRecordIterator function.
|
|
667
765
|
* Creates a new async iterator which will iterate over the models.VaultSummary objects
|
|
668
766
|
* contained in responses from the listVaults operation. This iterator will fetch more data from the
|
|
669
767
|
* server as needed.
|
|
@@ -672,21 +770,38 @@ export declare class KmsVaultClient {
|
|
|
672
770
|
*/
|
|
673
771
|
listAllVaults(request: requests.ListVaultsRequest): AsyncIterableIterator<model.VaultSummary>;
|
|
674
772
|
/**
|
|
773
|
+
* NOTE: This function is deprecated in favor of listVaultsResponseIterator function.
|
|
675
774
|
* Creates a new async iterator which will iterate over the responses received from the listVaults operation. This iterator
|
|
676
775
|
* will fetch more data from the server as needed.
|
|
677
776
|
*
|
|
678
777
|
* @param request a request which can be sent to the service operation
|
|
679
778
|
*/
|
|
680
779
|
listAllVaultsResponses(request: requests.ListVaultsRequest): AsyncIterableIterator<responses.ListVaultsResponse>;
|
|
780
|
+
/**
|
|
781
|
+
* Creates a new async iterator which will iterate over the models.VaultSummary objects
|
|
782
|
+
* contained in responses from the listVaults operation. This iterator will fetch more data from the
|
|
783
|
+
* server as needed.
|
|
784
|
+
*
|
|
785
|
+
* @param request a request which can be sent to the service operation
|
|
786
|
+
*/
|
|
787
|
+
listVaultsRecordIterator(request: requests.ListVaultsRequest): AsyncIterableIterator<model.VaultSummary>;
|
|
788
|
+
/**
|
|
789
|
+
* Creates a new async iterator which will iterate over the responses received from the listVaults operation. This iterator
|
|
790
|
+
* will fetch more data from the server as needed.
|
|
791
|
+
*
|
|
792
|
+
* @param request a request which can be sent to the service operation
|
|
793
|
+
*/
|
|
794
|
+
listVaultsResponseIterator(request: requests.ListVaultsRequest): AsyncIterableIterator<responses.ListVaultsResponse>;
|
|
681
795
|
/**
|
|
682
796
|
* Restores a vault from an encrypted backup file. If a vault
|
|
683
797
|
* with the same OCID already exists, this operation returns a response with a
|
|
684
798
|
* 409 HTTP status error code.
|
|
685
799
|
*
|
|
800
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
686
801
|
* @param RestoreVaultFromFileRequest
|
|
687
802
|
* @return RestoreVaultFromFileResponse
|
|
688
803
|
* @throws OciError when an error occurs
|
|
689
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
804
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/RestoreVaultFromFile.ts.html |here} to see how to use RestoreVaultFromFile API.
|
|
690
805
|
*/
|
|
691
806
|
restoreVaultFromFile(restoreVaultFromFileRequest: requests.RestoreVaultFromFileRequest): Promise<responses.RestoreVaultFromFileResponse>;
|
|
692
807
|
/**
|
|
@@ -694,10 +809,11 @@ export declare class KmsVaultClient {
|
|
|
694
809
|
* Storage. If a vault with the same OCID already exists, this operation returns
|
|
695
810
|
* a response with a 409 HTTP status error code.
|
|
696
811
|
*
|
|
812
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
697
813
|
* @param RestoreVaultFromObjectStoreRequest
|
|
698
814
|
* @return RestoreVaultFromObjectStoreResponse
|
|
699
815
|
* @throws OciError when an error occurs
|
|
700
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
816
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/RestoreVaultFromObjectStore.ts.html |here} to see how to use RestoreVaultFromObjectStore API.
|
|
701
817
|
*/
|
|
702
818
|
restoreVaultFromObjectStore(restoreVaultFromObjectStoreRequest: requests.RestoreVaultFromObjectStoreRequest): Promise<responses.RestoreVaultFromObjectStoreResponse>;
|
|
703
819
|
/**
|
|
@@ -712,10 +828,11 @@ export declare class KmsVaultClient {
|
|
|
712
828
|
* throttle this call to reject an otherwise valid request when the total rate of provisioning
|
|
713
829
|
* write operations exceeds 10 requests per second for a given tenancy.
|
|
714
830
|
*
|
|
831
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
715
832
|
* @param ScheduleVaultDeletionRequest
|
|
716
833
|
* @return ScheduleVaultDeletionResponse
|
|
717
834
|
* @throws OciError when an error occurs
|
|
718
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
835
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/ScheduleVaultDeletion.ts.html |here} to see how to use ScheduleVaultDeletion API.
|
|
719
836
|
*/
|
|
720
837
|
scheduleVaultDeletion(scheduleVaultDeletionRequest: requests.ScheduleVaultDeletionRequest): Promise<responses.ScheduleVaultDeletionResponse>;
|
|
721
838
|
/**
|
|
@@ -728,10 +845,11 @@ export declare class KmsVaultClient {
|
|
|
728
845
|
* throttle this call to reject an otherwise valid request when the total rate of provisioning
|
|
729
846
|
* write operations exceeds 10 requests per second for a given tenancy.
|
|
730
847
|
*
|
|
848
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
731
849
|
* @param UpdateVaultRequest
|
|
732
850
|
* @return UpdateVaultResponse
|
|
733
851
|
* @throws OciError when an error occurs
|
|
734
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
852
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/keymanagement/UpdateVault.ts.html |here} to see how to use UpdateVault API.
|
|
735
853
|
*/
|
|
736
854
|
updateVault(updateVaultRequest: requests.UpdateVaultRequest): Promise<responses.UpdateVaultResponse>;
|
|
737
855
|
}
|