@aws-sdk/client-kms 3.28.0 → 3.32.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/CHANGELOG.md +35 -0
- package/KMS.ts +567 -572
- package/KMSClient.ts +18 -18
- package/README.md +18 -18
- package/commands/CancelKeyDeletionCommand.ts +6 -7
- package/commands/ConnectCustomKeyStoreCommand.ts +9 -9
- package/commands/CreateAliasCommand.ts +13 -14
- package/commands/CreateCustomKeyStoreCommand.ts +8 -8
- package/commands/CreateGrantCommand.ts +15 -22
- package/commands/CreateKeyCommand.ts +44 -44
- package/commands/DecryptCommand.ts +23 -22
- package/commands/DeleteAliasCommand.ts +7 -8
- package/commands/DeleteCustomKeyStoreCommand.ts +13 -13
- package/commands/DeleteImportedKeyMaterialCommand.ts +9 -9
- package/commands/DescribeCustomKeyStoresCommand.ts +6 -6
- package/commands/DescribeKeyCommand.ts +18 -19
- package/commands/DisableKeyCommand.ts +7 -7
- package/commands/DisableKeyRotationCommand.ts +5 -6
- package/commands/DisconnectCustomKeyStoreCommand.ts +6 -8
- package/commands/EnableKeyCommand.ts +4 -5
- package/commands/EnableKeyRotationCommand.ts +5 -5
- package/commands/EncryptCommand.ts +20 -21
- package/commands/GenerateDataKeyCommand.ts +17 -18
- package/commands/GenerateDataKeyPairCommand.ts +21 -15
- package/commands/GenerateDataKeyPairWithoutPlaintextCommand.ts +16 -12
- package/commands/GenerateDataKeyWithoutPlaintextCommand.ts +9 -9
- package/commands/GenerateRandomCommand.ts +4 -3
- package/commands/GetKeyPolicyCommand.ts +2 -2
- package/commands/GetKeyRotationStatusCommand.ts +9 -9
- package/commands/GetParametersForImportCommand.ts +8 -8
- package/commands/GetPublicKeyCommand.ts +15 -15
- package/commands/ImportKeyMaterialCommand.ts +18 -18
- package/commands/ListAliasesCommand.ts +8 -10
- package/commands/ListGrantsCommand.ts +9 -4
- package/commands/ListKeyPoliciesCommand.ts +2 -2
- package/commands/ListKeysCommand.ts +2 -2
- package/commands/ListResourceTagsCommand.ts +4 -4
- package/commands/ListRetirableGrantsCommand.ts +14 -14
- package/commands/PutKeyPolicyCommand.ts +5 -5
- package/commands/ReEncryptCommand.ts +30 -34
- package/commands/ReplicateKeyCommand.ts +16 -16
- package/commands/RetireGrantCommand.ts +9 -9
- package/commands/RevokeGrantCommand.ts +9 -4
- package/commands/ScheduleKeyDeletionCommand.ts +17 -17
- package/commands/SignCommand.ts +12 -13
- package/commands/TagResourceCommand.ts +10 -12
- package/commands/UntagResourceCommand.ts +9 -10
- package/commands/UpdateAliasCommand.ts +15 -15
- package/commands/UpdateCustomKeyStoreCommand.ts +9 -9
- package/commands/UpdateKeyDescriptionCommand.ts +4 -4
- package/commands/UpdatePrimaryRegionCommand.ts +13 -13
- package/commands/VerifyCommand.ts +14 -14
- package/dist/cjs/KMS.js +18 -18
- package/dist/cjs/KMS.js.map +1 -1
- package/dist/cjs/KMSClient.js +18 -18
- package/dist/cjs/commands/CancelKeyDeletionCommand.js +6 -7
- package/dist/cjs/commands/CancelKeyDeletionCommand.js.map +1 -1
- package/dist/cjs/commands/ConnectCustomKeyStoreCommand.js +9 -9
- package/dist/cjs/commands/CreateAliasCommand.js +13 -14
- package/dist/cjs/commands/CreateAliasCommand.js.map +1 -1
- package/dist/cjs/commands/CreateCustomKeyStoreCommand.js +8 -8
- package/dist/cjs/commands/CreateGrantCommand.js +15 -22
- package/dist/cjs/commands/CreateGrantCommand.js.map +1 -1
- package/dist/cjs/commands/CreateKeyCommand.js +44 -44
- package/dist/cjs/commands/DecryptCommand.js +23 -22
- package/dist/cjs/commands/DecryptCommand.js.map +1 -1
- package/dist/cjs/commands/DeleteAliasCommand.js +7 -8
- package/dist/cjs/commands/DeleteAliasCommand.js.map +1 -1
- package/dist/cjs/commands/DeleteCustomKeyStoreCommand.js +13 -13
- package/dist/cjs/commands/DeleteImportedKeyMaterialCommand.js +9 -9
- package/dist/cjs/commands/DescribeCustomKeyStoresCommand.js +6 -6
- package/dist/cjs/commands/DescribeKeyCommand.js +18 -19
- package/dist/cjs/commands/DescribeKeyCommand.js.map +1 -1
- package/dist/cjs/commands/DisableKeyCommand.js +7 -7
- package/dist/cjs/commands/DisableKeyRotationCommand.js +5 -6
- package/dist/cjs/commands/DisableKeyRotationCommand.js.map +1 -1
- package/dist/cjs/commands/DisconnectCustomKeyStoreCommand.js +6 -8
- package/dist/cjs/commands/DisconnectCustomKeyStoreCommand.js.map +1 -1
- package/dist/cjs/commands/EnableKeyCommand.js +4 -5
- package/dist/cjs/commands/EnableKeyCommand.js.map +1 -1
- package/dist/cjs/commands/EnableKeyRotationCommand.js +5 -5
- package/dist/cjs/commands/EncryptCommand.js +20 -21
- package/dist/cjs/commands/EncryptCommand.js.map +1 -1
- package/dist/cjs/commands/GenerateDataKeyCommand.js +17 -18
- package/dist/cjs/commands/GenerateDataKeyCommand.js.map +1 -1
- package/dist/cjs/commands/GenerateDataKeyPairCommand.js +21 -15
- package/dist/cjs/commands/GenerateDataKeyPairCommand.js.map +1 -1
- package/dist/cjs/commands/GenerateDataKeyPairWithoutPlaintextCommand.js +16 -12
- package/dist/cjs/commands/GenerateDataKeyPairWithoutPlaintextCommand.js.map +1 -1
- package/dist/cjs/commands/GenerateDataKeyWithoutPlaintextCommand.js +9 -9
- package/dist/cjs/commands/GenerateRandomCommand.js +4 -3
- package/dist/cjs/commands/GenerateRandomCommand.js.map +1 -1
- package/dist/cjs/commands/GetKeyPolicyCommand.js +2 -2
- package/dist/cjs/commands/GetKeyRotationStatusCommand.js +9 -9
- package/dist/cjs/commands/GetParametersForImportCommand.js +8 -8
- package/dist/cjs/commands/GetPublicKeyCommand.js +15 -15
- package/dist/cjs/commands/ImportKeyMaterialCommand.js +18 -18
- package/dist/cjs/commands/ListAliasesCommand.js +8 -10
- package/dist/cjs/commands/ListAliasesCommand.js.map +1 -1
- package/dist/cjs/commands/ListGrantsCommand.js +9 -4
- package/dist/cjs/commands/ListGrantsCommand.js.map +1 -1
- package/dist/cjs/commands/ListKeyPoliciesCommand.js +2 -2
- package/dist/cjs/commands/ListKeysCommand.js +2 -2
- package/dist/cjs/commands/ListResourceTagsCommand.js +4 -4
- package/dist/cjs/commands/ListRetirableGrantsCommand.js +14 -14
- package/dist/cjs/commands/PutKeyPolicyCommand.js +5 -5
- package/dist/cjs/commands/ReEncryptCommand.js +30 -34
- package/dist/cjs/commands/ReEncryptCommand.js.map +1 -1
- package/dist/cjs/commands/ReplicateKeyCommand.js +16 -16
- package/dist/cjs/commands/RetireGrantCommand.js +9 -9
- package/dist/cjs/commands/RevokeGrantCommand.js +9 -4
- package/dist/cjs/commands/RevokeGrantCommand.js.map +1 -1
- package/dist/cjs/commands/ScheduleKeyDeletionCommand.js +17 -17
- package/dist/cjs/commands/SignCommand.js +12 -13
- package/dist/cjs/commands/SignCommand.js.map +1 -1
- package/dist/cjs/commands/TagResourceCommand.js +10 -12
- package/dist/cjs/commands/TagResourceCommand.js.map +1 -1
- package/dist/cjs/commands/UntagResourceCommand.js +9 -10
- package/dist/cjs/commands/UntagResourceCommand.js.map +1 -1
- package/dist/cjs/commands/UpdateAliasCommand.js +15 -15
- package/dist/cjs/commands/UpdateCustomKeyStoreCommand.js +9 -9
- package/dist/cjs/commands/UpdateKeyDescriptionCommand.js +4 -4
- package/dist/cjs/commands/UpdatePrimaryRegionCommand.js +13 -13
- package/dist/cjs/commands/VerifyCommand.js +14 -14
- package/dist/cjs/models/models_0.js +14 -3
- package/dist/cjs/models/models_0.js.map +1 -1
- package/dist/cjs/package.json +31 -31
- package/dist/cjs/protocols/Aws_json1_1.js +16 -11
- package/dist/cjs/protocols/Aws_json1_1.js.map +1 -1
- package/dist/es/KMS.js +18 -18
- package/dist/es/KMS.js.map +1 -1
- package/dist/es/KMSClient.js +18 -18
- package/dist/es/commands/CancelKeyDeletionCommand.js +6 -7
- package/dist/es/commands/CancelKeyDeletionCommand.js.map +1 -1
- package/dist/es/commands/ConnectCustomKeyStoreCommand.js +9 -9
- package/dist/es/commands/CreateAliasCommand.js +13 -14
- package/dist/es/commands/CreateAliasCommand.js.map +1 -1
- package/dist/es/commands/CreateCustomKeyStoreCommand.js +8 -8
- package/dist/es/commands/CreateGrantCommand.js +15 -22
- package/dist/es/commands/CreateGrantCommand.js.map +1 -1
- package/dist/es/commands/CreateKeyCommand.js +44 -44
- package/dist/es/commands/DecryptCommand.js +23 -22
- package/dist/es/commands/DecryptCommand.js.map +1 -1
- package/dist/es/commands/DeleteAliasCommand.js +7 -8
- package/dist/es/commands/DeleteAliasCommand.js.map +1 -1
- package/dist/es/commands/DeleteCustomKeyStoreCommand.js +13 -13
- package/dist/es/commands/DeleteImportedKeyMaterialCommand.js +9 -9
- package/dist/es/commands/DescribeCustomKeyStoresCommand.js +6 -6
- package/dist/es/commands/DescribeKeyCommand.js +18 -19
- package/dist/es/commands/DescribeKeyCommand.js.map +1 -1
- package/dist/es/commands/DisableKeyCommand.js +7 -7
- package/dist/es/commands/DisableKeyRotationCommand.js +5 -6
- package/dist/es/commands/DisableKeyRotationCommand.js.map +1 -1
- package/dist/es/commands/DisconnectCustomKeyStoreCommand.js +6 -8
- package/dist/es/commands/DisconnectCustomKeyStoreCommand.js.map +1 -1
- package/dist/es/commands/EnableKeyCommand.js +4 -5
- package/dist/es/commands/EnableKeyCommand.js.map +1 -1
- package/dist/es/commands/EnableKeyRotationCommand.js +5 -5
- package/dist/es/commands/EncryptCommand.js +20 -21
- package/dist/es/commands/EncryptCommand.js.map +1 -1
- package/dist/es/commands/GenerateDataKeyCommand.js +17 -18
- package/dist/es/commands/GenerateDataKeyCommand.js.map +1 -1
- package/dist/es/commands/GenerateDataKeyPairCommand.js +21 -15
- package/dist/es/commands/GenerateDataKeyPairCommand.js.map +1 -1
- package/dist/es/commands/GenerateDataKeyPairWithoutPlaintextCommand.js +16 -12
- package/dist/es/commands/GenerateDataKeyPairWithoutPlaintextCommand.js.map +1 -1
- package/dist/es/commands/GenerateDataKeyWithoutPlaintextCommand.js +9 -9
- package/dist/es/commands/GenerateRandomCommand.js +4 -3
- package/dist/es/commands/GenerateRandomCommand.js.map +1 -1
- package/dist/es/commands/GetKeyPolicyCommand.js +2 -2
- package/dist/es/commands/GetKeyRotationStatusCommand.js +9 -9
- package/dist/es/commands/GetParametersForImportCommand.js +8 -8
- package/dist/es/commands/GetPublicKeyCommand.js +15 -15
- package/dist/es/commands/ImportKeyMaterialCommand.js +18 -18
- package/dist/es/commands/ListAliasesCommand.js +8 -10
- package/dist/es/commands/ListAliasesCommand.js.map +1 -1
- package/dist/es/commands/ListGrantsCommand.js +9 -4
- package/dist/es/commands/ListGrantsCommand.js.map +1 -1
- package/dist/es/commands/ListKeyPoliciesCommand.js +2 -2
- package/dist/es/commands/ListKeysCommand.js +2 -2
- package/dist/es/commands/ListResourceTagsCommand.js +4 -4
- package/dist/es/commands/ListRetirableGrantsCommand.js +14 -14
- package/dist/es/commands/PutKeyPolicyCommand.js +5 -5
- package/dist/es/commands/ReEncryptCommand.js +30 -34
- package/dist/es/commands/ReEncryptCommand.js.map +1 -1
- package/dist/es/commands/ReplicateKeyCommand.js +16 -16
- package/dist/es/commands/RetireGrantCommand.js +9 -9
- package/dist/es/commands/RevokeGrantCommand.js +9 -4
- package/dist/es/commands/RevokeGrantCommand.js.map +1 -1
- package/dist/es/commands/ScheduleKeyDeletionCommand.js +17 -17
- package/dist/es/commands/SignCommand.js +12 -13
- package/dist/es/commands/SignCommand.js.map +1 -1
- package/dist/es/commands/TagResourceCommand.js +10 -12
- package/dist/es/commands/TagResourceCommand.js.map +1 -1
- package/dist/es/commands/UntagResourceCommand.js +9 -10
- package/dist/es/commands/UntagResourceCommand.js.map +1 -1
- package/dist/es/commands/UpdateAliasCommand.js +15 -15
- package/dist/es/commands/UpdateCustomKeyStoreCommand.js +9 -9
- package/dist/es/commands/UpdateKeyDescriptionCommand.js +4 -4
- package/dist/es/commands/UpdatePrimaryRegionCommand.js +13 -13
- package/dist/es/commands/VerifyCommand.js +14 -14
- package/dist/es/endpoints.js +1 -2
- package/dist/es/endpoints.js.map +1 -1
- package/dist/es/models/models_0.js +11 -0
- package/dist/es/models/models_0.js.map +1 -1
- package/dist/es/package.json +31 -31
- package/dist/es/protocols/Aws_json1_1.js +18 -14
- package/dist/es/protocols/Aws_json1_1.js.map +1 -1
- package/dist/types/KMS.d.ts +567 -572
- package/dist/types/KMSClient.d.ts +18 -18
- package/dist/types/commands/CancelKeyDeletionCommand.d.ts +6 -7
- package/dist/types/commands/ConnectCustomKeyStoreCommand.d.ts +9 -9
- package/dist/types/commands/CreateAliasCommand.d.ts +13 -14
- package/dist/types/commands/CreateCustomKeyStoreCommand.d.ts +8 -8
- package/dist/types/commands/CreateGrantCommand.d.ts +15 -22
- package/dist/types/commands/CreateKeyCommand.d.ts +44 -44
- package/dist/types/commands/DecryptCommand.d.ts +23 -22
- package/dist/types/commands/DeleteAliasCommand.d.ts +7 -8
- package/dist/types/commands/DeleteCustomKeyStoreCommand.d.ts +13 -13
- package/dist/types/commands/DeleteImportedKeyMaterialCommand.d.ts +9 -9
- package/dist/types/commands/DescribeCustomKeyStoresCommand.d.ts +6 -6
- package/dist/types/commands/DescribeKeyCommand.d.ts +18 -19
- package/dist/types/commands/DisableKeyCommand.d.ts +7 -7
- package/dist/types/commands/DisableKeyRotationCommand.d.ts +5 -6
- package/dist/types/commands/DisconnectCustomKeyStoreCommand.d.ts +6 -8
- package/dist/types/commands/EnableKeyCommand.d.ts +4 -5
- package/dist/types/commands/EnableKeyRotationCommand.d.ts +5 -5
- package/dist/types/commands/EncryptCommand.d.ts +20 -21
- package/dist/types/commands/GenerateDataKeyCommand.d.ts +17 -18
- package/dist/types/commands/GenerateDataKeyPairCommand.d.ts +21 -15
- package/dist/types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +16 -12
- package/dist/types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +9 -9
- package/dist/types/commands/GenerateRandomCommand.d.ts +4 -3
- package/dist/types/commands/GetKeyPolicyCommand.d.ts +2 -2
- package/dist/types/commands/GetKeyRotationStatusCommand.d.ts +9 -9
- package/dist/types/commands/GetParametersForImportCommand.d.ts +8 -8
- package/dist/types/commands/GetPublicKeyCommand.d.ts +15 -15
- package/dist/types/commands/ImportKeyMaterialCommand.d.ts +18 -18
- package/dist/types/commands/ListAliasesCommand.d.ts +8 -10
- package/dist/types/commands/ListGrantsCommand.d.ts +9 -4
- package/dist/types/commands/ListKeyPoliciesCommand.d.ts +2 -2
- package/dist/types/commands/ListKeysCommand.d.ts +2 -2
- package/dist/types/commands/ListResourceTagsCommand.d.ts +4 -4
- package/dist/types/commands/ListRetirableGrantsCommand.d.ts +14 -14
- package/dist/types/commands/PutKeyPolicyCommand.d.ts +5 -5
- package/dist/types/commands/ReEncryptCommand.d.ts +30 -34
- package/dist/types/commands/ReplicateKeyCommand.d.ts +16 -16
- package/dist/types/commands/RetireGrantCommand.d.ts +9 -9
- package/dist/types/commands/RevokeGrantCommand.d.ts +9 -4
- package/dist/types/commands/ScheduleKeyDeletionCommand.d.ts +17 -17
- package/dist/types/commands/SignCommand.d.ts +12 -13
- package/dist/types/commands/TagResourceCommand.d.ts +10 -12
- package/dist/types/commands/UntagResourceCommand.d.ts +9 -10
- package/dist/types/commands/UpdateAliasCommand.d.ts +15 -15
- package/dist/types/commands/UpdateCustomKeyStoreCommand.d.ts +9 -9
- package/dist/types/commands/UpdateKeyDescriptionCommand.d.ts +4 -4
- package/dist/types/commands/UpdatePrimaryRegionCommand.d.ts +13 -13
- package/dist/types/commands/VerifyCommand.d.ts +14 -14
- package/dist/types/models/models_0.d.ts +584 -570
- package/dist/types/ts3.4/KMS.d.ts +567 -572
- package/dist/types/ts3.4/KMSClient.d.ts +18 -18
- package/dist/types/ts3.4/commands/CancelKeyDeletionCommand.d.ts +6 -7
- package/dist/types/ts3.4/commands/ConnectCustomKeyStoreCommand.d.ts +9 -9
- package/dist/types/ts3.4/commands/CreateAliasCommand.d.ts +13 -14
- package/dist/types/ts3.4/commands/CreateCustomKeyStoreCommand.d.ts +8 -8
- package/dist/types/ts3.4/commands/CreateGrantCommand.d.ts +15 -22
- package/dist/types/ts3.4/commands/CreateKeyCommand.d.ts +44 -44
- package/dist/types/ts3.4/commands/DecryptCommand.d.ts +23 -22
- package/dist/types/ts3.4/commands/DeleteAliasCommand.d.ts +7 -8
- package/dist/types/ts3.4/commands/DeleteCustomKeyStoreCommand.d.ts +13 -13
- package/dist/types/ts3.4/commands/DeleteImportedKeyMaterialCommand.d.ts +9 -9
- package/dist/types/ts3.4/commands/DescribeCustomKeyStoresCommand.d.ts +6 -6
- package/dist/types/ts3.4/commands/DescribeKeyCommand.d.ts +18 -19
- package/dist/types/ts3.4/commands/DisableKeyCommand.d.ts +7 -7
- package/dist/types/ts3.4/commands/DisableKeyRotationCommand.d.ts +5 -6
- package/dist/types/ts3.4/commands/DisconnectCustomKeyStoreCommand.d.ts +6 -8
- package/dist/types/ts3.4/commands/EnableKeyCommand.d.ts +4 -5
- package/dist/types/ts3.4/commands/EnableKeyRotationCommand.d.ts +5 -5
- package/dist/types/ts3.4/commands/EncryptCommand.d.ts +20 -21
- package/dist/types/ts3.4/commands/GenerateDataKeyCommand.d.ts +17 -18
- package/dist/types/ts3.4/commands/GenerateDataKeyPairCommand.d.ts +21 -15
- package/dist/types/ts3.4/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +16 -12
- package/dist/types/ts3.4/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +9 -9
- package/dist/types/ts3.4/commands/GenerateRandomCommand.d.ts +4 -3
- package/dist/types/ts3.4/commands/GetKeyPolicyCommand.d.ts +2 -2
- package/dist/types/ts3.4/commands/GetKeyRotationStatusCommand.d.ts +9 -9
- package/dist/types/ts3.4/commands/GetParametersForImportCommand.d.ts +8 -8
- package/dist/types/ts3.4/commands/GetPublicKeyCommand.d.ts +15 -15
- package/dist/types/ts3.4/commands/ImportKeyMaterialCommand.d.ts +18 -18
- package/dist/types/ts3.4/commands/ListAliasesCommand.d.ts +8 -10
- package/dist/types/ts3.4/commands/ListGrantsCommand.d.ts +9 -4
- package/dist/types/ts3.4/commands/ListKeyPoliciesCommand.d.ts +2 -2
- package/dist/types/ts3.4/commands/ListKeysCommand.d.ts +2 -2
- package/dist/types/ts3.4/commands/ListResourceTagsCommand.d.ts +4 -4
- package/dist/types/ts3.4/commands/ListRetirableGrantsCommand.d.ts +14 -14
- package/dist/types/ts3.4/commands/PutKeyPolicyCommand.d.ts +5 -5
- package/dist/types/ts3.4/commands/ReEncryptCommand.d.ts +30 -34
- package/dist/types/ts3.4/commands/ReplicateKeyCommand.d.ts +16 -16
- package/dist/types/ts3.4/commands/RetireGrantCommand.d.ts +9 -9
- package/dist/types/ts3.4/commands/RevokeGrantCommand.d.ts +9 -4
- package/dist/types/ts3.4/commands/ScheduleKeyDeletionCommand.d.ts +17 -17
- package/dist/types/ts3.4/commands/SignCommand.d.ts +12 -13
- package/dist/types/ts3.4/commands/TagResourceCommand.d.ts +10 -12
- package/dist/types/ts3.4/commands/UntagResourceCommand.d.ts +9 -10
- package/dist/types/ts3.4/commands/UpdateAliasCommand.d.ts +15 -15
- package/dist/types/ts3.4/commands/UpdateCustomKeyStoreCommand.d.ts +9 -9
- package/dist/types/ts3.4/commands/UpdateKeyDescriptionCommand.d.ts +4 -4
- package/dist/types/ts3.4/commands/UpdatePrimaryRegionCommand.d.ts +13 -13
- package/dist/types/ts3.4/commands/VerifyCommand.d.ts +14 -14
- package/dist/types/ts3.4/models/models_0.d.ts +584 -570
- package/models/models_0.ts +588 -570
- package/package.json +31 -31
- package/protocols/Aws_json1_1.ts +20 -12
|
@@ -6,24 +6,24 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
|
6
6
|
/**
|
|
7
7
|
* <p>Deletes a grant. Typically, you retire a grant when you no longer need its permissions. To
|
|
8
8
|
* identify the grant to retire, use a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">grant token</a>, or both the grant ID and a
|
|
9
|
-
* key identifier (key ID or key ARN) of the
|
|
9
|
+
* key identifier (key ID or key ARN) of the KMS key. The <a>CreateGrant</a> operation returns both values.</p>
|
|
10
10
|
* <p>This operation can be called by the <i>retiring principal</i> for a grant,
|
|
11
11
|
* by the <i>grantee principal</i> if the grant allows the <code>RetireGrant</code>
|
|
12
|
-
* operation, and by the
|
|
12
|
+
* operation, and by the Amazon Web Services account (root user) in which the grant is created. It can also be
|
|
13
13
|
* called by principals to whom permission for retiring a grant is delegated. For details, see
|
|
14
|
-
*
|
|
15
|
-
* revoking grants</a> in the <i>
|
|
14
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete">Retiring and
|
|
15
|
+
* revoking grants</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
16
16
|
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Using grants</a> in the
|
|
17
17
|
* <i>
|
|
18
|
-
* <i>
|
|
18
|
+
* <i>Key Management Service Developer Guide</i>
|
|
19
19
|
* </i>. For examples of working with grants in several
|
|
20
|
-
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a
|
|
20
|
+
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>. </p>
|
|
21
21
|
* <p>
|
|
22
|
-
* <b>Cross-account use</b>: Yes. You can retire a grant on a
|
|
23
|
-
* in a different
|
|
22
|
+
* <b>Cross-account use</b>: Yes. You can retire a grant on a KMS key
|
|
23
|
+
* in a different Amazon Web Services account.</p>
|
|
24
24
|
* <p>
|
|
25
25
|
* <b>Required permissions:</b>:Permission to retire a grant is
|
|
26
|
-
* determined primarily by the grant. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete">Retiring and revoking grants</a> in the <i>
|
|
26
|
+
* determined primarily by the grant. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete">Retiring and revoking grants</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
27
27
|
* <p>
|
|
28
28
|
* <b>Related operations:</b>
|
|
29
29
|
* </p>
|
|
@@ -8,14 +8,19 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
|
8
8
|
* grant allows. For more
|
|
9
9
|
* information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/managing-grants.html#grant-delete">Retiring and revoking grants</a> in
|
|
10
10
|
* the <i>
|
|
11
|
-
* <i>
|
|
11
|
+
* <i>Key Management Service Developer Guide</i>
|
|
12
12
|
* </i>.</p>
|
|
13
|
-
* <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
|
|
13
|
+
* <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>. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-eventual-consistency">Eventual consistency</a> in
|
|
14
14
|
* the <i>
|
|
15
|
-
* <i>
|
|
15
|
+
* <i>Key Management Service Developer Guide</i>
|
|
16
16
|
* </i>. </p>
|
|
17
|
+
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Using grants</a> in the
|
|
18
|
+
* <i>
|
|
19
|
+
* <i>Key Management Service Developer Guide</i>
|
|
20
|
+
* </i>. For examples of working with grants in several
|
|
21
|
+
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>. </p>
|
|
17
22
|
* <p>
|
|
18
|
-
* <b>Cross-account use</b>: Yes. To perform this operation on a
|
|
23
|
+
* <b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key
|
|
19
24
|
* ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
20
25
|
* <p>
|
|
21
26
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:RevokeGrant</a> (key policy).</p>
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RevokeGrantCommand.js","sourceRoot":"","sources":["../../../commands/RevokeGrantCommand.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EACL,wCAAwC,EACxC,sCAAsC,GACvC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAc7D
|
|
1
|
+
{"version":3,"file":"RevokeGrantCommand.js","sourceRoot":"","sources":["../../../commands/RevokeGrantCommand.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EACL,wCAAwC,EACxC,sCAAsC,GACvC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAc7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AACH;IAAwC,sCAIvC;IACC,oCAAoC;IACpC,kCAAkC;IAElC,4BAAqB,KAA8B;QAAnD;QACE,qCAAqC;QACrC,iBAAO,SAER;QAJoB,WAAK,GAAL,KAAK,CAAyB;;QAGjD,mCAAmC;IACrC,CAAC;IAED;;OAEG;IACH,8CAAiB,GAAjB,UACE,WAAmE,EACnE,aAAsC,EACtC,OAA8B;QAE9B,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,cAAc,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAE1F,IAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAE/C,IAAA,MAAM,GAAK,aAAa,OAAlB,CAAmB;QACjC,IAAM,UAAU,GAAG,WAAW,CAAC;QAC/B,IAAM,WAAW,GAAG,oBAAoB,CAAC;QACzC,IAAM,uBAAuB,GAA4B;YACvD,MAAM,QAAA;YACN,UAAU,YAAA;YACV,WAAW,aAAA;YACX,uBAAuB,EAAE,kBAAkB,CAAC,kBAAkB;YAC9D,wBAAwB,EAAE,UAAC,MAAW,IAAK,OAAA,MAAM,EAAN,CAAM;SAClD,CAAC;QACM,IAAA,cAAc,GAAK,aAAa,eAAlB,CAAmB;QACzC,OAAO,KAAK,CAAC,OAAO,CAClB,UAAC,OAAsC;YACrC,OAAA,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,OAAwB,EAAE,OAAO,IAAI,EAAE,CAAC;QAAtE,CAAsE,EACxE,uBAAuB,CACxB,CAAC;IACJ,CAAC;IAEO,sCAAS,GAAjB,UAAkB,KAA8B,EAAE,OAAuB;QACvE,OAAO,sCAAsC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAEO,wCAAW,GAAnB,UAAoB,MAAsB,EAAE,OAAuB;QACjE,OAAO,wCAAwC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAIH,yBAAC;AAAD,CAAC,AAtDD,CAAwC,QAAQ,GAsD/C"}
|
|
@@ -4,38 +4,38 @@ import { deserializeAws_json1_1ScheduleKeyDeletionCommand, serializeAws_json1_1S
|
|
|
4
4
|
import { getSerdePlugin } from "@aws-sdk/middleware-serde";
|
|
5
5
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
6
6
|
/**
|
|
7
|
-
* <p>Schedules the deletion of a
|
|
7
|
+
* <p>Schedules the deletion of a KMS key. By default, KMS applies a waiting
|
|
8
8
|
* period of 30 days, but you can specify a waiting period of 7-30 days. When this operation is
|
|
9
|
-
* successful, the key state of the
|
|
9
|
+
* successful, the key state of the KMS key changes to <code>PendingDeletion</code> and the key can't
|
|
10
10
|
* be used in any cryptographic operations. It remains in this state for the duration of the
|
|
11
|
-
* waiting period. Before the waiting period ends, you can use <a>CancelKeyDeletion</a> to cancel the deletion of the
|
|
12
|
-
* its key material, and all
|
|
11
|
+
* waiting period. Before the waiting period ends, you can use <a>CancelKeyDeletion</a> to cancel the deletion of the KMS key. After the waiting period ends, KMS deletes the KMS key,
|
|
12
|
+
* its key material, and all KMS data associated with it, including all aliases that refer to
|
|
13
13
|
* it.</p>
|
|
14
14
|
* <important>
|
|
15
|
-
* <p>Deleting a
|
|
16
|
-
* deleted, all data that was encrypted under the
|
|
17
|
-
* a multi-Region replica key.) To prevent the use of a
|
|
15
|
+
* <p>Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key is
|
|
16
|
+
* deleted, all data that was encrypted under the KMS key is unrecoverable. (The only exception is
|
|
17
|
+
* a multi-Region replica key.) To prevent the use of a KMS key without deleting it, use <a>DisableKey</a>. </p>
|
|
18
18
|
* </important>
|
|
19
|
-
* <p>If you schedule deletion of a
|
|
20
|
-
* expires, <code>ScheduleKeyDeletion</code> deletes the
|
|
21
|
-
* effort to delete the key material from the associated
|
|
19
|
+
* <p>If you schedule deletion of a KMS key from a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, when the waiting period
|
|
20
|
+
* expires, <code>ScheduleKeyDeletion</code> deletes the KMS key from KMS. Then KMS makes a best
|
|
21
|
+
* effort to delete the key material from the associated CloudHSM cluster. However, you might need
|
|
22
22
|
* to manually <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key">delete the orphaned key
|
|
23
23
|
* material</a> from the cluster and its backups.</p>
|
|
24
24
|
* <p>You can schedule the deletion of a multi-Region primary key and its replica keys at any
|
|
25
|
-
* time. However,
|
|
25
|
+
* time. However, KMS will not delete a multi-Region primary key with existing replica keys. If
|
|
26
26
|
* you schedule the deletion of a primary key with replicas, its key state changes to
|
|
27
27
|
* <code>PendingReplicaDeletion</code> and it cannot be replicated or used in cryptographic
|
|
28
28
|
* operations. This status can continue indefinitely. When the last of its replicas keys is
|
|
29
29
|
* deleted (not just scheduled), the key state of the primary key changes to
|
|
30
30
|
* <code>PendingDeletion</code> and its waiting period (<code>PendingWindowInDays</code>)
|
|
31
|
-
* begins. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html">Deleting multi-Region keys</a> in the <i>
|
|
32
|
-
* <p>For more information about scheduling a
|
|
33
|
-
* <i>
|
|
34
|
-
* <p>The
|
|
35
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
31
|
+
* begins. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html">Deleting multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>. </p>
|
|
32
|
+
* <p>For more information about scheduling a KMS key for deletion, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting KMS keys</a> in the
|
|
33
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
34
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
35
|
+
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
36
36
|
*
|
|
37
37
|
* <p>
|
|
38
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
38
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
39
39
|
*
|
|
40
40
|
*
|
|
41
41
|
* <p>
|
|
@@ -5,21 +5,20 @@ import { getSerdePlugin } from "@aws-sdk/middleware-serde";
|
|
|
5
5
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
6
6
|
/**
|
|
7
7
|
* <p>Creates a <a href="https://en.wikipedia.org/wiki/Digital_signature">digital
|
|
8
|
-
* signature</a> for a message or message digest by using the private key in an asymmetric
|
|
9
|
-
*
|
|
10
|
-
* key in the same asymmetric CMK outside of AWS KMS. For information about symmetric and asymmetric CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric CMKs</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
8
|
+
* signature</a> for a message or message digest by using the private key in an asymmetric KMS key. To verify the signature, use the <a>Verify</a> operation, or use the public
|
|
9
|
+
* key in the same asymmetric KMS key outside of KMS. For information about symmetric and asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
11
10
|
* <p>Digital signatures are generated and verified by using asymmetric key pair, such as an RSA
|
|
12
|
-
* or ECC pair that is represented by an asymmetric
|
|
11
|
+
* or ECC pair that is represented by an asymmetric KMS key. The key owner (or
|
|
13
12
|
* an authorized user) uses their private key to sign a message. Anyone with the public key can
|
|
14
13
|
* verify that the message was signed with that particular private key and that the message
|
|
15
14
|
* hasn't changed since it was signed. </p>
|
|
16
15
|
* <p>To use the <code>Sign</code> operation, provide the following information:</p>
|
|
17
16
|
* <ul>
|
|
18
17
|
* <li>
|
|
19
|
-
* <p>Use the <code>KeyId</code> parameter to identify an asymmetric
|
|
18
|
+
* <p>Use the <code>KeyId</code> parameter to identify an asymmetric KMS key with a
|
|
20
19
|
* <code>KeyUsage</code> value of <code>SIGN_VERIFY</code>. To get the
|
|
21
|
-
* <code>KeyUsage</code> value of a
|
|
22
|
-
* The caller must have <code>kms:Sign</code> permission on the
|
|
20
|
+
* <code>KeyUsage</code> value of a KMS key, use the <a>DescribeKey</a> operation.
|
|
21
|
+
* The caller must have <code>kms:Sign</code> permission on the KMS key.</p>
|
|
23
22
|
* </li>
|
|
24
23
|
* <li>
|
|
25
24
|
* <p>Use the <code>Message</code> parameter to specify the message or message digest to
|
|
@@ -29,20 +28,20 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
|
29
28
|
* <code>MessageType</code> parameter.</p>
|
|
30
29
|
* </li>
|
|
31
30
|
* <li>
|
|
32
|
-
* <p>Choose a signing algorithm that is compatible with the
|
|
31
|
+
* <p>Choose a signing algorithm that is compatible with the KMS key. </p>
|
|
33
32
|
* </li>
|
|
34
33
|
* </ul>
|
|
35
34
|
* <important>
|
|
36
|
-
* <p>When signing a message, be sure to record the
|
|
35
|
+
* <p>When signing a message, be sure to record the KMS key and the signing algorithm. This
|
|
37
36
|
* information is required to verify the signature.</p>
|
|
38
37
|
* </important>
|
|
39
38
|
* <p>To verify the signature that this operation generates, use the <a>Verify</a>
|
|
40
39
|
* operation. Or use the <a>GetPublicKey</a> operation to download the public key and
|
|
41
|
-
* then use the public key to verify the signature outside of
|
|
42
|
-
* <p>The
|
|
43
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
40
|
+
* then use the public key to verify the signature outside of KMS. </p>
|
|
41
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
42
|
+
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
44
43
|
* <p>
|
|
45
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
44
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
46
45
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
47
46
|
*
|
|
48
47
|
* <p>
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SignCommand.js","sourceRoot":"","sources":["../../../commands/SignCommand.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAAE,iCAAiC,EAAE,+BAA+B,EAAE,MAAM,0BAA0B,CAAC;AAC9G,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAc7D
|
|
1
|
+
{"version":3,"file":"SignCommand.js","sourceRoot":"","sources":["../../../commands/SignCommand.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAAE,iCAAiC,EAAE,+BAA+B,EAAE,MAAM,0BAA0B,CAAC;AAC9G,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAc7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AACH;IAAiC,+BAAsE;IACrG,oCAAoC;IACpC,kCAAkC;IAElC,qBAAqB,KAAuB;QAA5C;QACE,qCAAqC;QACrC,iBAAO,SAER;QAJoB,WAAK,GAAL,KAAK,CAAkB;;QAG1C,mCAAmC;IACrC,CAAC;IAED;;OAEG;IACH,uCAAiB,GAAjB,UACE,WAAmE,EACnE,aAAsC,EACtC,OAA8B;QAE9B,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,cAAc,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAE1F,IAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAE/C,IAAA,MAAM,GAAK,aAAa,OAAlB,CAAmB;QACjC,IAAM,UAAU,GAAG,WAAW,CAAC;QAC/B,IAAM,WAAW,GAAG,aAAa,CAAC;QAClC,IAAM,uBAAuB,GAA4B;YACvD,MAAM,QAAA;YACN,UAAU,YAAA;YACV,WAAW,aAAA;YACX,uBAAuB,EAAE,WAAW,CAAC,kBAAkB;YACvD,wBAAwB,EAAE,YAAY,CAAC,kBAAkB;SAC1D,CAAC;QACM,IAAA,cAAc,GAAK,aAAa,eAAlB,CAAmB;QACzC,OAAO,KAAK,CAAC,OAAO,CAClB,UAAC,OAAsC;YACrC,OAAA,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,OAAwB,EAAE,OAAO,IAAI,EAAE,CAAC;QAAtE,CAAsE,EACxE,uBAAuB,CACxB,CAAC;IACJ,CAAC;IAEO,+BAAS,GAAjB,UAAkB,KAAuB,EAAE,OAAuB;QAChE,OAAO,+BAA+B,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAEO,iCAAW,GAAnB,UAAoB,MAAsB,EAAE,OAAuB;QACjE,OAAO,iCAAiC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAIH,kBAAC;AAAD,CAAC,AAlDD,CAAiC,QAAQ,GAkDxC"}
|
|
@@ -4,26 +4,24 @@ import { deserializeAws_json1_1TagResourceCommand, serializeAws_json1_1TagResour
|
|
|
4
4
|
import { getSerdePlugin } from "@aws-sdk/middleware-serde";
|
|
5
5
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
6
6
|
/**
|
|
7
|
-
* <p>Adds or edits tags on a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
|
|
7
|
+
* <p>Adds or edits tags on a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>.</p>
|
|
8
8
|
* <note>
|
|
9
|
-
* <p>Tagging or untagging a
|
|
10
|
-
* CMK. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">Using ABAC in AWS KMS</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
9
|
+
* <p>Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">Using ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
11
10
|
* </note>
|
|
12
11
|
* <p>Each tag consists of a tag key and a tag value, both of which are case-sensitive strings.
|
|
13
12
|
* The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag
|
|
14
13
|
* value. To edit a tag, specify an existing tag key and a new tag value.</p>
|
|
15
|
-
* <p>You can use this operation to tag a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
|
|
16
|
-
* tag an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">
|
|
17
|
-
* managed CMK</a>, an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk">AWS owned CMK</a>, a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#keystore-concept">custom key store</a>, or
|
|
14
|
+
* <p>You can use this operation to tag a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>, but you cannot
|
|
15
|
+
* tag an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a>, an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk">Amazon Web Services owned key</a>, a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#keystore-concept">custom key store</a>, or
|
|
18
16
|
* an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#alias-concept">alias</a>.</p>
|
|
19
|
-
* <p>You can also add tags to a
|
|
20
|
-
* <p>For information about using tags in
|
|
21
|
-
* tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging
|
|
17
|
+
* <p>You can also add tags to a KMS key while creating it (<a>CreateKey</a>) or replicating it (<a>ReplicateKey</a>).</p>
|
|
18
|
+
* <p>For information about using tags in KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tagging keys</a>. For general information about
|
|
19
|
+
* tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon
|
|
22
20
|
* Web Services General Reference</i>. </p>
|
|
23
|
-
* <p>The
|
|
24
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
21
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
22
|
+
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
25
23
|
* <p>
|
|
26
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
24
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
|
|
27
25
|
*
|
|
28
26
|
* <p>
|
|
29
27
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:TagResource</a> (key policy)</p>
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TagResourceCommand.js","sourceRoot":"","sources":["../../../commands/TagResourceCommand.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EACL,wCAAwC,EACxC,sCAAsC,GACvC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAc7D
|
|
1
|
+
{"version":3,"file":"TagResourceCommand.js","sourceRoot":"","sources":["../../../commands/TagResourceCommand.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EACL,wCAAwC,EACxC,sCAAsC,GACvC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAc7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG;AACH;IAAwC,sCAIvC;IACC,oCAAoC;IACpC,kCAAkC;IAElC,4BAAqB,KAA8B;QAAnD;QACE,qCAAqC;QACrC,iBAAO,SAER;QAJoB,WAAK,GAAL,KAAK,CAAyB;;QAGjD,mCAAmC;IACrC,CAAC;IAED;;OAEG;IACH,8CAAiB,GAAjB,UACE,WAAmE,EACnE,aAAsC,EACtC,OAA8B;QAE9B,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,cAAc,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAE1F,IAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAE/C,IAAA,MAAM,GAAK,aAAa,OAAlB,CAAmB;QACjC,IAAM,UAAU,GAAG,WAAW,CAAC;QAC/B,IAAM,WAAW,GAAG,oBAAoB,CAAC;QACzC,IAAM,uBAAuB,GAA4B;YACvD,MAAM,QAAA;YACN,UAAU,YAAA;YACV,WAAW,aAAA;YACX,uBAAuB,EAAE,kBAAkB,CAAC,kBAAkB;YAC9D,wBAAwB,EAAE,UAAC,MAAW,IAAK,OAAA,MAAM,EAAN,CAAM;SAClD,CAAC;QACM,IAAA,cAAc,GAAK,aAAa,eAAlB,CAAmB;QACzC,OAAO,KAAK,CAAC,OAAO,CAClB,UAAC,OAAsC;YACrC,OAAA,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,OAAwB,EAAE,OAAO,IAAI,EAAE,CAAC;QAAtE,CAAsE,EACxE,uBAAuB,CACxB,CAAC;IACJ,CAAC;IAEO,sCAAS,GAAjB,UAAkB,KAA8B,EAAE,OAAuB;QACvE,OAAO,sCAAsC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAEO,wCAAW,GAAnB,UAAoB,MAAsB,EAAE,OAAuB;QACjE,OAAO,wCAAwC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAIH,yBAAC;AAAD,CAAC,AAtDD,CAAwC,QAAQ,GAsD/C"}
|
|
@@ -4,23 +4,22 @@ import { deserializeAws_json1_1UntagResourceCommand, serializeAws_json1_1UntagRe
|
|
|
4
4
|
import { getSerdePlugin } from "@aws-sdk/middleware-serde";
|
|
5
5
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
6
6
|
/**
|
|
7
|
-
* <p>Deletes tags from a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
|
|
8
|
-
* specify the tag key and the
|
|
7
|
+
* <p>Deletes tags from a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>. To delete a tag,
|
|
8
|
+
* specify the tag key and the KMS key.</p>
|
|
9
9
|
* <note>
|
|
10
|
-
* <p>Tagging or untagging a
|
|
11
|
-
* CMK. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">Using ABAC in AWS KMS</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
10
|
+
* <p>Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">Using ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
12
11
|
* </note>
|
|
13
12
|
* <p>When it succeeds, the <code>UntagResource</code> operation doesn't return any output.
|
|
14
|
-
* Also, if the specified tag key isn't found on the
|
|
13
|
+
* Also, if the specified tag key isn't found on the KMS key, it doesn't throw an exception or return
|
|
15
14
|
* a response. To confirm that the operation worked, use the <a>ListResourceTags</a> operation.</p>
|
|
16
15
|
*
|
|
17
|
-
* <p>For information about using tags in
|
|
18
|
-
* tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging
|
|
16
|
+
* <p>For information about using tags in KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tagging keys</a>. For general information about
|
|
17
|
+
* tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon
|
|
19
18
|
* Web Services General Reference</i>. </p>
|
|
20
|
-
* <p>The
|
|
21
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
19
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
20
|
+
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
22
21
|
* <p>
|
|
23
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
22
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
24
23
|
*
|
|
25
24
|
* <p>
|
|
26
25
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UntagResource</a> (key policy)</p>
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"UntagResourceCommand.js","sourceRoot":"","sources":["../../../commands/UntagResourceCommand.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EACL,0CAA0C,EAC1C,wCAAwC,GACzC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAc7D
|
|
1
|
+
{"version":3,"file":"UntagResourceCommand.js","sourceRoot":"","sources":["../../../commands/UntagResourceCommand.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EACL,0CAA0C,EAC1C,wCAAwC,GACzC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAc7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2DG;AACH;IAA0C,wCAIzC;IACC,oCAAoC;IACpC,kCAAkC;IAElC,8BAAqB,KAAgC;QAArD;QACE,qCAAqC;QACrC,iBAAO,SAER;QAJoB,WAAK,GAAL,KAAK,CAA2B;;QAGnD,mCAAmC;IACrC,CAAC;IAED;;OAEG;IACH,gDAAiB,GAAjB,UACE,WAAmE,EACnE,aAAsC,EACtC,OAA8B;QAE9B,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,cAAc,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAE1F,IAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAE/C,IAAA,MAAM,GAAK,aAAa,OAAlB,CAAmB;QACjC,IAAM,UAAU,GAAG,WAAW,CAAC;QAC/B,IAAM,WAAW,GAAG,sBAAsB,CAAC;QAC3C,IAAM,uBAAuB,GAA4B;YACvD,MAAM,QAAA;YACN,UAAU,YAAA;YACV,WAAW,aAAA;YACX,uBAAuB,EAAE,oBAAoB,CAAC,kBAAkB;YAChE,wBAAwB,EAAE,UAAC,MAAW,IAAK,OAAA,MAAM,EAAN,CAAM;SAClD,CAAC;QACM,IAAA,cAAc,GAAK,aAAa,eAAlB,CAAmB;QACzC,OAAO,KAAK,CAAC,OAAO,CAClB,UAAC,OAAsC;YACrC,OAAA,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,OAAwB,EAAE,OAAO,IAAI,EAAE,CAAC;QAAtE,CAAsE,EACxE,uBAAuB,CACxB,CAAC;IACJ,CAAC;IAEO,wCAAS,GAAjB,UAAkB,KAAgC,EAAE,OAAuB;QACzE,OAAO,wCAAwC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAEO,0CAAW,GAAnB,UAAoB,MAAsB,EAAE,OAAuB;QACjE,OAAO,0CAA0C,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAIH,2BAAC;AAAD,CAAC,AAtDD,CAA0C,QAAQ,GAsDjD"}
|
|
@@ -4,27 +4,27 @@ import { deserializeAws_json1_1UpdateAliasCommand, serializeAws_json1_1UpdateAli
|
|
|
4
4
|
import { getSerdePlugin } from "@aws-sdk/middleware-serde";
|
|
5
5
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
6
6
|
/**
|
|
7
|
-
* <p>Associates an existing
|
|
8
|
-
* is associated with only one
|
|
9
|
-
* and the
|
|
7
|
+
* <p>Associates an existing KMS alias with a different KMS key. Each alias
|
|
8
|
+
* is associated with only one KMS key at a time, although a KMS key can have multiple aliases. The alias
|
|
9
|
+
* and the KMS key must be in the same Amazon Web Services account and Region.</p>
|
|
10
10
|
* <note>
|
|
11
|
-
* <p>Adding, deleting, or updating an alias can allow or deny permission to the
|
|
11
|
+
* <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">Using ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
12
12
|
* </note>
|
|
13
|
-
* <p>The current and new
|
|
13
|
+
* <p>The current and new KMS key must be the same type (both symmetric or both asymmetric), and
|
|
14
14
|
* they must have the same key usage (<code>ENCRYPT_DECRYPT</code> or <code>SIGN_VERIFY</code>).
|
|
15
15
|
* This restriction prevents errors in code that uses aliases. If you must assign an alias to a
|
|
16
|
-
* different type of
|
|
16
|
+
* different type of KMS key, use <a>DeleteAlias</a> to delete the old alias and <a>CreateAlias</a> to create a new alias.</p>
|
|
17
17
|
* <p>You cannot use <code>UpdateAlias</code> to change an alias name. To change an alias name,
|
|
18
18
|
* use <a>DeleteAlias</a> to delete the old alias and <a>CreateAlias</a> to
|
|
19
19
|
* create a new alias.</p>
|
|
20
|
-
* <p>Because an alias is not a property of a
|
|
21
|
-
* aliases of a
|
|
22
|
-
* the <a>DescribeKey</a> operation. To get the aliases of all
|
|
20
|
+
* <p>Because an alias is not a property of a KMS key, you can create, update, and delete the
|
|
21
|
+
* aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the response from
|
|
22
|
+
* the <a>DescribeKey</a> operation. To get the aliases of all KMS keys in the account,
|
|
23
23
|
* use the <a>ListAliases</a> operation. </p>
|
|
24
|
-
* <p>The
|
|
25
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
24
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
25
|
+
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
26
26
|
* <p>
|
|
27
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
27
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
|
|
28
28
|
* <p>
|
|
29
29
|
* <b>Required permissions</b>
|
|
30
30
|
* </p>
|
|
@@ -35,14 +35,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
|
35
35
|
* </li>
|
|
36
36
|
* <li>
|
|
37
37
|
* <p>
|
|
38
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateAlias</a> on the current
|
|
38
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateAlias</a> on the current KMS key (key policy).</p>
|
|
39
39
|
* </li>
|
|
40
40
|
* <li>
|
|
41
41
|
* <p>
|
|
42
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateAlias</a> on the new
|
|
42
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateAlias</a> on the new KMS key (key policy).</p>
|
|
43
43
|
* </li>
|
|
44
44
|
* </ul>
|
|
45
|
-
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access">Controlling access to aliases</a> in the <i>
|
|
45
|
+
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access">Controlling access to aliases</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
46
46
|
* <p>
|
|
47
47
|
* <b>Related operations:</b>
|
|
48
48
|
* </p>
|
|
@@ -21,30 +21,30 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
|
21
21
|
* <p> </p>
|
|
22
22
|
* </li>
|
|
23
23
|
* <li>
|
|
24
|
-
* <p>Use the <b>KeyStorePassword</b> parameter tell
|
|
24
|
+
* <p>Use the <b>KeyStorePassword</b> parameter tell KMS the
|
|
25
25
|
* current password of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser">
|
|
26
26
|
* <code>kmsuser</code> crypto
|
|
27
|
-
* user (CU)</a> in the associated
|
|
28
|
-
* connection failures</a> that occur when
|
|
27
|
+
* user (CU)</a> in the associated CloudHSM cluster. You can use this parameter to <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-password">fix
|
|
28
|
+
* connection failures</a> that occur when KMS cannot log into the associated cluster
|
|
29
29
|
* because the <code>kmsuser</code> password has changed. This value does not change the
|
|
30
|
-
* password in the
|
|
30
|
+
* password in the CloudHSM cluster.</p>
|
|
31
31
|
* <p> </p>
|
|
32
32
|
* </li>
|
|
33
33
|
* <li>
|
|
34
34
|
* <p>Use the <b>CloudHsmClusterId</b> parameter to associate the
|
|
35
|
-
* custom key store with a different, but related,
|
|
36
|
-
* to repair a custom key store if its
|
|
35
|
+
* custom key store with a different, but related, CloudHSM cluster. You can use this parameter
|
|
36
|
+
* to repair a custom key store if its CloudHSM cluster becomes corrupted or is deleted, or when
|
|
37
37
|
* you need to create or restore a cluster from a backup. </p>
|
|
38
38
|
* </li>
|
|
39
39
|
* </ul>
|
|
40
40
|
* <p>If the operation succeeds, it returns a JSON object with no
|
|
41
41
|
* properties.</p>
|
|
42
|
-
* <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in
|
|
43
|
-
* combines the convenience and extensive integration of
|
|
42
|
+
* <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in KMS, which
|
|
43
|
+
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
44
44
|
* single-tenant key store.</p>
|
|
45
45
|
*
|
|
46
46
|
* <p>
|
|
47
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different
|
|
47
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account. </p>
|
|
48
48
|
* <p>
|
|
49
49
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateCustomKeyStore</a> (IAM policy)</p>
|
|
50
50
|
* <p>
|
|
@@ -4,12 +4,12 @@ import { deserializeAws_json1_1UpdateKeyDescriptionCommand, serializeAws_json1_1
|
|
|
4
4
|
import { getSerdePlugin } from "@aws-sdk/middleware-serde";
|
|
5
5
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
6
6
|
/**
|
|
7
|
-
* <p>Updates the description of a
|
|
7
|
+
* <p>Updates the description of a KMS key. To see the description of a KMS key,
|
|
8
8
|
* use <a>DescribeKey</a>. </p>
|
|
9
|
-
* <p>The
|
|
10
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
9
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
10
|
+
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
11
11
|
* <p>
|
|
12
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
12
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
|
|
13
13
|
*
|
|
14
14
|
* <p>
|
|
15
15
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateKeyDescription</a> (key policy)</p>
|
|
@@ -10,19 +10,19 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
|
10
10
|
* in <code>us-east-1</code> and a replica key in <code>eu-west-2</code>. If you run
|
|
11
11
|
* <code>UpdatePrimaryRegion</code> with a <code>PrimaryRegion</code> value of
|
|
12
12
|
* <code>eu-west-2</code>, the primary key is now the key in <code>eu-west-2</code>, and the
|
|
13
|
-
* key in <code>us-east-1</code> becomes a replica key. For details, see </p>
|
|
14
|
-
* <p>This operation supports <i>multi-Region keys</i>, an
|
|
15
|
-
* interoperable
|
|
16
|
-
* material, and other metadata, you can use them to encrypt data in one
|
|
17
|
-
* it in a different
|
|
13
|
+
* key in <code>us-east-1</code> becomes a replica key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-update">Updating the primary Region</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
14
|
+
* <p>This operation supports <i>multi-Region keys</i>, an KMS feature that lets you create multiple
|
|
15
|
+
* interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key
|
|
16
|
+
* material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt
|
|
17
|
+
* it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
18
18
|
* <p>The <i>primary key</i> of a multi-Region key is the source for properties
|
|
19
19
|
* that are always shared by primary and replica keys, including the key material, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id">key ID</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-spec">key spec</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-usage">key usage</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-origin">key material
|
|
20
20
|
* origin</a>, and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic
|
|
21
21
|
* key rotation</a>. It's the only key that can be replicated. You cannot <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html">delete the primary
|
|
22
|
-
*
|
|
22
|
+
* key</a> until all replica keys are deleted.</p>
|
|
23
23
|
* <p>The key ID and primary Region that you specify uniquely identify the replica key that will
|
|
24
24
|
* become the primary key. The primary Region must already have a replica key. This operation
|
|
25
|
-
* does not create a
|
|
25
|
+
* does not create a KMS key in the specified Region. To find the replica keys, use the <a>DescribeKey</a> operation on the primary key or any replica key. To create a replica
|
|
26
26
|
* key, use the <a>ReplicateKey</a> operation.</p>
|
|
27
27
|
* <p>You can run this operation while using the affected multi-Region keys in cryptographic
|
|
28
28
|
* operations. This operation should not delay, interrupt, or cause failures in cryptographic
|
|
@@ -35,24 +35,24 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
|
35
35
|
* cryptographic operations, but you cannot replicate the new primary key or perform certain
|
|
36
36
|
* management operations, such as enabling or disabling these keys. For details about the
|
|
37
37
|
* <code>Updating</code> key state, see <a href="kms/latest/developerguide/key-state.html">Key state:
|
|
38
|
-
* Effect on your
|
|
38
|
+
* Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
39
39
|
* <p>This operation does not return any output. To verify that primary key is changed, use the
|
|
40
40
|
* <a>DescribeKey</a> operation.</p>
|
|
41
41
|
* <p>
|
|
42
42
|
* <b>Cross-account use</b>: No. You cannot use this operation in a
|
|
43
|
-
* different
|
|
43
|
+
* different Amazon Web Services account. </p>
|
|
44
44
|
* <p>
|
|
45
45
|
* <b>Required permissions</b>: </p>
|
|
46
46
|
* <ul>
|
|
47
47
|
* <li>
|
|
48
48
|
* <p>
|
|
49
|
-
* <code>kms:UpdatePrimaryRegion</code> on the current primary
|
|
50
|
-
* Region). Include this permission primary
|
|
49
|
+
* <code>kms:UpdatePrimaryRegion</code> on the current primary key (in the primary key's
|
|
50
|
+
* Region). Include this permission primary key's key policy.</p>
|
|
51
51
|
* </li>
|
|
52
52
|
* <li>
|
|
53
53
|
* <p>
|
|
54
|
-
* <code>kms:UpdatePrimaryRegion</code> on the current replica
|
|
55
|
-
* Region). Include this permission in the replica
|
|
54
|
+
* <code>kms:UpdatePrimaryRegion</code> on the current replica key (in the replica key's
|
|
55
|
+
* Region). Include this permission in the replica key's key policy.</p>
|
|
56
56
|
* </li>
|
|
57
57
|
* </ul>
|
|
58
58
|
* <p>
|
|
@@ -6,28 +6,28 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
|
6
6
|
/**
|
|
7
7
|
* <p>Verifies a digital signature that was generated by the <a>Sign</a> operation. </p>
|
|
8
8
|
* <p></p>
|
|
9
|
-
* <p>Verification confirms that an authorized user signed the message with the specified
|
|
9
|
+
* <p>Verification confirms that an authorized user signed the message with the specified KMS key
|
|
10
10
|
* and signing algorithm, and the message hasn't changed since it was signed. If the signature is
|
|
11
11
|
* verified, the value of the <code>SignatureValid</code> field in the response is
|
|
12
12
|
* <code>True</code>. If the signature verification fails, the <code>Verify</code> operation
|
|
13
13
|
* fails with an <code>KMSInvalidSignatureException</code> exception.</p>
|
|
14
|
-
* <p>A digital signature is generated by using the private key in an asymmetric
|
|
15
|
-
* signature is verified by using the public key in the same asymmetric
|
|
16
|
-
* For information about symmetric and asymmetric
|
|
14
|
+
* <p>A digital signature is generated by using the private key in an asymmetric KMS key. The
|
|
15
|
+
* signature is verified by using the public key in the same asymmetric KMS key.
|
|
16
|
+
* For information about symmetric and asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
17
17
|
* <p>To verify a digital signature, you can use the <code>Verify</code> operation. Specify the
|
|
18
|
-
* same asymmetric
|
|
18
|
+
* same asymmetric KMS key, message, and signing algorithm that were used to produce the
|
|
19
19
|
* signature.</p>
|
|
20
|
-
* <p>You can also verify the digital signature by using the public key of the
|
|
21
|
-
*
|
|
22
|
-
* asymmetric
|
|
23
|
-
* advantage of using the <code>Verify</code> operation is that it is performed within
|
|
20
|
+
* <p>You can also verify the digital signature by using the public key of the KMS key outside of
|
|
21
|
+
* KMS. Use the <a>GetPublicKey</a> operation to download the public key in the
|
|
22
|
+
* asymmetric KMS key and then use the public key to verify the signature outside of KMS. The
|
|
23
|
+
* advantage of using the <code>Verify</code> operation is that it is performed within KMS. As
|
|
24
24
|
* a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged
|
|
25
|
-
* in
|
|
26
|
-
* the
|
|
27
|
-
* <p>The
|
|
28
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
25
|
+
* in CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use
|
|
26
|
+
* the KMS key to verify signatures.</p>
|
|
27
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
28
|
+
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
29
29
|
* <p>
|
|
30
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
30
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
31
31
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter. </p>
|
|
32
32
|
*
|
|
33
33
|
* <p>
|
package/dist/es/endpoints.js
CHANGED
|
@@ -52,8 +52,7 @@ var partitionHash = {
|
|
|
52
52
|
};
|
|
53
53
|
export var defaultRegionInfoProvider = function (region, options) { return __awaiter(void 0, void 0, void 0, function () {
|
|
54
54
|
return __generator(this, function (_a) {
|
|
55
|
-
return [2 /*return*/, getRegionInfo(region, __assign(__assign({}, options), { signingService: "kms", regionHash: regionHash,
|
|
56
|
-
partitionHash: partitionHash }))];
|
|
55
|
+
return [2 /*return*/, getRegionInfo(region, __assign(__assign({}, options), { signingService: "kms", regionHash: regionHash, partitionHash: partitionHash }))];
|
|
57
56
|
});
|
|
58
57
|
}); };
|
|
59
58
|
//# sourceMappingURL=endpoints.js.map
|
package/dist/es/endpoints.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"endpoints.js","sourceRoot":"","sources":["../../endpoints.ts"],"names":[],"mappings":";AAAA,OAAO,EAA6B,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAGpF,IAAM,UAAU,GAAe;IAC7B,QAAQ,EAAE;QACR,QAAQ,EAAE,sCAAsC;QAChD,aAAa,EAAE,eAAe;KAC/B;CACF,CAAC;AAEF,IAAM,aAAa,GAAkB;IACnC,GAAG,EAAE;QACH,OAAO,EAAE;YACP,YAAY;YACZ,WAAW;YACX,gBAAgB;YAChB,gBAAgB;YAChB,gBAAgB;YAChB,YAAY;YACZ,gBAAgB;YAChB,gBAAgB;YAChB,cAAc;YACd,cAAc;YACd,YAAY;YACZ,YAAY;YACZ,WAAW;YACX,WAAW;YACX,WAAW;YACX,YAAY;YACZ,WAAW;YACX,WAAW;YACX,WAAW;YACX,WAAW;YACX,WAAW;SACZ;QACD,QAAQ,EAAE,4BAA4B;KACvC;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,CAAC,YAAY,EAAE,gBAAgB,CAAC;QACzC,QAAQ,EAAE,+BAA+B;KAC1C;IACD,SAAS,EAAE;QACT,OAAO,EAAE,CAAC,UAAU,EAAE,eAAe,CAAC;QACtC,QAAQ,EAAE,yBAAyB;KACpC;IACD,WAAW,EAAE;QACX,OAAO,EAAE,CAAC,UAAU,EAAE,gBAAgB,CAAC;QACvC,QAAQ,EAAE,4BAA4B;KACvC;IACD,YAAY,EAAE;QACZ,OAAO,EAAE,CAAC,UAAU,EAAE,eAAe,EAAE,eAAe,CAAC;QACvD,QAAQ,EAAE,4BAA4B;KACvC;CACF,CAAC;AAEF,MAAM,CAAC,IAAM,yBAAyB,GAAuB,UAAO,MAAc,EAAE,OAAa;;QAC/F,sBAAA,aAAa,CAAC,MAAM,wBACf,OAAO,KACV,cAAc,EAAE,KAAK,EACrB,UAAU,YAAA
|
|
1
|
+
{"version":3,"file":"endpoints.js","sourceRoot":"","sources":["../../endpoints.ts"],"names":[],"mappings":";AAAA,OAAO,EAA6B,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAGpF,IAAM,UAAU,GAAe;IAC7B,QAAQ,EAAE;QACR,QAAQ,EAAE,sCAAsC;QAChD,aAAa,EAAE,eAAe;KAC/B;CACF,CAAC;AAEF,IAAM,aAAa,GAAkB;IACnC,GAAG,EAAE;QACH,OAAO,EAAE;YACP,YAAY;YACZ,WAAW;YACX,gBAAgB;YAChB,gBAAgB;YAChB,gBAAgB;YAChB,YAAY;YACZ,gBAAgB;YAChB,gBAAgB;YAChB,cAAc;YACd,cAAc;YACd,YAAY;YACZ,YAAY;YACZ,WAAW;YACX,WAAW;YACX,WAAW;YACX,YAAY;YACZ,WAAW;YACX,WAAW;YACX,WAAW;YACX,WAAW;YACX,WAAW;SACZ;QACD,QAAQ,EAAE,4BAA4B;KACvC;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,CAAC,YAAY,EAAE,gBAAgB,CAAC;QACzC,QAAQ,EAAE,+BAA+B;KAC1C;IACD,SAAS,EAAE;QACT,OAAO,EAAE,CAAC,UAAU,EAAE,eAAe,CAAC;QACtC,QAAQ,EAAE,yBAAyB;KACpC;IACD,WAAW,EAAE;QACX,OAAO,EAAE,CAAC,UAAU,EAAE,gBAAgB,CAAC;QACvC,QAAQ,EAAE,4BAA4B;KACvC;IACD,YAAY,EAAE;QACZ,OAAO,EAAE,CAAC,UAAU,EAAE,eAAe,EAAE,eAAe,CAAC;QACvD,QAAQ,EAAE,4BAA4B;KACvC;CACF,CAAC;AAEF,MAAM,CAAC,IAAM,yBAAyB,GAAuB,UAAO,MAAc,EAAE,OAAa;;QAC/F,sBAAA,aAAa,CAAC,MAAM,wBACf,OAAO,KACV,cAAc,EAAE,KAAK,EACrB,UAAU,YAAA,EACV,aAAa,eAAA,IACb,EAAA;;KAAA,CAAC"}
|
|
@@ -264,6 +264,17 @@ export var CustomerMasterKeySpec;
|
|
|
264
264
|
CustomerMasterKeySpec["RSA_4096"] = "RSA_4096";
|
|
265
265
|
CustomerMasterKeySpec["SYMMETRIC_DEFAULT"] = "SYMMETRIC_DEFAULT";
|
|
266
266
|
})(CustomerMasterKeySpec || (CustomerMasterKeySpec = {}));
|
|
267
|
+
export var KeySpec;
|
|
268
|
+
(function (KeySpec) {
|
|
269
|
+
KeySpec["ECC_NIST_P256"] = "ECC_NIST_P256";
|
|
270
|
+
KeySpec["ECC_NIST_P384"] = "ECC_NIST_P384";
|
|
271
|
+
KeySpec["ECC_NIST_P521"] = "ECC_NIST_P521";
|
|
272
|
+
KeySpec["ECC_SECG_P256K1"] = "ECC_SECG_P256K1";
|
|
273
|
+
KeySpec["RSA_2048"] = "RSA_2048";
|
|
274
|
+
KeySpec["RSA_3072"] = "RSA_3072";
|
|
275
|
+
KeySpec["RSA_4096"] = "RSA_4096";
|
|
276
|
+
KeySpec["SYMMETRIC_DEFAULT"] = "SYMMETRIC_DEFAULT";
|
|
277
|
+
})(KeySpec || (KeySpec = {}));
|
|
267
278
|
export var KeyUsageType;
|
|
268
279
|
(function (KeyUsageType) {
|
|
269
280
|
KeyUsageType["ENCRYPT_DECRYPT"] = "ENCRYPT_DECRYPT";
|