@aws-sdk/client-kms 3.775.0 → 3.777.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/dist-types/commands/CancelKeyDeletionCommand.d.ts +5 -5
- package/dist-types/commands/ConnectCustomKeyStoreCommand.d.ts +7 -4
- package/dist-types/commands/CreateAliasCommand.d.ts +8 -5
- package/dist-types/commands/CreateCustomKeyStoreCommand.d.ts +8 -57
- package/dist-types/commands/CreateGrantCommand.d.ts +8 -8
- package/dist-types/commands/CreateKeyCommand.d.ts +1 -283
- package/dist-types/commands/DecryptCommand.d.ts +15 -39
- package/dist-types/commands/DeleteAliasCommand.d.ts +7 -4
- package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts +7 -4
- package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +7 -4
- package/dist-types/commands/DeriveSharedSecretCommand.d.ts +10 -10
- package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +5 -92
- package/dist-types/commands/DescribeKeyCommand.d.ts +101 -138
- package/dist-types/commands/DisableKeyCommand.d.ts +7 -4
- package/dist-types/commands/DisableKeyRotationCommand.d.ts +7 -4
- package/dist-types/commands/DisconnectCustomKeyStoreCommand.d.ts +7 -4
- package/dist-types/commands/EnableKeyCommand.d.ts +7 -4
- package/dist-types/commands/EnableKeyRotationCommand.d.ts +8 -5
- package/dist-types/commands/EncryptCommand.d.ts +15 -16
- package/dist-types/commands/GenerateDataKeyCommand.d.ts +8 -32
- package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +10 -36
- package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +9 -9
- package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +7 -7
- package/dist-types/commands/GenerateMacCommand.d.ts +9 -9
- package/dist-types/commands/GenerateRandomCommand.d.ts +5 -26
- package/dist-types/commands/GetKeyPolicyCommand.d.ts +18 -6
- package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +1 -20
- package/dist-types/commands/GetParametersForImportCommand.d.ts +1 -84
- package/dist-types/commands/GetPublicKeyCommand.d.ts +9 -9
- package/dist-types/commands/ImportKeyMaterialCommand.d.ts +10 -22
- package/dist-types/commands/ListAliasesCommand.d.ts +30 -30
- package/dist-types/commands/ListGrantsCommand.d.ts +1 -69
- package/dist-types/commands/ListKeyPoliciesCommand.d.ts +6 -6
- package/dist-types/commands/ListKeyRotationsCommand.d.ts +1 -28
- package/dist-types/commands/ListKeysCommand.d.ts +20 -20
- package/dist-types/commands/ListResourceTagsCommand.d.ts +12 -12
- package/dist-types/commands/ListRetirableGrantsCommand.d.ts +1 -30
- package/dist-types/commands/PutKeyPolicyCommand.d.ts +82 -6
- package/dist-types/commands/ReEncryptCommand.d.ts +8 -8
- package/dist-types/commands/ReplicateKeyCommand.d.ts +31 -29
- package/dist-types/commands/RetireGrantCommand.d.ts +8 -5
- package/dist-types/commands/RevokeGrantCommand.d.ts +8 -5
- package/dist-types/commands/RotateKeyOnDemandCommand.d.ts +5 -5
- package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +1 -18
- package/dist-types/commands/SignCommand.d.ts +18 -19
- package/dist-types/commands/TagResourceCommand.d.ts +10 -7
- package/dist-types/commands/UntagResourceCommand.d.ts +8 -5
- package/dist-types/commands/UpdateAliasCommand.d.ts +8 -5
- package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +34 -38
- package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +8 -5
- package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +12 -9
- package/dist-types/commands/VerifyCommand.d.ts +20 -21
- package/dist-types/commands/VerifyMacCommand.d.ts +10 -10
- package/package.json +2 -2
|
@@ -243,46 +243,45 @@ declare const EncryptCommand_base: {
|
|
|
243
243
|
* @throws {@link KMSServiceException}
|
|
244
244
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
245
245
|
*
|
|
246
|
-
*
|
|
246
|
+
*
|
|
247
247
|
* @example To encrypt data with a symmetric encryption KMS key
|
|
248
248
|
* ```javascript
|
|
249
249
|
* // The following example encrypts data with the specified symmetric encryption KMS key.
|
|
250
250
|
* const input = {
|
|
251
|
-
*
|
|
252
|
-
*
|
|
251
|
+
* KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
252
|
+
* Plaintext: "<binary data>"
|
|
253
253
|
* };
|
|
254
254
|
* const command = new EncryptCommand(input);
|
|
255
255
|
* const response = await client.send(command);
|
|
256
|
-
* /* response
|
|
256
|
+
* /* response is
|
|
257
257
|
* {
|
|
258
|
-
*
|
|
259
|
-
*
|
|
260
|
-
*
|
|
258
|
+
* CiphertextBlob: "<binary data>",
|
|
259
|
+
* EncryptionAlgorithm: "SYMMETRIC_DEFAULT",
|
|
260
|
+
* KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
261
261
|
* }
|
|
262
262
|
* *\/
|
|
263
|
-
* // example id: to-encrypt-data-1
|
|
264
263
|
* ```
|
|
265
264
|
*
|
|
266
265
|
* @example To encrypt data with an asymmetric encryption KMS key
|
|
267
266
|
* ```javascript
|
|
268
267
|
* // The following example encrypts data with the specified RSA asymmetric KMS key. When you encrypt with an asymmetric key, you must specify the encryption algorithm.
|
|
269
268
|
* const input = {
|
|
270
|
-
*
|
|
271
|
-
*
|
|
272
|
-
*
|
|
269
|
+
* EncryptionAlgorithm: "RSAES_OAEP_SHA_256",
|
|
270
|
+
* KeyId: "0987dcba-09fe-87dc-65ba-ab0987654321",
|
|
271
|
+
* Plaintext: "<binary data>"
|
|
273
272
|
* };
|
|
274
273
|
* const command = new EncryptCommand(input);
|
|
275
274
|
* const response = await client.send(command);
|
|
276
|
-
* /* response
|
|
275
|
+
* /* response is
|
|
277
276
|
* {
|
|
278
|
-
*
|
|
279
|
-
*
|
|
280
|
-
*
|
|
277
|
+
* CiphertextBlob: "<binary data>",
|
|
278
|
+
* EncryptionAlgorithm: "RSAES_OAEP_SHA_256",
|
|
279
|
+
* KeyId: "arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321"
|
|
281
280
|
* }
|
|
282
281
|
* *\/
|
|
283
|
-
* // example id: to-encrypt-data-2
|
|
284
282
|
* ```
|
|
285
283
|
*
|
|
284
|
+
* @public
|
|
286
285
|
*/
|
|
287
286
|
export declare class EncryptCommand extends EncryptCommand_base {
|
|
288
287
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -242,50 +242,26 @@ declare const GenerateDataKeyCommand_base: {
|
|
|
242
242
|
* @throws {@link KMSServiceException}
|
|
243
243
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
244
244
|
*
|
|
245
|
-
*
|
|
245
|
+
*
|
|
246
246
|
* @example To generate a data key
|
|
247
247
|
* ```javascript
|
|
248
248
|
* // The following example generates a 256-bit symmetric data encryption key (data key) in two formats. One is the unencrypted (plainext) data key, and the other is the data key encrypted with the specified KMS key.
|
|
249
249
|
* const input = {
|
|
250
|
-
*
|
|
251
|
-
*
|
|
250
|
+
* KeyId: "alias/ExampleAlias",
|
|
251
|
+
* KeySpec: "AES_256"
|
|
252
252
|
* };
|
|
253
253
|
* const command = new GenerateDataKeyCommand(input);
|
|
254
254
|
* const response = await client.send(command);
|
|
255
|
-
* /* response
|
|
255
|
+
* /* response is
|
|
256
256
|
* {
|
|
257
|
-
*
|
|
258
|
-
*
|
|
259
|
-
*
|
|
257
|
+
* CiphertextBlob: "<binary data>",
|
|
258
|
+
* KeyId: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
259
|
+
* Plaintext: "<binary data>"
|
|
260
260
|
* }
|
|
261
261
|
* *\/
|
|
262
|
-
* // example id: to-generate-a-data-key-1
|
|
263
|
-
* ```
|
|
264
|
-
*
|
|
265
|
-
* @example To generate a data key pair for a Nitro enclave
|
|
266
|
-
* ```javascript
|
|
267
|
-
* // The following example includes the Recipient parameter with a signed attestation document from an AWS Nitro enclave. Instead of returning a copy of the data key encrypted by the KMS key and a plaintext copy of the data key, GenerateDataKey returns one copy of the data key encrypted by the KMS key (CiphertextBlob) and one copy of the data key encrypted by the public key from the attestation document (CiphertextForRecipient). The operation doesn't return a plaintext data key.
|
|
268
|
-
* const input = {
|
|
269
|
-
* "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
270
|
-
* "KeySpec": "AES_256",
|
|
271
|
-
* "Recipient": {
|
|
272
|
-
* "AttestationDocument": "<attestation document>",
|
|
273
|
-
* "KeyEncryptionAlgorithm": "RSAES_OAEP_SHA_256"
|
|
274
|
-
* }
|
|
275
|
-
* };
|
|
276
|
-
* const command = new GenerateDataKeyCommand(input);
|
|
277
|
-
* const response = await client.send(command);
|
|
278
|
-
* /* response ==
|
|
279
|
-
* {
|
|
280
|
-
* "CiphertextBlob": "<binary data>",
|
|
281
|
-
* "CiphertextForRecipient": "<binary data>",
|
|
282
|
-
* "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
283
|
-
* "Plaintext": ""
|
|
284
|
-
* }
|
|
285
|
-
* *\/
|
|
286
|
-
* // example id: to-generate-a-data-key-for-a-nitro-enclave-2
|
|
287
262
|
* ```
|
|
288
263
|
*
|
|
264
|
+
* @public
|
|
289
265
|
*/
|
|
290
266
|
export declare class GenerateDataKeyCommand extends GenerateDataKeyCommand_base {
|
|
291
267
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -226,54 +226,28 @@ declare const GenerateDataKeyPairCommand_base: {
|
|
|
226
226
|
* @throws {@link KMSServiceException}
|
|
227
227
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
228
228
|
*
|
|
229
|
-
*
|
|
229
|
+
*
|
|
230
230
|
* @example To generate an RSA key pair for encryption and decryption
|
|
231
231
|
* ```javascript
|
|
232
232
|
* // This example generates an RSA data key pair for encryption and decryption. The operation returns a plaintext public key and private key, and a copy of the private key that is encrypted under a symmetric encryption KMS key that you specify.
|
|
233
233
|
* const input = {
|
|
234
|
-
*
|
|
235
|
-
*
|
|
234
|
+
* KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
235
|
+
* KeyPairSpec: "RSA_3072"
|
|
236
236
|
* };
|
|
237
237
|
* const command = new GenerateDataKeyPairCommand(input);
|
|
238
238
|
* const response = await client.send(command);
|
|
239
|
-
* /* response
|
|
239
|
+
* /* response is
|
|
240
240
|
* {
|
|
241
|
-
*
|
|
242
|
-
*
|
|
243
|
-
*
|
|
244
|
-
*
|
|
245
|
-
*
|
|
241
|
+
* KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
242
|
+
* KeyPairSpec: "RSA_3072",
|
|
243
|
+
* PrivateKeyCiphertextBlob: "<binary data>",
|
|
244
|
+
* PrivateKeyPlaintext: "<binary data>",
|
|
245
|
+
* PublicKey: "<binary data>"
|
|
246
246
|
* }
|
|
247
247
|
* *\/
|
|
248
|
-
* // example id: to-generate-an-rsa-key-pair-for-encryption-and-decryption-1
|
|
249
|
-
* ```
|
|
250
|
-
*
|
|
251
|
-
* @example To generate a data key pair for a Nitro enclave
|
|
252
|
-
* ```javascript
|
|
253
|
-
* // The following example includes the Recipient parameter with a signed attestation document from an AWS Nitro enclave. Instead of returning a plaintext copy of the private data key, GenerateDataKeyPair returns a copy of the private data key encrypted by the public key from the attestation document (CiphertextForRecipient). It returns the public data key (PublicKey) and a copy of private data key encrypted under the specified KMS key (PrivateKeyCiphertextBlob), as usual, but plaintext private data key field (PrivateKeyPlaintext) is null or empty.
|
|
254
|
-
* const input = {
|
|
255
|
-
* "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
256
|
-
* "KeyPairSpec": "RSA_3072",
|
|
257
|
-
* "Recipient": {
|
|
258
|
-
* "AttestationDocument": "<attestation document>",
|
|
259
|
-
* "KeyEncryptionAlgorithm": "RSAES_OAEP_SHA_256"
|
|
260
|
-
* }
|
|
261
|
-
* };
|
|
262
|
-
* const command = new GenerateDataKeyPairCommand(input);
|
|
263
|
-
* const response = await client.send(command);
|
|
264
|
-
* /* response ==
|
|
265
|
-
* {
|
|
266
|
-
* "CiphertextForRecipient": "<binary data>",
|
|
267
|
-
* "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
268
|
-
* "KeyPairSpec": "RSA_3072",
|
|
269
|
-
* "PrivateKeyCiphertextBlob": "<binary data>",
|
|
270
|
-
* "PrivateKeyPlaintext": "",
|
|
271
|
-
* "PublicKey": "<binary data>"
|
|
272
|
-
* }
|
|
273
|
-
* *\/
|
|
274
|
-
* // example id: to-generate-a-data-key-pair-for-a-nitro-enclave-2
|
|
275
248
|
* ```
|
|
276
249
|
*
|
|
250
|
+
* @public
|
|
277
251
|
*/
|
|
278
252
|
export declare class GenerateDataKeyPairCommand extends GenerateDataKeyPairCommand_base {
|
|
279
253
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -202,27 +202,27 @@ declare const GenerateDataKeyPairWithoutPlaintextCommand_base: {
|
|
|
202
202
|
* @throws {@link KMSServiceException}
|
|
203
203
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
204
204
|
*
|
|
205
|
-
*
|
|
205
|
+
*
|
|
206
206
|
* @example To generate an asymmetric data key pair without a plaintext key
|
|
207
207
|
* ```javascript
|
|
208
208
|
* // This example returns an asymmetric elliptic curve (ECC) data key pair. The private key is encrypted under the symmetric encryption KMS key that you specify. This operation doesn't return a plaintext (unencrypted) private key.
|
|
209
209
|
* const input = {
|
|
210
|
-
*
|
|
211
|
-
*
|
|
210
|
+
* KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
211
|
+
* KeyPairSpec: "ECC_NIST_P521"
|
|
212
212
|
* };
|
|
213
213
|
* const command = new GenerateDataKeyPairWithoutPlaintextCommand(input);
|
|
214
214
|
* const response = await client.send(command);
|
|
215
|
-
* /* response
|
|
215
|
+
* /* response is
|
|
216
216
|
* {
|
|
217
|
-
*
|
|
218
|
-
*
|
|
219
|
-
*
|
|
220
|
-
*
|
|
217
|
+
* KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
218
|
+
* KeyPairSpec: "ECC_NIST_P521",
|
|
219
|
+
* PrivateKeyCiphertextBlob: "<binary data>",
|
|
220
|
+
* PublicKey: "<binary data>"
|
|
221
221
|
* }
|
|
222
222
|
* *\/
|
|
223
|
-
* // example id: to-generate-an-asymmetric-data-key-pair-without-a-plaintext-key-1628620971564
|
|
224
223
|
* ```
|
|
225
224
|
*
|
|
225
|
+
* @public
|
|
226
226
|
*/
|
|
227
227
|
export declare class GenerateDataKeyPairWithoutPlaintextCommand extends GenerateDataKeyPairWithoutPlaintextCommand_base {
|
|
228
228
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -206,25 +206,25 @@ declare const GenerateDataKeyWithoutPlaintextCommand_base: {
|
|
|
206
206
|
* @throws {@link KMSServiceException}
|
|
207
207
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
208
208
|
*
|
|
209
|
-
*
|
|
209
|
+
*
|
|
210
210
|
* @example To generate an encrypted data key
|
|
211
211
|
* ```javascript
|
|
212
212
|
* // The following example generates an encrypted copy of a 256-bit symmetric data encryption key (data key). The data key is encrypted with the specified KMS key.
|
|
213
213
|
* const input = {
|
|
214
|
-
*
|
|
215
|
-
*
|
|
214
|
+
* KeyId: "alias/ExampleAlias",
|
|
215
|
+
* KeySpec: "AES_256"
|
|
216
216
|
* };
|
|
217
217
|
* const command = new GenerateDataKeyWithoutPlaintextCommand(input);
|
|
218
218
|
* const response = await client.send(command);
|
|
219
|
-
* /* response
|
|
219
|
+
* /* response is
|
|
220
220
|
* {
|
|
221
|
-
*
|
|
222
|
-
*
|
|
221
|
+
* CiphertextBlob: "<binary data>",
|
|
222
|
+
* KeyId: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
223
223
|
* }
|
|
224
224
|
* *\/
|
|
225
|
-
* // example id: to-generate-an-encrypted-data-key-1478914121134
|
|
226
225
|
* ```
|
|
227
226
|
*
|
|
227
|
+
* @public
|
|
228
228
|
*/
|
|
229
229
|
export declare class GenerateDataKeyWithoutPlaintextCommand extends GenerateDataKeyWithoutPlaintextCommand_base {
|
|
230
230
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -156,27 +156,27 @@ declare const GenerateMacCommand_base: {
|
|
|
156
156
|
* @throws {@link KMSServiceException}
|
|
157
157
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
158
158
|
*
|
|
159
|
-
*
|
|
159
|
+
*
|
|
160
160
|
* @example To generate an HMAC for a message
|
|
161
161
|
* ```javascript
|
|
162
162
|
* // This example generates an HMAC for a message, an HMAC KMS key, and a MAC algorithm. The algorithm must be supported by the specified HMAC KMS key.
|
|
163
163
|
* const input = {
|
|
164
|
-
*
|
|
165
|
-
*
|
|
166
|
-
*
|
|
164
|
+
* KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
165
|
+
* MacAlgorithm: "HMAC_SHA_384",
|
|
166
|
+
* Message: "Hello World"
|
|
167
167
|
* };
|
|
168
168
|
* const command = new GenerateMacCommand(input);
|
|
169
169
|
* const response = await client.send(command);
|
|
170
|
-
* /* response
|
|
170
|
+
* /* response is
|
|
171
171
|
* {
|
|
172
|
-
*
|
|
173
|
-
*
|
|
174
|
-
*
|
|
172
|
+
* KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
173
|
+
* Mac: "<HMAC_TAG>",
|
|
174
|
+
* MacAlgorithm: "HMAC_SHA_384"
|
|
175
175
|
* }
|
|
176
176
|
* *\/
|
|
177
|
-
* // example id: to-generate-an-hmac-for-a-message-1631570135665
|
|
178
177
|
* ```
|
|
179
178
|
*
|
|
179
|
+
* @public
|
|
180
180
|
*/
|
|
181
181
|
export declare class GenerateMacCommand extends GenerateMacCommand_base {
|
|
182
182
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -135,44 +135,23 @@ declare const GenerateRandomCommand_base: {
|
|
|
135
135
|
* @throws {@link KMSServiceException}
|
|
136
136
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
137
137
|
*
|
|
138
|
-
* @public
|
|
139
|
-
* @example To generate random data
|
|
140
|
-
* ```javascript
|
|
141
|
-
* // The following example generates 32 bytes of random data.
|
|
142
|
-
* const input = {
|
|
143
|
-
* "NumberOfBytes": 32
|
|
144
|
-
* };
|
|
145
|
-
* const command = new GenerateRandomCommand(input);
|
|
146
|
-
* const response = await client.send(command);
|
|
147
|
-
* /* response ==
|
|
148
|
-
* {
|
|
149
|
-
* "Plaintext": "<binary data>"
|
|
150
|
-
* }
|
|
151
|
-
* *\/
|
|
152
|
-
* // example id: to-generate-random-data-1
|
|
153
|
-
* ```
|
|
154
138
|
*
|
|
155
139
|
* @example To generate random data
|
|
156
140
|
* ```javascript
|
|
157
|
-
* // The following example
|
|
141
|
+
* // The following example generates 32 bytes of random data.
|
|
158
142
|
* const input = {
|
|
159
|
-
*
|
|
160
|
-
* "Recipient": {
|
|
161
|
-
* "AttestationDocument": "<attestation document>",
|
|
162
|
-
* "KeyEncryptionAlgorithm": "RSAES_OAEP_SHA_256"
|
|
163
|
-
* }
|
|
143
|
+
* NumberOfBytes: 32
|
|
164
144
|
* };
|
|
165
145
|
* const command = new GenerateRandomCommand(input);
|
|
166
146
|
* const response = await client.send(command);
|
|
167
|
-
* /* response
|
|
147
|
+
* /* response is
|
|
168
148
|
* {
|
|
169
|
-
*
|
|
170
|
-
* "Plaintext": ""
|
|
149
|
+
* Plaintext: "<binary data>"
|
|
171
150
|
* }
|
|
172
151
|
* *\/
|
|
173
|
-
* // example id: to-generate-random-data-2
|
|
174
152
|
* ```
|
|
175
153
|
*
|
|
154
|
+
* @public
|
|
176
155
|
*/
|
|
177
156
|
export declare class GenerateRandomCommand extends GenerateRandomCommand_base {
|
|
178
157
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -102,24 +102,36 @@ declare const GetKeyPolicyCommand_base: {
|
|
|
102
102
|
* @throws {@link KMSServiceException}
|
|
103
103
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
104
104
|
*
|
|
105
|
-
*
|
|
105
|
+
*
|
|
106
106
|
* @example To retrieve a key policy
|
|
107
107
|
* ```javascript
|
|
108
108
|
* // The following example retrieves the key policy for the specified KMS key.
|
|
109
109
|
* const input = {
|
|
110
|
-
*
|
|
111
|
-
*
|
|
110
|
+
* KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
111
|
+
* PolicyName: "default"
|
|
112
112
|
* };
|
|
113
113
|
* const command = new GetKeyPolicyCommand(input);
|
|
114
114
|
* const response = await client.send(command);
|
|
115
|
-
* /* response
|
|
115
|
+
* /* response is
|
|
116
116
|
* {
|
|
117
|
-
*
|
|
117
|
+
* Policy: `{
|
|
118
|
+
* "Version" : "2012-10-17",
|
|
119
|
+
* "Id" : "key-default-1",
|
|
120
|
+
* "Statement" : [ {
|
|
121
|
+
* "Sid" : "Enable IAM User Permissions",
|
|
122
|
+
* "Effect" : "Allow",
|
|
123
|
+
* "Principal" : {
|
|
124
|
+
* "AWS" : "arn:aws:iam::111122223333:root"
|
|
125
|
+
* },
|
|
126
|
+
* "Action" : "kms:*",
|
|
127
|
+
* "Resource" : "*"
|
|
128
|
+
* } ]
|
|
129
|
+
* }`
|
|
118
130
|
* }
|
|
119
131
|
* *\/
|
|
120
|
-
* // example id: to-retrieve-a-key-policy-1479170128325
|
|
121
132
|
* ```
|
|
122
133
|
*
|
|
134
|
+
* @public
|
|
123
135
|
*/
|
|
124
136
|
export declare class GetKeyPolicyCommand extends GetKeyPolicyCommand_base {
|
|
125
137
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -165,27 +165,8 @@ declare const GetKeyRotationStatusCommand_base: {
|
|
|
165
165
|
* @throws {@link KMSServiceException}
|
|
166
166
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
167
167
|
*
|
|
168
|
-
* @public
|
|
169
|
-
* @example To retrieve the rotation status for a KMS key
|
|
170
|
-
* ```javascript
|
|
171
|
-
* // The following example retrieves detailed information about the rotation status for a KMS key, including whether automatic key rotation is enabled for the specified KMS key, the rotation period, and the next scheduled rotation date.
|
|
172
|
-
* const input = {
|
|
173
|
-
* "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
174
|
-
* };
|
|
175
|
-
* const command = new GetKeyRotationStatusCommand(input);
|
|
176
|
-
* const response = await client.send(command);
|
|
177
|
-
* /* response ==
|
|
178
|
-
* {
|
|
179
|
-
* "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
180
|
-
* "KeyRotationEnabled": true,
|
|
181
|
-
* "NextRotationDate": "2024-04-05T15:14:47.757000+00:00",
|
|
182
|
-
* "OnDemandRotationStartDate": "2024-03-02T10:11:36.564000+00:00",
|
|
183
|
-
* "RotationPeriodInDays": 365
|
|
184
|
-
* }
|
|
185
|
-
* *\/
|
|
186
|
-
* // example id: to-retrieve-the-rotation-status-for-a-kms-key-1712500357701
|
|
187
|
-
* ```
|
|
188
168
|
*
|
|
169
|
+
* @public
|
|
189
170
|
*/
|
|
190
171
|
export declare class GetKeyRotationStatusCommand extends GetKeyRotationStatusCommand_base {
|
|
191
172
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -175,91 +175,8 @@ declare const GetParametersForImportCommand_base: {
|
|
|
175
175
|
* @throws {@link KMSServiceException}
|
|
176
176
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
177
177
|
*
|
|
178
|
-
* @public
|
|
179
|
-
* @example To download the public key and import token for a symmetric encryption KMS key
|
|
180
|
-
* ```javascript
|
|
181
|
-
* // The following example downloads a public key and import token to import symmetric encryption key material. It uses the default wrapping key spec and the RSAES_OAEP_SHA_256 wrapping algorithm.
|
|
182
|
-
* const input = {
|
|
183
|
-
* "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
184
|
-
* "WrappingAlgorithm": "RSAES_OAEP_SHA_1",
|
|
185
|
-
* "WrappingKeySpec": "RSA_2048"
|
|
186
|
-
* };
|
|
187
|
-
* const command = new GetParametersForImportCommand(input);
|
|
188
|
-
* const response = await client.send(command);
|
|
189
|
-
* /* response ==
|
|
190
|
-
* {
|
|
191
|
-
* "ImportToken": "<binary data>",
|
|
192
|
-
* "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
193
|
-
* "ParametersValidTo": "2023-02-01T14:52:17-08:00",
|
|
194
|
-
* "PublicKey": "<binary data>"
|
|
195
|
-
* }
|
|
196
|
-
* *\/
|
|
197
|
-
* // example id: to-download-the-public-key-and-import-token-1
|
|
198
|
-
* ```
|
|
199
|
-
*
|
|
200
|
-
* @example To download the public key and import token for an RSA asymmetric KMS key
|
|
201
|
-
* ```javascript
|
|
202
|
-
* // The following example downloads a public key and import token to import an RSA private key. It uses a required RSA_AES wrapping algorithm and the largest supported private key.
|
|
203
|
-
* const input = {
|
|
204
|
-
* "KeyId": "arn:aws:kms:us-east-2:111122223333:key/8888abcd-12ab-34cd-56ef-1234567890ab",
|
|
205
|
-
* "WrappingAlgorithm": "RSA_AES_KEY_WRAP_SHA_256",
|
|
206
|
-
* "WrappingKeySpec": "RSA_4096"
|
|
207
|
-
* };
|
|
208
|
-
* const command = new GetParametersForImportCommand(input);
|
|
209
|
-
* const response = await client.send(command);
|
|
210
|
-
* /* response ==
|
|
211
|
-
* {
|
|
212
|
-
* "ImportToken": "<binary data>",
|
|
213
|
-
* "KeyId": "arn:aws:kms:us-east-2:111122223333:key/8888abcd-12ab-34cd-56ef-1234567890ab",
|
|
214
|
-
* "ParametersValidTo": "2023-03-08T13:02:02-07:00",
|
|
215
|
-
* "PublicKey": "<binary data>"
|
|
216
|
-
* }
|
|
217
|
-
* *\/
|
|
218
|
-
* // example id: to-download-the-public-key-and-import-token-2
|
|
219
|
-
* ```
|
|
220
|
-
*
|
|
221
|
-
* @example To download the public key and import token for an elliptic curve (ECC) asymmetric KMS key
|
|
222
|
-
* ```javascript
|
|
223
|
-
* // The following example downloads a public key and import token to import an ECC_NIST_P521 (secp521r1) private key. You cannot directly wrap this ECC key under an RSA_2048 public key, although you can use an RSA_2048 public key with an RSA_AES wrapping algorithm to wrap any supported key material. This example requests an RSA_3072 public key for use with the RSAES_OAEP_SHA_256.
|
|
224
|
-
* const input = {
|
|
225
|
-
* "KeyId": "arn:aws:kms:us-east-2:111122223333:key/9876abcd-12ab-34cd-56ef-1234567890ab",
|
|
226
|
-
* "WrappingAlgorithm": "RSAES_OAEP_SHA_256",
|
|
227
|
-
* "WrappingKeySpec": "RSA_3072"
|
|
228
|
-
* };
|
|
229
|
-
* const command = new GetParametersForImportCommand(input);
|
|
230
|
-
* const response = await client.send(command);
|
|
231
|
-
* /* response ==
|
|
232
|
-
* {
|
|
233
|
-
* "ImportToken": "<binary data>",
|
|
234
|
-
* "KeyId": "arn:aws:kms:us-east-2:111122223333:key/9876abcd-12ab-34cd-56ef-1234567890ab",
|
|
235
|
-
* "ParametersValidTo": "2023-09-12T03:15:01-20:00",
|
|
236
|
-
* "PublicKey": "<binary data>"
|
|
237
|
-
* }
|
|
238
|
-
* *\/
|
|
239
|
-
* // example id: to-download-the-public-key-and-import-token-3
|
|
240
|
-
* ```
|
|
241
|
-
*
|
|
242
|
-
* @example To download the public key and import token for an HMAC KMS key
|
|
243
|
-
* ```javascript
|
|
244
|
-
* // The following example downloads a public key and import token to import an HMAC key. It uses the RSAES_OAEP_SHA_256 wrapping algorithm and an RSA_4096 private key.
|
|
245
|
-
* const input = {
|
|
246
|
-
* "KeyId": "2468abcd-12ab-34cd-56ef-1234567890ab",
|
|
247
|
-
* "WrappingAlgorithm": "RSAES_OAEP_SHA_256",
|
|
248
|
-
* "WrappingKeySpec": "RSA_4096"
|
|
249
|
-
* };
|
|
250
|
-
* const command = new GetParametersForImportCommand(input);
|
|
251
|
-
* const response = await client.send(command);
|
|
252
|
-
* /* response ==
|
|
253
|
-
* {
|
|
254
|
-
* "ImportToken": "<binary data>",
|
|
255
|
-
* "KeyId": "arn:aws:kms:us-east-2:111122223333:key/2468abcd-12ab-34cd-56ef-1234567890ab",
|
|
256
|
-
* "ParametersValidTo": "2023-04-02T13:02:02-07:00",
|
|
257
|
-
* "PublicKey": "<binary data>"
|
|
258
|
-
* }
|
|
259
|
-
* *\/
|
|
260
|
-
* // example id: to-download-the-public-key-and-import-token-4
|
|
261
|
-
* ```
|
|
262
178
|
*
|
|
179
|
+
* @public
|
|
263
180
|
*/
|
|
264
181
|
export declare class GetParametersForImportCommand extends GetParametersForImportCommand_base {
|
|
265
182
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -193,30 +193,30 @@ declare const GetPublicKeyCommand_base: {
|
|
|
193
193
|
* @throws {@link KMSServiceException}
|
|
194
194
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
195
195
|
*
|
|
196
|
-
*
|
|
196
|
+
*
|
|
197
197
|
* @example To download the public key of an asymmetric KMS key
|
|
198
198
|
* ```javascript
|
|
199
199
|
* // This example gets the public key of an asymmetric RSA KMS key used for encryption and decryption. The operation returns the key spec, key usage, and encryption or signing algorithms to help you use the public key correctly outside of AWS KMS.
|
|
200
200
|
* const input = {
|
|
201
|
-
*
|
|
201
|
+
* KeyId: "arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321"
|
|
202
202
|
* };
|
|
203
203
|
* const command = new GetPublicKeyCommand(input);
|
|
204
204
|
* const response = await client.send(command);
|
|
205
|
-
* /* response
|
|
205
|
+
* /* response is
|
|
206
206
|
* {
|
|
207
|
-
*
|
|
208
|
-
*
|
|
207
|
+
* CustomerMasterKeySpec: "RSA_4096",
|
|
208
|
+
* EncryptionAlgorithms: [
|
|
209
209
|
* "RSAES_OAEP_SHA_1",
|
|
210
210
|
* "RSAES_OAEP_SHA_256"
|
|
211
211
|
* ],
|
|
212
|
-
*
|
|
213
|
-
*
|
|
214
|
-
*
|
|
212
|
+
* KeyId: "arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321",
|
|
213
|
+
* KeyUsage: "ENCRYPT_DECRYPT",
|
|
214
|
+
* PublicKey: "<binary data>"
|
|
215
215
|
* }
|
|
216
216
|
* *\/
|
|
217
|
-
* // example id: to-download-the-public-key-of-an-asymmetric-kms-key-1628621691873
|
|
218
217
|
* ```
|
|
219
218
|
*
|
|
219
|
+
* @public
|
|
220
220
|
*/
|
|
221
221
|
export declare class GetPublicKeyCommand extends GetPublicKeyCommand_base {
|
|
222
222
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -220,36 +220,24 @@ declare const ImportKeyMaterialCommand_base: {
|
|
|
220
220
|
* @throws {@link KMSServiceException}
|
|
221
221
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
222
222
|
*
|
|
223
|
-
* @public
|
|
224
|
-
* @example To import key material into a KMS key
|
|
225
|
-
* ```javascript
|
|
226
|
-
* // The following example imports key material into the specified KMS key.
|
|
227
|
-
* const input = {
|
|
228
|
-
* "EncryptedKeyMaterial": "<binary data>",
|
|
229
|
-
* "ExpirationModel": "KEY_MATERIAL_DOES_NOT_EXPIRE",
|
|
230
|
-
* "ImportToken": "<binary data>",
|
|
231
|
-
* "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
232
|
-
* };
|
|
233
|
-
* const command = new ImportKeyMaterialCommand(input);
|
|
234
|
-
* await client.send(command);
|
|
235
|
-
* // example id: to-import-key-material-into-a-kms-key-1
|
|
236
|
-
* ```
|
|
237
223
|
*
|
|
238
224
|
* @example To import key material into a KMS key
|
|
239
225
|
* ```javascript
|
|
240
|
-
* // The following example imports key material
|
|
226
|
+
* // The following example imports key material into the specified KMS key.
|
|
241
227
|
* const input = {
|
|
242
|
-
*
|
|
243
|
-
*
|
|
244
|
-
*
|
|
245
|
-
*
|
|
246
|
-
* "ValidTo": "2023-09-30T00:00:00-00:00"
|
|
228
|
+
* EncryptedKeyMaterial: "<binary data>",
|
|
229
|
+
* ExpirationModel: "KEY_MATERIAL_DOES_NOT_EXPIRE",
|
|
230
|
+
* ImportToken: "<binary data>",
|
|
231
|
+
* KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
247
232
|
* };
|
|
248
233
|
* const command = new ImportKeyMaterialCommand(input);
|
|
249
|
-
* await client.send(command);
|
|
250
|
-
*
|
|
234
|
+
* const response = await client.send(command);
|
|
235
|
+
* /* response is
|
|
236
|
+
* { /* metadata only *\/ }
|
|
237
|
+
* *\/
|
|
251
238
|
* ```
|
|
252
239
|
*
|
|
240
|
+
* @public
|
|
253
241
|
*/
|
|
254
242
|
export declare class ImportKeyMaterialCommand extends ImportKeyMaterialCommand_base {
|
|
255
243
|
/** @internal type navigation helper, not in runtime. */
|