@aws-sdk/client-kms 3.821.0 → 3.825.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-cjs/index.js +52 -6
- package/dist-es/models/models_0.js +17 -0
- package/dist-es/protocols/Aws_json1_1.js +22 -1
- package/dist-types/commands/CancelKeyDeletionCommand.d.ts +1 -1
- package/dist-types/commands/ConnectCustomKeyStoreCommand.d.ts +4 -4
- package/dist-types/commands/CreateAliasCommand.d.ts +7 -7
- package/dist-types/commands/CreateCustomKeyStoreCommand.d.ts +6 -7
- package/dist-types/commands/CreateGrantCommand.d.ts +8 -7
- package/dist-types/commands/CreateKeyCommand.d.ts +21 -20
- package/dist-types/commands/DecryptCommand.d.ts +17 -16
- package/dist-types/commands/DeleteAliasCommand.d.ts +1 -1
- package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts +4 -4
- package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +14 -5
- package/dist-types/commands/DeriveSharedSecretCommand.d.ts +40 -33
- package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +3 -3
- package/dist-types/commands/DescribeKeyCommand.d.ts +79 -78
- package/dist-types/commands/DisableKeyCommand.d.ts +5 -6
- package/dist-types/commands/DisableKeyRotationCommand.d.ts +4 -4
- package/dist-types/commands/DisconnectCustomKeyStoreCommand.d.ts +4 -4
- package/dist-types/commands/EnableKeyCommand.d.ts +5 -4
- package/dist-types/commands/EnableKeyRotationCommand.d.ts +12 -14
- package/dist-types/commands/EncryptCommand.d.ts +5 -4
- package/dist-types/commands/GenerateDataKeyCommand.d.ts +5 -4
- package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +5 -4
- package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +5 -4
- package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +5 -4
- package/dist-types/commands/GenerateMacCommand.d.ts +3 -3
- package/dist-types/commands/GenerateRandomCommand.d.ts +2 -3
- package/dist-types/commands/GetKeyPolicyCommand.d.ts +1 -1
- package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +12 -11
- package/dist-types/commands/GetParametersForImportCommand.d.ts +7 -7
- package/dist-types/commands/GetPublicKeyCommand.d.ts +8 -8
- package/dist-types/commands/ImportKeyMaterialCommand.d.ts +54 -38
- package/dist-types/commands/ListAliasesCommand.d.ts +4 -5
- package/dist-types/commands/ListGrantsCommand.d.ts +3 -3
- package/dist-types/commands/ListKeyPoliciesCommand.d.ts +1 -1
- package/dist-types/commands/ListKeyRotationsCommand.d.ts +22 -4
- package/dist-types/commands/ListKeysCommand.d.ts +1 -1
- package/dist-types/commands/ListResourceTagsCommand.d.ts +3 -3
- package/dist-types/commands/ListRetirableGrantsCommand.d.ts +3 -3
- package/dist-types/commands/PutKeyPolicyCommand.d.ts +6 -4
- package/dist-types/commands/ReEncryptCommand.d.ts +12 -13
- package/dist-types/commands/ReplicateKeyCommand.d.ts +10 -13
- package/dist-types/commands/RetireGrantCommand.d.ts +6 -7
- package/dist-types/commands/RevokeGrantCommand.d.ts +5 -5
- package/dist-types/commands/RotateKeyOnDemandCommand.d.ts +33 -23
- package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +15 -15
- package/dist-types/commands/SignCommand.d.ts +19 -19
- package/dist-types/commands/TagResourceCommand.d.ts +6 -5
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAliasCommand.d.ts +4 -3
- package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +12 -12
- package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +2 -2
- package/dist-types/commands/VerifyCommand.d.ts +4 -4
- package/dist-types/commands/VerifyMacCommand.d.ts +3 -3
- package/dist-types/models/models_0.d.ts +423 -150
- package/dist-types/ts3.4/commands/DeleteImportedKeyMaterialCommand.d.ts +7 -3
- package/dist-types/ts3.4/commands/ImportKeyMaterialCommand.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +51 -1
- package/package.json +11 -11
package/dist-cjs/index.js
CHANGED
|
@@ -87,6 +87,9 @@ __export(index_exports, {
|
|
|
87
87
|
GetPublicKeyCommand: () => GetPublicKeyCommand,
|
|
88
88
|
GrantOperation: () => GrantOperation,
|
|
89
89
|
ImportKeyMaterialCommand: () => ImportKeyMaterialCommand,
|
|
90
|
+
ImportState: () => ImportState,
|
|
91
|
+
ImportType: () => ImportType,
|
|
92
|
+
IncludeKeyMaterial: () => IncludeKeyMaterial,
|
|
90
93
|
IncorrectKeyException: () => IncorrectKeyException,
|
|
91
94
|
IncorrectKeyMaterialException: () => IncorrectKeyMaterialException,
|
|
92
95
|
IncorrectTrustAnchorException: () => IncorrectTrustAnchorException,
|
|
@@ -108,6 +111,7 @@ __export(index_exports, {
|
|
|
108
111
|
KeyAgreementAlgorithmSpec: () => KeyAgreementAlgorithmSpec,
|
|
109
112
|
KeyEncryptionMechanism: () => KeyEncryptionMechanism,
|
|
110
113
|
KeyManagerType: () => KeyManagerType,
|
|
114
|
+
KeyMaterialState: () => KeyMaterialState,
|
|
111
115
|
KeySpec: () => KeySpec,
|
|
112
116
|
KeyState: () => KeyState,
|
|
113
117
|
KeyUnavailableException: () => KeyUnavailableException,
|
|
@@ -1299,6 +1303,10 @@ var WrappingKeySpec = {
|
|
|
1299
1303
|
RSA_4096: "RSA_4096",
|
|
1300
1304
|
SM2: "SM2"
|
|
1301
1305
|
};
|
|
1306
|
+
var ImportType = {
|
|
1307
|
+
EXISTING_KEY_MATERIAL: "EXISTING_KEY_MATERIAL",
|
|
1308
|
+
NEW_KEY_MATERIAL: "NEW_KEY_MATERIAL"
|
|
1309
|
+
};
|
|
1302
1310
|
var IncorrectKeyMaterialException = class _IncorrectKeyMaterialException extends KMSServiceException {
|
|
1303
1311
|
static {
|
|
1304
1312
|
__name(this, "IncorrectKeyMaterialException");
|
|
@@ -1335,6 +1343,14 @@ var InvalidImportTokenException = class _InvalidImportTokenException extends KMS
|
|
|
1335
1343
|
Object.setPrototypeOf(this, _InvalidImportTokenException.prototype);
|
|
1336
1344
|
}
|
|
1337
1345
|
};
|
|
1346
|
+
var ImportState = {
|
|
1347
|
+
IMPORTED: "IMPORTED",
|
|
1348
|
+
PENDING_IMPORT: "PENDING_IMPORT"
|
|
1349
|
+
};
|
|
1350
|
+
var IncludeKeyMaterial = {
|
|
1351
|
+
ALL_KEY_MATERIAL: "ALL_KEY_MATERIAL",
|
|
1352
|
+
ROTATIONS_ONLY: "ROTATIONS_ONLY"
|
|
1353
|
+
};
|
|
1338
1354
|
var InvalidGrantIdException = class _InvalidGrantIdException extends KMSServiceException {
|
|
1339
1355
|
static {
|
|
1340
1356
|
__name(this, "InvalidGrantIdException");
|
|
@@ -1353,6 +1369,11 @@ var InvalidGrantIdException = class _InvalidGrantIdException extends KMSServiceE
|
|
|
1353
1369
|
Object.setPrototypeOf(this, _InvalidGrantIdException.prototype);
|
|
1354
1370
|
}
|
|
1355
1371
|
};
|
|
1372
|
+
var KeyMaterialState = {
|
|
1373
|
+
CURRENT: "CURRENT",
|
|
1374
|
+
NON_CURRENT: "NON_CURRENT",
|
|
1375
|
+
PENDING_ROTATION: "PENDING_ROTATION"
|
|
1376
|
+
};
|
|
1356
1377
|
var KMSInvalidMacException = class _KMSInvalidMacException extends KMSServiceException {
|
|
1357
1378
|
static {
|
|
1358
1379
|
__name(this, "KMSInvalidMacException");
|
|
@@ -1915,9 +1936,12 @@ var de_DeleteImportedKeyMaterialCommand = /* @__PURE__ */ __name(async (output,
|
|
|
1915
1936
|
if (output.statusCode >= 300) {
|
|
1916
1937
|
return de_CommandError(output, context);
|
|
1917
1938
|
}
|
|
1918
|
-
await (0,
|
|
1939
|
+
const data = await (0, import_core2.parseJsonBody)(output.body, context);
|
|
1940
|
+
let contents = {};
|
|
1941
|
+
contents = (0, import_smithy_client._json)(data);
|
|
1919
1942
|
const response = {
|
|
1920
|
-
$metadata: deserializeMetadata(output)
|
|
1943
|
+
$metadata: deserializeMetadata(output),
|
|
1944
|
+
...contents
|
|
1921
1945
|
};
|
|
1922
1946
|
return response;
|
|
1923
1947
|
}, "de_DeleteImportedKeyMaterialCommand");
|
|
@@ -3109,7 +3133,10 @@ var se_ImportKeyMaterialRequest = /* @__PURE__ */ __name((input, context) => {
|
|
|
3109
3133
|
EncryptedKeyMaterial: context.base64Encoder,
|
|
3110
3134
|
ExpirationModel: [],
|
|
3111
3135
|
ImportToken: context.base64Encoder,
|
|
3136
|
+
ImportType: [],
|
|
3112
3137
|
KeyId: [],
|
|
3138
|
+
KeyMaterialDescription: [],
|
|
3139
|
+
KeyMaterialId: [],
|
|
3113
3140
|
ValidTo: /* @__PURE__ */ __name((_) => _.getTime() / 1e3, "ValidTo")
|
|
3114
3141
|
});
|
|
3115
3142
|
}, "se_ImportKeyMaterialRequest");
|
|
@@ -3207,6 +3234,7 @@ var de_DecryptResponse = /* @__PURE__ */ __name((output, context) => {
|
|
|
3207
3234
|
CiphertextForRecipient: context.base64Decoder,
|
|
3208
3235
|
EncryptionAlgorithm: import_smithy_client.expectString,
|
|
3209
3236
|
KeyId: import_smithy_client.expectString,
|
|
3237
|
+
KeyMaterialId: import_smithy_client.expectString,
|
|
3210
3238
|
Plaintext: context.base64Decoder
|
|
3211
3239
|
});
|
|
3212
3240
|
}, "de_DecryptResponse");
|
|
@@ -3235,13 +3263,15 @@ var de_EncryptResponse = /* @__PURE__ */ __name((output, context) => {
|
|
|
3235
3263
|
return (0, import_smithy_client.take)(output, {
|
|
3236
3264
|
CiphertextBlob: context.base64Decoder,
|
|
3237
3265
|
EncryptionAlgorithm: import_smithy_client.expectString,
|
|
3238
|
-
KeyId: import_smithy_client.expectString
|
|
3266
|
+
KeyId: import_smithy_client.expectString,
|
|
3267
|
+
KeyMaterialId: import_smithy_client.expectString
|
|
3239
3268
|
});
|
|
3240
3269
|
}, "de_EncryptResponse");
|
|
3241
3270
|
var de_GenerateDataKeyPairResponse = /* @__PURE__ */ __name((output, context) => {
|
|
3242
3271
|
return (0, import_smithy_client.take)(output, {
|
|
3243
3272
|
CiphertextForRecipient: context.base64Decoder,
|
|
3244
3273
|
KeyId: import_smithy_client.expectString,
|
|
3274
|
+
KeyMaterialId: import_smithy_client.expectString,
|
|
3245
3275
|
KeyPairSpec: import_smithy_client.expectString,
|
|
3246
3276
|
PrivateKeyCiphertextBlob: context.base64Decoder,
|
|
3247
3277
|
PrivateKeyPlaintext: context.base64Decoder,
|
|
@@ -3251,6 +3281,7 @@ var de_GenerateDataKeyPairResponse = /* @__PURE__ */ __name((output, context) =>
|
|
|
3251
3281
|
var de_GenerateDataKeyPairWithoutPlaintextResponse = /* @__PURE__ */ __name((output, context) => {
|
|
3252
3282
|
return (0, import_smithy_client.take)(output, {
|
|
3253
3283
|
KeyId: import_smithy_client.expectString,
|
|
3284
|
+
KeyMaterialId: import_smithy_client.expectString,
|
|
3254
3285
|
KeyPairSpec: import_smithy_client.expectString,
|
|
3255
3286
|
PrivateKeyCiphertextBlob: context.base64Decoder,
|
|
3256
3287
|
PublicKey: context.base64Decoder
|
|
@@ -3261,13 +3292,15 @@ var de_GenerateDataKeyResponse = /* @__PURE__ */ __name((output, context) => {
|
|
|
3261
3292
|
CiphertextBlob: context.base64Decoder,
|
|
3262
3293
|
CiphertextForRecipient: context.base64Decoder,
|
|
3263
3294
|
KeyId: import_smithy_client.expectString,
|
|
3295
|
+
KeyMaterialId: import_smithy_client.expectString,
|
|
3264
3296
|
Plaintext: context.base64Decoder
|
|
3265
3297
|
});
|
|
3266
3298
|
}, "de_GenerateDataKeyResponse");
|
|
3267
3299
|
var de_GenerateDataKeyWithoutPlaintextResponse = /* @__PURE__ */ __name((output, context) => {
|
|
3268
3300
|
return (0, import_smithy_client.take)(output, {
|
|
3269
3301
|
CiphertextBlob: context.base64Decoder,
|
|
3270
|
-
KeyId: import_smithy_client.expectString
|
|
3302
|
+
KeyId: import_smithy_client.expectString,
|
|
3303
|
+
KeyMaterialId: import_smithy_client.expectString
|
|
3271
3304
|
});
|
|
3272
3305
|
}, "de_GenerateDataKeyWithoutPlaintextResponse");
|
|
3273
3306
|
var de_GenerateMacResponse = /* @__PURE__ */ __name((output, context) => {
|
|
@@ -3337,6 +3370,7 @@ var de_KeyMetadata = /* @__PURE__ */ __name((output, context) => {
|
|
|
3337
3370
|
Arn: import_smithy_client.expectString,
|
|
3338
3371
|
CloudHsmClusterId: import_smithy_client.expectString,
|
|
3339
3372
|
CreationDate: /* @__PURE__ */ __name((_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))), "CreationDate"),
|
|
3373
|
+
CurrentKeyMaterialId: import_smithy_client.expectString,
|
|
3340
3374
|
CustomKeyStoreId: import_smithy_client.expectString,
|
|
3341
3375
|
CustomerMasterKeySpec: import_smithy_client.expectString,
|
|
3342
3376
|
DeletionDate: /* @__PURE__ */ __name((_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))), "DeletionDate"),
|
|
@@ -3385,9 +3419,11 @@ var de_ReEncryptResponse = /* @__PURE__ */ __name((output, context) => {
|
|
|
3385
3419
|
return (0, import_smithy_client.take)(output, {
|
|
3386
3420
|
CiphertextBlob: context.base64Decoder,
|
|
3387
3421
|
DestinationEncryptionAlgorithm: import_smithy_client.expectString,
|
|
3422
|
+
DestinationKeyMaterialId: import_smithy_client.expectString,
|
|
3388
3423
|
KeyId: import_smithy_client.expectString,
|
|
3389
3424
|
SourceEncryptionAlgorithm: import_smithy_client.expectString,
|
|
3390
|
-
SourceKeyId: import_smithy_client.expectString
|
|
3425
|
+
SourceKeyId: import_smithy_client.expectString,
|
|
3426
|
+
SourceKeyMaterialId: import_smithy_client.expectString
|
|
3391
3427
|
});
|
|
3392
3428
|
}, "de_ReEncryptResponse");
|
|
3393
3429
|
var de_ReplicateKeyResponse = /* @__PURE__ */ __name((output, context) => {
|
|
@@ -3405,9 +3441,15 @@ var de_RotationsList = /* @__PURE__ */ __name((output, context) => {
|
|
|
3405
3441
|
}, "de_RotationsList");
|
|
3406
3442
|
var de_RotationsListEntry = /* @__PURE__ */ __name((output, context) => {
|
|
3407
3443
|
return (0, import_smithy_client.take)(output, {
|
|
3444
|
+
ExpirationModel: import_smithy_client.expectString,
|
|
3445
|
+
ImportState: import_smithy_client.expectString,
|
|
3408
3446
|
KeyId: import_smithy_client.expectString,
|
|
3447
|
+
KeyMaterialDescription: import_smithy_client.expectString,
|
|
3448
|
+
KeyMaterialId: import_smithy_client.expectString,
|
|
3449
|
+
KeyMaterialState: import_smithy_client.expectString,
|
|
3409
3450
|
RotationDate: /* @__PURE__ */ __name((_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))), "RotationDate"),
|
|
3410
|
-
RotationType: import_smithy_client.expectString
|
|
3451
|
+
RotationType: import_smithy_client.expectString,
|
|
3452
|
+
ValidTo: /* @__PURE__ */ __name((_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))), "ValidTo")
|
|
3411
3453
|
});
|
|
3412
3454
|
}, "de_RotationsListEntry");
|
|
3413
3455
|
var de_ScheduleKeyDeletionResponse = /* @__PURE__ */ __name((output, context) => {
|
|
@@ -4478,9 +4520,13 @@ var paginateListRetirableGrants = (0, import_core.createPaginator)(KMSClient, Li
|
|
|
4478
4520
|
InvalidMarkerException,
|
|
4479
4521
|
ExpiredImportTokenException,
|
|
4480
4522
|
WrappingKeySpec,
|
|
4523
|
+
ImportType,
|
|
4481
4524
|
IncorrectKeyMaterialException,
|
|
4482
4525
|
InvalidImportTokenException,
|
|
4526
|
+
ImportState,
|
|
4527
|
+
IncludeKeyMaterial,
|
|
4483
4528
|
InvalidGrantIdException,
|
|
4529
|
+
KeyMaterialState,
|
|
4484
4530
|
KMSInvalidMacException,
|
|
4485
4531
|
KMSInvalidSignatureException,
|
|
4486
4532
|
RotationType,
|
|
@@ -692,6 +692,10 @@ export const WrappingKeySpec = {
|
|
|
692
692
|
RSA_4096: "RSA_4096",
|
|
693
693
|
SM2: "SM2",
|
|
694
694
|
};
|
|
695
|
+
export const ImportType = {
|
|
696
|
+
EXISTING_KEY_MATERIAL: "EXISTING_KEY_MATERIAL",
|
|
697
|
+
NEW_KEY_MATERIAL: "NEW_KEY_MATERIAL",
|
|
698
|
+
};
|
|
695
699
|
export class IncorrectKeyMaterialException extends __BaseException {
|
|
696
700
|
name = "IncorrectKeyMaterialException";
|
|
697
701
|
$fault = "client";
|
|
@@ -716,6 +720,14 @@ export class InvalidImportTokenException extends __BaseException {
|
|
|
716
720
|
Object.setPrototypeOf(this, InvalidImportTokenException.prototype);
|
|
717
721
|
}
|
|
718
722
|
}
|
|
723
|
+
export const ImportState = {
|
|
724
|
+
IMPORTED: "IMPORTED",
|
|
725
|
+
PENDING_IMPORT: "PENDING_IMPORT",
|
|
726
|
+
};
|
|
727
|
+
export const IncludeKeyMaterial = {
|
|
728
|
+
ALL_KEY_MATERIAL: "ALL_KEY_MATERIAL",
|
|
729
|
+
ROTATIONS_ONLY: "ROTATIONS_ONLY",
|
|
730
|
+
};
|
|
719
731
|
export class InvalidGrantIdException extends __BaseException {
|
|
720
732
|
name = "InvalidGrantIdException";
|
|
721
733
|
$fault = "client";
|
|
@@ -728,6 +740,11 @@ export class InvalidGrantIdException extends __BaseException {
|
|
|
728
740
|
Object.setPrototypeOf(this, InvalidGrantIdException.prototype);
|
|
729
741
|
}
|
|
730
742
|
}
|
|
743
|
+
export const KeyMaterialState = {
|
|
744
|
+
CURRENT: "CURRENT",
|
|
745
|
+
NON_CURRENT: "NON_CURRENT",
|
|
746
|
+
PENDING_ROTATION: "PENDING_ROTATION",
|
|
747
|
+
};
|
|
731
748
|
export class KMSInvalidMacException extends __BaseException {
|
|
732
749
|
name = "KMSInvalidMacException";
|
|
733
750
|
$fault = "client";
|
|
@@ -436,9 +436,12 @@ export const de_DeleteImportedKeyMaterialCommand = async (output, context) => {
|
|
|
436
436
|
if (output.statusCode >= 300) {
|
|
437
437
|
return de_CommandError(output, context);
|
|
438
438
|
}
|
|
439
|
-
await
|
|
439
|
+
const data = await parseBody(output.body, context);
|
|
440
|
+
let contents = {};
|
|
441
|
+
contents = _json(data);
|
|
440
442
|
const response = {
|
|
441
443
|
$metadata: deserializeMetadata(output),
|
|
444
|
+
...contents,
|
|
442
445
|
};
|
|
443
446
|
return response;
|
|
444
447
|
};
|
|
@@ -1630,7 +1633,10 @@ const se_ImportKeyMaterialRequest = (input, context) => {
|
|
|
1630
1633
|
EncryptedKeyMaterial: context.base64Encoder,
|
|
1631
1634
|
ExpirationModel: [],
|
|
1632
1635
|
ImportToken: context.base64Encoder,
|
|
1636
|
+
ImportType: [],
|
|
1633
1637
|
KeyId: [],
|
|
1638
|
+
KeyMaterialDescription: [],
|
|
1639
|
+
KeyMaterialId: [],
|
|
1634
1640
|
ValidTo: (_) => _.getTime() / 1_000,
|
|
1635
1641
|
});
|
|
1636
1642
|
};
|
|
@@ -1732,6 +1738,7 @@ const de_DecryptResponse = (output, context) => {
|
|
|
1732
1738
|
CiphertextForRecipient: context.base64Decoder,
|
|
1733
1739
|
EncryptionAlgorithm: __expectString,
|
|
1734
1740
|
KeyId: __expectString,
|
|
1741
|
+
KeyMaterialId: __expectString,
|
|
1735
1742
|
Plaintext: context.base64Decoder,
|
|
1736
1743
|
});
|
|
1737
1744
|
};
|
|
@@ -1761,12 +1768,14 @@ const de_EncryptResponse = (output, context) => {
|
|
|
1761
1768
|
CiphertextBlob: context.base64Decoder,
|
|
1762
1769
|
EncryptionAlgorithm: __expectString,
|
|
1763
1770
|
KeyId: __expectString,
|
|
1771
|
+
KeyMaterialId: __expectString,
|
|
1764
1772
|
});
|
|
1765
1773
|
};
|
|
1766
1774
|
const de_GenerateDataKeyPairResponse = (output, context) => {
|
|
1767
1775
|
return take(output, {
|
|
1768
1776
|
CiphertextForRecipient: context.base64Decoder,
|
|
1769
1777
|
KeyId: __expectString,
|
|
1778
|
+
KeyMaterialId: __expectString,
|
|
1770
1779
|
KeyPairSpec: __expectString,
|
|
1771
1780
|
PrivateKeyCiphertextBlob: context.base64Decoder,
|
|
1772
1781
|
PrivateKeyPlaintext: context.base64Decoder,
|
|
@@ -1776,6 +1785,7 @@ const de_GenerateDataKeyPairResponse = (output, context) => {
|
|
|
1776
1785
|
const de_GenerateDataKeyPairWithoutPlaintextResponse = (output, context) => {
|
|
1777
1786
|
return take(output, {
|
|
1778
1787
|
KeyId: __expectString,
|
|
1788
|
+
KeyMaterialId: __expectString,
|
|
1779
1789
|
KeyPairSpec: __expectString,
|
|
1780
1790
|
PrivateKeyCiphertextBlob: context.base64Decoder,
|
|
1781
1791
|
PublicKey: context.base64Decoder,
|
|
@@ -1786,6 +1796,7 @@ const de_GenerateDataKeyResponse = (output, context) => {
|
|
|
1786
1796
|
CiphertextBlob: context.base64Decoder,
|
|
1787
1797
|
CiphertextForRecipient: context.base64Decoder,
|
|
1788
1798
|
KeyId: __expectString,
|
|
1799
|
+
KeyMaterialId: __expectString,
|
|
1789
1800
|
Plaintext: context.base64Decoder,
|
|
1790
1801
|
});
|
|
1791
1802
|
};
|
|
@@ -1793,6 +1804,7 @@ const de_GenerateDataKeyWithoutPlaintextResponse = (output, context) => {
|
|
|
1793
1804
|
return take(output, {
|
|
1794
1805
|
CiphertextBlob: context.base64Decoder,
|
|
1795
1806
|
KeyId: __expectString,
|
|
1807
|
+
KeyMaterialId: __expectString,
|
|
1796
1808
|
});
|
|
1797
1809
|
};
|
|
1798
1810
|
const de_GenerateMacResponse = (output, context) => {
|
|
@@ -1864,6 +1876,7 @@ const de_KeyMetadata = (output, context) => {
|
|
|
1864
1876
|
Arn: __expectString,
|
|
1865
1877
|
CloudHsmClusterId: __expectString,
|
|
1866
1878
|
CreationDate: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
1879
|
+
CurrentKeyMaterialId: __expectString,
|
|
1867
1880
|
CustomKeyStoreId: __expectString,
|
|
1868
1881
|
CustomerMasterKeySpec: __expectString,
|
|
1869
1882
|
DeletionDate: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
@@ -1912,9 +1925,11 @@ const de_ReEncryptResponse = (output, context) => {
|
|
|
1912
1925
|
return take(output, {
|
|
1913
1926
|
CiphertextBlob: context.base64Decoder,
|
|
1914
1927
|
DestinationEncryptionAlgorithm: __expectString,
|
|
1928
|
+
DestinationKeyMaterialId: __expectString,
|
|
1915
1929
|
KeyId: __expectString,
|
|
1916
1930
|
SourceEncryptionAlgorithm: __expectString,
|
|
1917
1931
|
SourceKeyId: __expectString,
|
|
1932
|
+
SourceKeyMaterialId: __expectString,
|
|
1918
1933
|
});
|
|
1919
1934
|
};
|
|
1920
1935
|
const de_ReplicateKeyResponse = (output, context) => {
|
|
@@ -1934,9 +1949,15 @@ const de_RotationsList = (output, context) => {
|
|
|
1934
1949
|
};
|
|
1935
1950
|
const de_RotationsListEntry = (output, context) => {
|
|
1936
1951
|
return take(output, {
|
|
1952
|
+
ExpirationModel: __expectString,
|
|
1953
|
+
ImportState: __expectString,
|
|
1937
1954
|
KeyId: __expectString,
|
|
1955
|
+
KeyMaterialDescription: __expectString,
|
|
1956
|
+
KeyMaterialId: __expectString,
|
|
1957
|
+
KeyMaterialState: __expectString,
|
|
1938
1958
|
RotationDate: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
1939
1959
|
RotationType: __expectString,
|
|
1960
|
+
ValidTo: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
1940
1961
|
});
|
|
1941
1962
|
};
|
|
1942
1963
|
const de_ScheduleKeyDeletionResponse = (output, context) => {
|
|
@@ -42,7 +42,7 @@ declare const CancelKeyDeletionCommand_base: {
|
|
|
42
42
|
* </p>
|
|
43
43
|
* <p>
|
|
44
44
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
45
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
45
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
|
|
46
46
|
* @example
|
|
47
47
|
* Use a bare-bones client and the command you need to make an API call.
|
|
48
48
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const ConnectCustomKeyStoreCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Connects or reconnects a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
30
|
+
* <p>Connects or reconnects a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom key store</a> to its backing key store. For an CloudHSM key
|
|
31
31
|
* store, <code>ConnectCustomKeyStore</code> connects the key store to its associated CloudHSM
|
|
32
32
|
* cluster. For an external key store, <code>ConnectCustomKeyStore</code> connects the key store
|
|
33
33
|
* to the external key store proxy that communicates with your external key manager.</p>
|
|
@@ -39,7 +39,7 @@ declare const ConnectCustomKeyStoreCommand_base: {
|
|
|
39
39
|
* complete. When it succeeds, this operation quickly returns an HTTP 200 response and a JSON
|
|
40
40
|
* object with no properties. However, this response does not indicate that the custom key store
|
|
41
41
|
* is connected. To get the connection state of the custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
|
|
42
|
-
* <p> This operation is part of the
|
|
42
|
+
* <p> This operation is part of the custom key stores feature in KMS, which
|
|
43
43
|
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
44
44
|
* key store that you own and manage.</p>
|
|
45
45
|
* <p>The <code>ConnectCustomKeyStore</code> operation might fail for various reasons. To find
|
|
@@ -58,7 +58,7 @@ declare const ConnectCustomKeyStoreCommand_base: {
|
|
|
58
58
|
* password.</p>
|
|
59
59
|
* <p>To connect an CloudHSM key store, its associated CloudHSM cluster must have at least one active
|
|
60
60
|
* HSM. To get the number of active HSMs in a cluster, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html">DescribeClusters</a> operation. To add HSMs
|
|
61
|
-
* to the cluster, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html">CreateHsm</a> operation. Also, the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
61
|
+
* to the cluster, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html">CreateHsm</a> operation. Also, the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html#concept-kmsuser">
|
|
62
62
|
* <code>kmsuser</code> crypto
|
|
63
63
|
* user</a> (CU) must not be logged into the cluster. This prevents KMS from using this
|
|
64
64
|
* account to log in.</p>
|
|
@@ -116,7 +116,7 @@ declare const ConnectCustomKeyStoreCommand_base: {
|
|
|
116
116
|
* </ul>
|
|
117
117
|
* <p>
|
|
118
118
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
119
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
119
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
|
|
120
120
|
* @example
|
|
121
121
|
* Use a bare-bones client and the command you need to make an API call.
|
|
122
122
|
* ```javascript
|
|
@@ -31,7 +31,7 @@ declare const CreateAliasCommand_base: {
|
|
|
31
31
|
* <note>
|
|
32
32
|
* <p>Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">ABAC for KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
33
33
|
* </note>
|
|
34
|
-
* <p>You can use an alias to identify a KMS key in the KMS console, in the <a>DescribeKey</a> operation and in <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
34
|
+
* <p>You can use an alias to identify a KMS key in the KMS console, in the <a>DescribeKey</a> operation and in <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-cryptography.html#cryptographic-operations">cryptographic operations</a>, such as <a>Encrypt</a> and
|
|
35
35
|
* <a>GenerateDataKey</a>. You can also change the KMS key that's associated with
|
|
36
36
|
* the alias (<a>UpdateAlias</a>) or delete the alias (<a>DeleteAlias</a>)
|
|
37
37
|
* at any time. These operations don't affect the underlying KMS key. </p>
|
|
@@ -39,7 +39,7 @@ declare const CreateAliasCommand_base: {
|
|
|
39
39
|
* alias is associated with only one KMS key at a time, but a KMS key can have multiple aliases.
|
|
40
40
|
* A valid KMS key is required. You can't create an alias without a KMS key.</p>
|
|
41
41
|
* <p>The alias must be unique in the account and Region, but you can have aliases with the same
|
|
42
|
-
* name in different Regions. For detailed information about aliases, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html">
|
|
42
|
+
* name in different Regions. For detailed information about aliases, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html">Aliases in KMS</a> in the
|
|
43
43
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
44
44
|
* <p>This operation does not return a response. To get the alias that you created, use the
|
|
45
45
|
* <a>ListAliases</a> operation.</p>
|
|
@@ -62,8 +62,7 @@ declare const CreateAliasCommand_base: {
|
|
|
62
62
|
* the KMS key (key policy).</p>
|
|
63
63
|
* </li>
|
|
64
64
|
* </ul>
|
|
65
|
-
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
66
|
-
* <i>Key Management Service Developer Guide</i>.</p>
|
|
65
|
+
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/alias-access.html">Controlling access to aliases</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
67
66
|
* <p>
|
|
68
67
|
* <b>Related operations:</b>
|
|
69
68
|
* </p>
|
|
@@ -86,7 +85,7 @@ declare const CreateAliasCommand_base: {
|
|
|
86
85
|
* </ul>
|
|
87
86
|
* <p>
|
|
88
87
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
89
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
88
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
|
|
90
89
|
* @example
|
|
91
90
|
* Use a bare-bones client and the command you need to make an API call.
|
|
92
91
|
* ```javascript
|
|
@@ -145,8 +144,9 @@ declare const CreateAliasCommand_base: {
|
|
|
145
144
|
* </ul>
|
|
146
145
|
*
|
|
147
146
|
* @throws {@link LimitExceededException} (client fault)
|
|
148
|
-
* <p>The request was rejected because a quota was exceeded. For more
|
|
149
|
-
*
|
|
147
|
+
* <p>The request was rejected because a length constraint or quota was exceeded. For more
|
|
148
|
+
* information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in
|
|
149
|
+
* the <i>Key Management Service Developer Guide</i>.</p>
|
|
150
150
|
*
|
|
151
151
|
* @throws {@link NotFoundException} (client fault)
|
|
152
152
|
* <p>The request was rejected because the specified entity or resource could not be
|
|
@@ -27,14 +27,14 @@ declare const CreateCustomKeyStoreCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
30
|
+
* <p>Creates a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom key store</a> backed by a key store that you own and manage. When you use a
|
|
31
31
|
* KMS key in a custom key store for a cryptographic operation, the cryptographic operation is
|
|
32
32
|
* actually performed in your key store using your keys. KMS supports <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html">CloudHSM key stores</a>
|
|
33
33
|
* backed by an <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/clusters.html">CloudHSM cluster</a>
|
|
34
34
|
* and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html">external key
|
|
35
35
|
* stores</a> backed by an external key store proxy and external key manager outside of
|
|
36
36
|
* Amazon Web Services.</p>
|
|
37
|
-
* <p> This operation is part of the
|
|
37
|
+
* <p> This operation is part of the custom key stores feature in KMS, which
|
|
38
38
|
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
39
39
|
* key store that you own and manage.</p>
|
|
40
40
|
* <p>Before you create the custom key store, the required elements must be in place and
|
|
@@ -80,8 +80,6 @@ declare const CreateCustomKeyStoreCommand_base: {
|
|
|
80
80
|
* external key manager. Even if you are not going to use your custom key store immediately, you
|
|
81
81
|
* might want to connect it to verify that all settings are correct and then disconnect it until
|
|
82
82
|
* you are ready to use it.</p>
|
|
83
|
-
* <p>For help with failures, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html">Troubleshooting a custom key store</a> in the
|
|
84
|
-
* <i>Key Management Service Developer Guide</i>.</p>
|
|
85
83
|
* <p>
|
|
86
84
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
87
85
|
* <p>
|
|
@@ -118,7 +116,7 @@ declare const CreateCustomKeyStoreCommand_base: {
|
|
|
118
116
|
* </ul>
|
|
119
117
|
* <p>
|
|
120
118
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
121
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
119
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
|
|
122
120
|
* @example
|
|
123
121
|
* Use a bare-bones client and the command you need to make an API call.
|
|
124
122
|
* ```javascript
|
|
@@ -222,8 +220,9 @@ declare const CreateCustomKeyStoreCommand_base: {
|
|
|
222
220
|
* retried.</p>
|
|
223
221
|
*
|
|
224
222
|
* @throws {@link LimitExceededException} (client fault)
|
|
225
|
-
* <p>The request was rejected because a quota was exceeded. For more
|
|
226
|
-
*
|
|
223
|
+
* <p>The request was rejected because a length constraint or quota was exceeded. For more
|
|
224
|
+
* information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in
|
|
225
|
+
* the <i>Key Management Service Developer Guide</i>.</p>
|
|
227
226
|
*
|
|
228
227
|
* @throws {@link XksProxyIncorrectAuthenticationCredentialException} (client fault)
|
|
229
228
|
* <p>The request was rejected because the proxy credentials failed to authenticate to the
|
|
@@ -36,8 +36,8 @@ declare const CreateGrantCommand_base: {
|
|
|
36
36
|
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Grants in KMS</a> in the
|
|
37
37
|
* <i>
|
|
38
38
|
* <i>Key Management Service Developer Guide</i>
|
|
39
|
-
* </i>. For examples of
|
|
40
|
-
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
39
|
+
* </i>. For examples of creating grants in several
|
|
40
|
+
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/example_kms_CreateGrant_section.html">Use CreateGrant with an Amazon Web Services SDK or CLI</a>. </p>
|
|
41
41
|
* <p>The <code>CreateGrant</code> operation returns a <code>GrantToken</code> and a
|
|
42
42
|
* <code>GrantId</code>.</p>
|
|
43
43
|
* <ul>
|
|
@@ -45,8 +45,8 @@ declare const CreateGrantCommand_base: {
|
|
|
45
45
|
* <p>When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as <i>eventual consistency</i>. Once the grant has achieved eventual consistency, the grantee
|
|
46
46
|
* principal can use the permissions in the grant without identifying the grant. </p>
|
|
47
47
|
* <p>However, to use the permissions in the grant immediately, use the
|
|
48
|
-
* <code>GrantToken</code> that <code>CreateGrant</code> returns. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
49
|
-
*
|
|
48
|
+
* <code>GrantToken</code> that <code>CreateGrant</code> returns. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/using-grant-token.html">Using a grant
|
|
49
|
+
* token</a> in the <i>
|
|
50
50
|
* <i>Key Management Service Developer Guide</i>
|
|
51
51
|
* </i>.</p>
|
|
52
52
|
* </li>
|
|
@@ -91,7 +91,7 @@ declare const CreateGrantCommand_base: {
|
|
|
91
91
|
* </ul>
|
|
92
92
|
* <p>
|
|
93
93
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
94
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
94
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
|
|
95
95
|
* @example
|
|
96
96
|
* Use a bare-bones client and the command you need to make an API call.
|
|
97
97
|
* ```javascript
|
|
@@ -176,8 +176,9 @@ declare const CreateGrantCommand_base: {
|
|
|
176
176
|
* </ul>
|
|
177
177
|
*
|
|
178
178
|
* @throws {@link LimitExceededException} (client fault)
|
|
179
|
-
* <p>The request was rejected because a quota was exceeded. For more
|
|
180
|
-
*
|
|
179
|
+
* <p>The request was rejected because a length constraint or quota was exceeded. For more
|
|
180
|
+
* information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in
|
|
181
|
+
* the <i>Key Management Service Developer Guide</i>.</p>
|
|
181
182
|
*
|
|
182
183
|
* @throws {@link NotFoundException} (client fault)
|
|
183
184
|
* <p>The request was rejected because the specified entity or resource could not be
|
|
@@ -33,9 +33,7 @@ declare const CreateKeyCommand_base: {
|
|
|
33
33
|
* resources.</p>
|
|
34
34
|
* <p>A KMS key is a logical representation of a cryptographic key. In addition to the key
|
|
35
35
|
* material used in cryptographic operations, a KMS key includes metadata, such as the key ID,
|
|
36
|
-
* key policy, creation date, description, and key state.
|
|
37
|
-
* <i>Key Management Service Developer Guide</i>
|
|
38
|
-
* </p>
|
|
36
|
+
* key policy, creation date, description, and key state. </p>
|
|
39
37
|
* <p>Use the parameters of <code>CreateKey</code> to specify the type of KMS key, the source of
|
|
40
38
|
* its key material, its key policy, description, tags, and other properties.</p>
|
|
41
39
|
* <note>
|
|
@@ -70,13 +68,14 @@ declare const CreateKeyCommand_base: {
|
|
|
70
68
|
* <p>Asymmetric KMS keys contain an RSA key pair, Elliptic Curve (ECC) key pair, or an
|
|
71
69
|
* SM2 key pair (China Regions only). The private key in an asymmetric KMS key never leaves
|
|
72
70
|
* KMS unencrypted. However, you can use the <a>GetPublicKey</a> operation to
|
|
73
|
-
* download the public key so it can be used outside of KMS. Each KMS key can have only
|
|
74
|
-
* pairs can be used to encrypt and decrypt data or
|
|
75
|
-
* KMS keys with NIST-recommended ECC key pairs
|
|
76
|
-
* derive shared secrets (but not both). KMS
|
|
77
|
-
* can be used only to sign and verify messages. KMS
|
|
78
|
-
* can be used to either encrypt and decrypt
|
|
79
|
-
*
|
|
71
|
+
* download the public key so it can be used outside of KMS. Each KMS key can have only
|
|
72
|
+
* one key usage. KMS keys with RSA key pairs can be used to encrypt and decrypt data or
|
|
73
|
+
* sign and verify messages (but not both). KMS keys with NIST-recommended ECC key pairs
|
|
74
|
+
* can be used to sign and verify messages or derive shared secrets (but not both). KMS
|
|
75
|
+
* keys with <code>ECC_SECG_P256K1</code> can be used only to sign and verify messages. KMS
|
|
76
|
+
* keys with SM2 key pairs (China Regions only) can be used to either encrypt and decrypt
|
|
77
|
+
* data, sign and verify messages, or derive shared secrets (you must choose one key usage
|
|
78
|
+
* type). For information about asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Asymmetric KMS keys</a> in the
|
|
80
79
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
81
80
|
* <p> </p>
|
|
82
81
|
* </dd>
|
|
@@ -125,13 +124,13 @@ declare const CreateKeyCommand_base: {
|
|
|
125
124
|
* <p>To create a multi-Region primary key with imported key material, use the
|
|
126
125
|
* <code>Origin</code> parameter of <code>CreateKey</code> with a value of
|
|
127
126
|
* <code>EXTERNAL</code> and the <code>MultiRegion</code> parameter with a value of
|
|
128
|
-
* <code>True</code>. To create replicas of the multi-Region primary key, use the <a>ReplicateKey</a> operation. For instructions, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
129
|
-
*
|
|
127
|
+
* <code>True</code>. To create replicas of the multi-Region primary key, use the <a>ReplicateKey</a> operation. For instructions, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html ">Importing key material step
|
|
128
|
+
* 1</a>. For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Multi-Region keys in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
130
129
|
* <p> </p>
|
|
131
130
|
* </dd>
|
|
132
131
|
* <dt>Custom key store</dt>
|
|
133
132
|
* <dd>
|
|
134
|
-
* <p>A <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
133
|
+
* <p>A <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom key store</a> lets you protect your Amazon Web Services resources using keys in a backing key
|
|
135
134
|
* store that you own and manage. When you request a cryptographic operation with a KMS key
|
|
136
135
|
* in a custom key store, the operation is performed in the backing key store using its
|
|
137
136
|
* cryptographic keys.</p>
|
|
@@ -153,11 +152,11 @@ declare const CreateKeyCommand_base: {
|
|
|
153
152
|
* Use the default <code>KeySpec</code> value, <code>SYMMETRIC_DEFAULT</code>, and the
|
|
154
153
|
* default <code>KeyUsage</code> value, <code>ENCRYPT_DECRYPT</code> to create a symmetric
|
|
155
154
|
* encryption key. No other key type is supported in a custom key store.</p>
|
|
156
|
-
* <p>To create a KMS key in an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore
|
|
155
|
+
* <p>To create a KMS key in an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-cmk-keystore.html">CloudHSM key store</a>, use the
|
|
157
156
|
* <code>Origin</code> parameter with a value of <code>AWS_CLOUDHSM</code>. The CloudHSM
|
|
158
157
|
* cluster that is associated with the custom key store must have at least two active HSMs
|
|
159
158
|
* in different Availability Zones in the Amazon Web Services Region.</p>
|
|
160
|
-
* <p>To create a KMS key in an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
159
|
+
* <p>To create a KMS key in an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-xks-keys.html">external key store</a>, use the
|
|
161
160
|
* <code>Origin</code> parameter with a value of <code>EXTERNAL_KEY_STORE</code> and an
|
|
162
161
|
* <code>XksKeyId</code> parameter that identifies an existing external key.</p>
|
|
163
162
|
* <note>
|
|
@@ -172,8 +171,8 @@ declare const CreateKeyCommand_base: {
|
|
|
172
171
|
* <p>
|
|
173
172
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateKey</a> (IAM policy). To use the
|
|
174
173
|
* <code>Tags</code> parameter, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:TagResource</a> (IAM policy). For examples and information about related
|
|
175
|
-
* permissions, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
176
|
-
* KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
174
|
+
* permissions, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/customer-managed-policies.html#iam-policy-example-create-key">Allow a user
|
|
175
|
+
* to create KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
177
176
|
* <p>
|
|
178
177
|
* <b>Related operations:</b>
|
|
179
178
|
* </p>
|
|
@@ -196,7 +195,7 @@ declare const CreateKeyCommand_base: {
|
|
|
196
195
|
* </ul>
|
|
197
196
|
* <p>
|
|
198
197
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
199
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
198
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
|
|
200
199
|
* @example
|
|
201
200
|
* Use a bare-bones client and the command you need to make an API call.
|
|
202
201
|
* ```javascript
|
|
@@ -272,6 +271,7 @@ declare const CreateKeyCommand_base: {
|
|
|
272
271
|
* // XksKeyConfiguration: { // XksKeyConfigurationType
|
|
273
272
|
* // Id: "STRING_VALUE",
|
|
274
273
|
* // },
|
|
274
|
+
* // CurrentKeyMaterialId: "STRING_VALUE",
|
|
275
275
|
* // },
|
|
276
276
|
* // };
|
|
277
277
|
*
|
|
@@ -370,8 +370,9 @@ declare const CreateKeyCommand_base: {
|
|
|
370
370
|
* retried.</p>
|
|
371
371
|
*
|
|
372
372
|
* @throws {@link LimitExceededException} (client fault)
|
|
373
|
-
* <p>The request was rejected because a quota was exceeded. For more
|
|
374
|
-
*
|
|
373
|
+
* <p>The request was rejected because a length constraint or quota was exceeded. For more
|
|
374
|
+
* information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in
|
|
375
|
+
* the <i>Key Management Service Developer Guide</i>.</p>
|
|
375
376
|
*
|
|
376
377
|
* @throws {@link MalformedPolicyDocumentException} (client fault)
|
|
377
378
|
* <p>The request was rejected because the specified policy is not syntactically or semantically
|