@aws-sdk/client-kms 3.362.0 → 3.366.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/KMS.js +1 -1
- package/dist-cjs/KMSClient.js +5 -5
- package/dist-cjs/commands/CancelKeyDeletionCommand.js +3 -3
- package/dist-cjs/commands/ConnectCustomKeyStoreCommand.js +3 -3
- package/dist-cjs/commands/CreateAliasCommand.js +3 -3
- package/dist-cjs/commands/CreateCustomKeyStoreCommand.js +3 -3
- package/dist-cjs/commands/CreateGrantCommand.js +3 -3
- package/dist-cjs/commands/CreateKeyCommand.js +3 -3
- package/dist-cjs/commands/DecryptCommand.js +3 -3
- package/dist-cjs/commands/DeleteAliasCommand.js +3 -3
- package/dist-cjs/commands/DeleteCustomKeyStoreCommand.js +3 -3
- package/dist-cjs/commands/DeleteImportedKeyMaterialCommand.js +3 -3
- package/dist-cjs/commands/DescribeCustomKeyStoresCommand.js +3 -3
- package/dist-cjs/commands/DescribeKeyCommand.js +3 -3
- package/dist-cjs/commands/DisableKeyCommand.js +3 -3
- package/dist-cjs/commands/DisableKeyRotationCommand.js +3 -3
- package/dist-cjs/commands/DisconnectCustomKeyStoreCommand.js +3 -3
- package/dist-cjs/commands/EnableKeyCommand.js +3 -3
- package/dist-cjs/commands/EnableKeyRotationCommand.js +3 -3
- package/dist-cjs/commands/EncryptCommand.js +3 -3
- package/dist-cjs/commands/GenerateDataKeyCommand.js +3 -3
- package/dist-cjs/commands/GenerateDataKeyPairCommand.js +3 -3
- package/dist-cjs/commands/GenerateDataKeyPairWithoutPlaintextCommand.js +3 -3
- package/dist-cjs/commands/GenerateDataKeyWithoutPlaintextCommand.js +3 -3
- package/dist-cjs/commands/GenerateMacCommand.js +3 -3
- package/dist-cjs/commands/GenerateRandomCommand.js +3 -3
- package/dist-cjs/commands/GetKeyPolicyCommand.js +3 -3
- package/dist-cjs/commands/GetKeyRotationStatusCommand.js +3 -3
- package/dist-cjs/commands/GetParametersForImportCommand.js +3 -3
- package/dist-cjs/commands/GetPublicKeyCommand.js +3 -3
- package/dist-cjs/commands/ImportKeyMaterialCommand.js +3 -3
- package/dist-cjs/commands/ListAliasesCommand.js +3 -3
- package/dist-cjs/commands/ListGrantsCommand.js +3 -3
- package/dist-cjs/commands/ListKeyPoliciesCommand.js +3 -3
- package/dist-cjs/commands/ListKeysCommand.js +3 -3
- package/dist-cjs/commands/ListResourceTagsCommand.js +3 -3
- package/dist-cjs/commands/ListRetirableGrantsCommand.js +3 -3
- package/dist-cjs/commands/PutKeyPolicyCommand.js +3 -3
- package/dist-cjs/commands/ReEncryptCommand.js +3 -3
- package/dist-cjs/commands/ReplicateKeyCommand.js +3 -3
- package/dist-cjs/commands/RetireGrantCommand.js +3 -3
- package/dist-cjs/commands/RevokeGrantCommand.js +3 -3
- package/dist-cjs/commands/ScheduleKeyDeletionCommand.js +3 -3
- package/dist-cjs/commands/SignCommand.js +3 -3
- package/dist-cjs/commands/TagResourceCommand.js +3 -3
- package/dist-cjs/commands/UntagResourceCommand.js +3 -3
- package/dist-cjs/commands/UpdateAliasCommand.js +3 -3
- package/dist-cjs/commands/UpdateCustomKeyStoreCommand.js +3 -3
- package/dist-cjs/commands/UpdateKeyDescriptionCommand.js +3 -3
- package/dist-cjs/commands/UpdatePrimaryRegionCommand.js +3 -3
- package/dist-cjs/commands/VerifyCommand.js +3 -3
- package/dist-cjs/commands/VerifyMacCommand.js +3 -3
- package/dist-cjs/models/KMSServiceException.js +1 -1
- package/dist-cjs/models/models_0.js +16 -3
- package/dist-cjs/protocols/Aws_json1_1.js +61 -1
- package/dist-cjs/runtimeConfig.browser.js +7 -7
- package/dist-cjs/runtimeConfig.js +10 -10
- package/dist-cjs/runtimeConfig.shared.js +4 -4
- package/dist-es/KMS.js +1 -1
- package/dist-es/KMSClient.js +5 -5
- package/dist-es/commands/CancelKeyDeletionCommand.js +3 -3
- package/dist-es/commands/ConnectCustomKeyStoreCommand.js +3 -3
- package/dist-es/commands/CreateAliasCommand.js +3 -3
- package/dist-es/commands/CreateCustomKeyStoreCommand.js +3 -3
- package/dist-es/commands/CreateGrantCommand.js +3 -3
- package/dist-es/commands/CreateKeyCommand.js +3 -3
- package/dist-es/commands/DecryptCommand.js +3 -3
- package/dist-es/commands/DeleteAliasCommand.js +3 -3
- package/dist-es/commands/DeleteCustomKeyStoreCommand.js +3 -3
- package/dist-es/commands/DeleteImportedKeyMaterialCommand.js +3 -3
- package/dist-es/commands/DescribeCustomKeyStoresCommand.js +3 -3
- package/dist-es/commands/DescribeKeyCommand.js +3 -3
- package/dist-es/commands/DisableKeyCommand.js +3 -3
- package/dist-es/commands/DisableKeyRotationCommand.js +3 -3
- package/dist-es/commands/DisconnectCustomKeyStoreCommand.js +3 -3
- package/dist-es/commands/EnableKeyCommand.js +3 -3
- package/dist-es/commands/EnableKeyRotationCommand.js +3 -3
- package/dist-es/commands/EncryptCommand.js +3 -3
- package/dist-es/commands/GenerateDataKeyCommand.js +3 -3
- package/dist-es/commands/GenerateDataKeyPairCommand.js +3 -3
- package/dist-es/commands/GenerateDataKeyPairWithoutPlaintextCommand.js +3 -3
- package/dist-es/commands/GenerateDataKeyWithoutPlaintextCommand.js +3 -3
- package/dist-es/commands/GenerateMacCommand.js +3 -3
- package/dist-es/commands/GenerateRandomCommand.js +3 -3
- package/dist-es/commands/GetKeyPolicyCommand.js +3 -3
- package/dist-es/commands/GetKeyRotationStatusCommand.js +3 -3
- package/dist-es/commands/GetParametersForImportCommand.js +3 -3
- package/dist-es/commands/GetPublicKeyCommand.js +3 -3
- package/dist-es/commands/ImportKeyMaterialCommand.js +3 -3
- package/dist-es/commands/ListAliasesCommand.js +3 -3
- package/dist-es/commands/ListGrantsCommand.js +3 -3
- package/dist-es/commands/ListKeyPoliciesCommand.js +3 -3
- package/dist-es/commands/ListKeysCommand.js +3 -3
- package/dist-es/commands/ListResourceTagsCommand.js +3 -3
- package/dist-es/commands/ListRetirableGrantsCommand.js +3 -3
- package/dist-es/commands/PutKeyPolicyCommand.js +3 -3
- package/dist-es/commands/ReEncryptCommand.js +3 -3
- package/dist-es/commands/ReplicateKeyCommand.js +3 -3
- package/dist-es/commands/RetireGrantCommand.js +3 -3
- package/dist-es/commands/RevokeGrantCommand.js +3 -3
- package/dist-es/commands/ScheduleKeyDeletionCommand.js +3 -3
- package/dist-es/commands/SignCommand.js +3 -3
- package/dist-es/commands/TagResourceCommand.js +3 -3
- package/dist-es/commands/UntagResourceCommand.js +3 -3
- package/dist-es/commands/UpdateAliasCommand.js +3 -3
- package/dist-es/commands/UpdateCustomKeyStoreCommand.js +3 -3
- package/dist-es/commands/UpdateKeyDescriptionCommand.js +3 -3
- package/dist-es/commands/UpdatePrimaryRegionCommand.js +3 -3
- package/dist-es/commands/VerifyCommand.js +3 -3
- package/dist-es/commands/VerifyMacCommand.js +3 -3
- package/dist-es/models/KMSServiceException.js +1 -1
- package/dist-es/models/models_0.js +13 -1
- package/dist-es/protocols/Aws_json1_1.js +62 -2
- package/dist-es/runtimeConfig.browser.js +7 -7
- package/dist-es/runtimeConfig.js +10 -10
- package/dist-es/runtimeConfig.shared.js +4 -4
- package/dist-types/KMS.d.ts +1 -1
- package/dist-types/KMSClient.d.ts +8 -8
- package/dist-types/commands/CancelKeyDeletionCommand.d.ts +6 -4
- package/dist-types/commands/ConnectCustomKeyStoreCommand.d.ts +3 -3
- package/dist-types/commands/CreateAliasCommand.d.ts +6 -4
- package/dist-types/commands/CreateCustomKeyStoreCommand.d.ts +14 -11
- package/dist-types/commands/CreateGrantCommand.d.ts +12 -4
- package/dist-types/commands/CreateKeyCommand.d.ts +19 -16
- package/dist-types/commands/DecryptCommand.d.ts +13 -5
- package/dist-types/commands/DeleteAliasCommand.d.ts +6 -4
- package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts +3 -3
- package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +6 -4
- package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +5 -5
- package/dist-types/commands/DescribeKeyCommand.d.ts +3 -3
- package/dist-types/commands/DisableKeyCommand.d.ts +6 -4
- package/dist-types/commands/DisableKeyRotationCommand.d.ts +6 -4
- package/dist-types/commands/DisconnectCustomKeyStoreCommand.d.ts +3 -3
- package/dist-types/commands/EnableKeyCommand.d.ts +6 -4
- package/dist-types/commands/EnableKeyRotationCommand.d.ts +6 -4
- package/dist-types/commands/EncryptCommand.d.ts +13 -6
- package/dist-types/commands/GenerateDataKeyCommand.d.ts +20 -11
- package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +24 -14
- package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +16 -7
- package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +16 -7
- package/dist-types/commands/GenerateMacCommand.d.ts +15 -6
- package/dist-types/commands/GenerateRandomCommand.d.ts +4 -4
- package/dist-types/commands/GetKeyPolicyCommand.d.ts +6 -4
- package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +6 -4
- package/dist-types/commands/GetParametersForImportCommand.d.ts +10 -7
- package/dist-types/commands/GetPublicKeyCommand.d.ts +11 -10
- package/dist-types/commands/ImportKeyMaterialCommand.d.ts +7 -6
- package/dist-types/commands/ListAliasesCommand.d.ts +3 -3
- package/dist-types/commands/ListGrantsCommand.d.ts +6 -4
- package/dist-types/commands/ListKeyPoliciesCommand.d.ts +6 -4
- package/dist-types/commands/ListKeysCommand.d.ts +3 -3
- 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 -4
- package/dist-types/commands/ReplicateKeyCommand.d.ts +6 -4
- package/dist-types/commands/RetireGrantCommand.d.ts +12 -4
- package/dist-types/commands/RevokeGrantCommand.d.ts +12 -4
- package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +9 -7
- package/dist-types/commands/SignCommand.d.ts +12 -4
- package/dist-types/commands/TagResourceCommand.d.ts +6 -4
- package/dist-types/commands/UntagResourceCommand.d.ts +6 -4
- package/dist-types/commands/UpdateAliasCommand.d.ts +6 -4
- package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +8 -6
- package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +6 -4
- package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +6 -4
- package/dist-types/commands/VerifyCommand.d.ts +20 -13
- package/dist-types/commands/VerifyMacCommand.d.ts +12 -4
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -2
- package/dist-types/endpoint/endpointResolver.d.ts +1 -1
- package/dist-types/endpoint/ruleset.d.ts +1 -1
- package/dist-types/models/KMSServiceException.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +229 -127
- package/dist-types/pagination/DescribeCustomKeyStoresPaginator.d.ts +1 -1
- package/dist-types/pagination/Interfaces.d.ts +1 -1
- package/dist-types/pagination/ListAliasesPaginator.d.ts +1 -1
- package/dist-types/pagination/ListGrantsPaginator.d.ts +1 -1
- package/dist-types/pagination/ListKeyPoliciesPaginator.d.ts +1 -1
- package/dist-types/pagination/ListKeysPaginator.d.ts +1 -1
- package/dist-types/pagination/ListResourceTagsPaginator.d.ts +1 -1
- package/dist-types/pagination/ListRetirableGrantsPaginator.d.ts +1 -1
- package/dist-types/runtimeConfig.browser.d.ts +20 -20
- package/dist-types/runtimeConfig.d.ts +20 -20
- package/dist-types/runtimeConfig.native.d.ts +19 -19
- package/dist-types/runtimeConfig.shared.d.ts +4 -4
- package/dist-types/ts3.4/KMS.d.ts +1 -1
- package/dist-types/ts3.4/KMSClient.d.ts +19 -21
- package/dist-types/ts3.4/commands/CancelKeyDeletionCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/ConnectCustomKeyStoreCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/CreateAliasCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/CreateCustomKeyStoreCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/CreateGrantCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/CreateKeyCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/DecryptCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/DeleteAliasCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/DeleteCustomKeyStoreCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/DeleteImportedKeyMaterialCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/DescribeCustomKeyStoresCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/DescribeKeyCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/DisableKeyCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/DisableKeyRotationCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/DisconnectCustomKeyStoreCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/EnableKeyCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/EnableKeyRotationCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/EncryptCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/GenerateDataKeyCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/GenerateDataKeyPairCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/GenerateMacCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/GenerateRandomCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/GetKeyPolicyCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/GetKeyRotationStatusCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/GetParametersForImportCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/GetPublicKeyCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/ImportKeyMaterialCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/ListAliasesCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/ListGrantsCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/ListKeyPoliciesCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/ListKeysCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/ListResourceTagsCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/ListRetirableGrantsCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/PutKeyPolicyCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/ReEncryptCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/ReplicateKeyCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/RetireGrantCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/RevokeGrantCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/ScheduleKeyDeletionCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/SignCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/UpdateAliasCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/UpdateCustomKeyStoreCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/UpdateKeyDescriptionCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/UpdatePrimaryRegionCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/VerifyCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/VerifyMacCommand.d.ts +3 -3
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +3 -2
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +1 -1
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +1 -1
- package/dist-types/ts3.4/models/KMSServiceException.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +22 -1
- package/dist-types/ts3.4/pagination/DescribeCustomKeyStoresPaginator.d.ts +1 -1
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +1 -1
- package/dist-types/ts3.4/pagination/ListAliasesPaginator.d.ts +1 -1
- package/dist-types/ts3.4/pagination/ListGrantsPaginator.d.ts +1 -1
- package/dist-types/ts3.4/pagination/ListKeyPoliciesPaginator.d.ts +1 -1
- package/dist-types/ts3.4/pagination/ListKeysPaginator.d.ts +1 -1
- package/dist-types/ts3.4/pagination/ListResourceTagsPaginator.d.ts +1 -1
- package/dist-types/ts3.4/pagination/ListRetirableGrantsPaginator.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +35 -40
- package/dist-types/ts3.4/runtimeConfig.d.ts +35 -37
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +33 -38
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +4 -4
- package/package.json +31 -30
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { EndpointParameterInstructions } from "@
|
|
2
|
-
import { Command as $Command } from "@
|
|
3
|
-
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { DecryptRequest, DecryptResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
@@ -83,7 +83,7 @@ export interface DecryptCommandOutput extends DecryptResponse, __MetadataBearer
|
|
|
83
83
|
* the <a href="https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk">Amazon Web Services Nitro Enclaves SDK</a> or any Amazon Web Services SDK. Use the <code>Recipient</code> parameter to provide the
|
|
84
84
|
* attestation document for the enclave. Instead of the plaintext data, the response includes the
|
|
85
85
|
* plaintext data encrypted with the public key from the attestation document
|
|
86
|
-
*
|
|
86
|
+
* (<code>CiphertextForRecipient</code>).For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves uses KMS</a> in the <i>Key Management Service Developer Guide</i>..</p>
|
|
87
87
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
88
88
|
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
89
89
|
* <p>
|
|
@@ -137,6 +137,7 @@ export interface DecryptCommandOutput extends DecryptResponse, __MetadataBearer
|
|
|
137
137
|
* KeyEncryptionAlgorithm: "RSAES_OAEP_SHA_256",
|
|
138
138
|
* AttestationDocument: "BLOB_VALUE",
|
|
139
139
|
* },
|
|
140
|
+
* DryRun: true || false,
|
|
140
141
|
* };
|
|
141
142
|
* const command = new DecryptCommand(input);
|
|
142
143
|
* const response = await client.send(command);
|
|
@@ -162,6 +163,11 @@ export interface DecryptCommandOutput extends DecryptResponse, __MetadataBearer
|
|
|
162
163
|
* @throws {@link DisabledException} (client fault)
|
|
163
164
|
* <p>The request was rejected because the specified KMS key is not enabled.</p>
|
|
164
165
|
*
|
|
166
|
+
* @throws {@link DryRunOperationException} (client fault)
|
|
167
|
+
* <p>
|
|
168
|
+
* The request was rejected because the DryRun parameter was specified.
|
|
169
|
+
* </p>
|
|
170
|
+
*
|
|
165
171
|
* @throws {@link IncorrectKeyException} (client fault)
|
|
166
172
|
* <p>The request was rejected because the specified KMS key cannot decrypt the data. The
|
|
167
173
|
* <code>KeyId</code> in a <a>Decrypt</a> request and the <code>SourceKeyId</code>
|
|
@@ -222,7 +228,9 @@ export interface DecryptCommandOutput extends DecryptResponse, __MetadataBearer
|
|
|
222
228
|
* </i>.</p>
|
|
223
229
|
* </li>
|
|
224
230
|
* <li>
|
|
225
|
-
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
231
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
232
|
+
* represents a general failure with many possible causes. To identify the cause, see the
|
|
233
|
+
* error message that accompanies the exception.</p>
|
|
226
234
|
* </li>
|
|
227
235
|
* </ul>
|
|
228
236
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { EndpointParameterInstructions } from "@
|
|
2
|
-
import { Command as $Command } from "@
|
|
3
|
-
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { DeleteAliasRequest } from "../models/models_0";
|
|
6
6
|
/**
|
|
@@ -114,7 +114,9 @@ export interface DeleteAliasCommandOutput extends __MetadataBearer {
|
|
|
114
114
|
* </i>.</p>
|
|
115
115
|
* </li>
|
|
116
116
|
* <li>
|
|
117
|
-
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
117
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
118
|
+
* represents a general failure with many possible causes. To identify the cause, see the
|
|
119
|
+
* error message that accompanies the exception.</p>
|
|
118
120
|
* </li>
|
|
119
121
|
* </ul>
|
|
120
122
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { EndpointParameterInstructions } from "@
|
|
2
|
-
import { Command as $Command } from "@
|
|
3
|
-
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { DeleteCustomKeyStoreRequest, DeleteCustomKeyStoreResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { EndpointParameterInstructions } from "@
|
|
2
|
-
import { Command as $Command } from "@
|
|
3
|
-
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { DeleteImportedKeyMaterialRequest } from "../models/models_0";
|
|
6
6
|
/**
|
|
@@ -98,7 +98,9 @@ export interface DeleteImportedKeyMaterialCommandOutput extends __MetadataBearer
|
|
|
98
98
|
* </i>.</p>
|
|
99
99
|
* </li>
|
|
100
100
|
* <li>
|
|
101
|
-
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
101
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
102
|
+
* represents a general failure with many possible causes. To identify the cause, see the
|
|
103
|
+
* error message that accompanies the exception.</p>
|
|
102
104
|
* </li>
|
|
103
105
|
* </ul>
|
|
104
106
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { EndpointParameterInstructions } from "@
|
|
2
|
-
import { Command as $Command } from "@
|
|
3
|
-
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { DescribeCustomKeyStoresRequest, DescribeCustomKeyStoresResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
@@ -46,8 +46,8 @@ export interface DescribeCustomKeyStoresCommandOutput extends DescribeCustomKeyS
|
|
|
46
46
|
* any. For an external key store, verify that the external key store proxy and its associated
|
|
47
47
|
* external key manager are reachable and enabled.</p>
|
|
48
48
|
* <p> For help repairing your CloudHSM key store, see the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html">Troubleshooting CloudHSM key stores</a>. For help
|
|
49
|
-
* repairing your external key store, see the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html">Troubleshooting external key stores</a>.
|
|
50
|
-
* topics are in the <i>Key Management Service Developer Guide</i>.</p>
|
|
49
|
+
* repairing your external key store, see the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html">Troubleshooting external key stores</a>.
|
|
50
|
+
* Both topics are in the <i>Key Management Service Developer Guide</i>.</p>
|
|
51
51
|
* <p>
|
|
52
52
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
53
53
|
* <p>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { EndpointParameterInstructions } from "@
|
|
2
|
-
import { Command as $Command } from "@
|
|
3
|
-
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { DescribeKeyRequest, DescribeKeyResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { EndpointParameterInstructions } from "@
|
|
2
|
-
import { Command as $Command } from "@
|
|
3
|
-
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { DisableKeyRequest } from "../models/models_0";
|
|
6
6
|
/**
|
|
@@ -85,7 +85,9 @@ export interface DisableKeyCommandOutput extends __MetadataBearer {
|
|
|
85
85
|
* </i>.</p>
|
|
86
86
|
* </li>
|
|
87
87
|
* <li>
|
|
88
|
-
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
88
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
89
|
+
* represents a general failure with many possible causes. To identify the cause, see the
|
|
90
|
+
* error message that accompanies the exception.</p>
|
|
89
91
|
* </li>
|
|
90
92
|
* </ul>
|
|
91
93
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { EndpointParameterInstructions } from "@
|
|
2
|
-
import { Command as $Command } from "@
|
|
3
|
-
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { DisableKeyRotationRequest } from "../models/models_0";
|
|
6
6
|
/**
|
|
@@ -106,7 +106,9 @@ export interface DisableKeyRotationCommandOutput extends __MetadataBearer {
|
|
|
106
106
|
* </i>.</p>
|
|
107
107
|
* </li>
|
|
108
108
|
* <li>
|
|
109
|
-
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
109
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
110
|
+
* represents a general failure with many possible causes. To identify the cause, see the
|
|
111
|
+
* error message that accompanies the exception.</p>
|
|
110
112
|
* </li>
|
|
111
113
|
* </ul>
|
|
112
114
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { EndpointParameterInstructions } from "@
|
|
2
|
-
import { Command as $Command } from "@
|
|
3
|
-
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { DisconnectCustomKeyStoreRequest, DisconnectCustomKeyStoreResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { EndpointParameterInstructions } from "@
|
|
2
|
-
import { Command as $Command } from "@
|
|
3
|
-
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { EnableKeyRequest } from "../models/models_0";
|
|
6
6
|
/**
|
|
@@ -81,7 +81,9 @@ export interface EnableKeyCommandOutput extends __MetadataBearer {
|
|
|
81
81
|
* </i>.</p>
|
|
82
82
|
* </li>
|
|
83
83
|
* <li>
|
|
84
|
-
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
84
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
85
|
+
* represents a general failure with many possible causes. To identify the cause, see the
|
|
86
|
+
* error message that accompanies the exception.</p>
|
|
85
87
|
* </li>
|
|
86
88
|
* </ul>
|
|
87
89
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { EndpointParameterInstructions } from "@
|
|
2
|
-
import { Command as $Command } from "@
|
|
3
|
-
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { EnableKeyRotationRequest } from "../models/models_0";
|
|
6
6
|
/**
|
|
@@ -114,7 +114,9 @@ export interface EnableKeyRotationCommandOutput extends __MetadataBearer {
|
|
|
114
114
|
* </i>.</p>
|
|
115
115
|
* </li>
|
|
116
116
|
* <li>
|
|
117
|
-
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
117
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
118
|
+
* represents a general failure with many possible causes. To identify the cause, see the
|
|
119
|
+
* error message that accompanies the exception.</p>
|
|
118
120
|
* </li>
|
|
119
121
|
* </ul>
|
|
120
122
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { EndpointParameterInstructions } from "@
|
|
2
|
-
import { Command as $Command } from "@
|
|
3
|
-
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { EncryptRequest, EncryptResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
@@ -108,8 +108,7 @@ export interface EncryptCommandOutput extends EncryptResponse, __MetadataBearer
|
|
|
108
108
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
109
109
|
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
110
110
|
* <p>
|
|
111
|
-
* <b>Cross-account use</b>: Yes.
|
|
112
|
-
* To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
111
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
113
112
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
114
113
|
* <p>
|
|
115
114
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:Encrypt</a> (key policy)</p>
|
|
@@ -149,6 +148,7 @@ export interface EncryptCommandOutput extends EncryptResponse, __MetadataBearer
|
|
|
149
148
|
* "STRING_VALUE",
|
|
150
149
|
* ],
|
|
151
150
|
* EncryptionAlgorithm: "SYMMETRIC_DEFAULT" || "RSAES_OAEP_SHA_1" || "RSAES_OAEP_SHA_256" || "SM2PKE",
|
|
151
|
+
* DryRun: true || false,
|
|
152
152
|
* };
|
|
153
153
|
* const command = new EncryptCommand(input);
|
|
154
154
|
* const response = await client.send(command);
|
|
@@ -173,6 +173,11 @@ export interface EncryptCommandOutput extends EncryptResponse, __MetadataBearer
|
|
|
173
173
|
* @throws {@link DisabledException} (client fault)
|
|
174
174
|
* <p>The request was rejected because the specified KMS key is not enabled.</p>
|
|
175
175
|
*
|
|
176
|
+
* @throws {@link DryRunOperationException} (client fault)
|
|
177
|
+
* <p>
|
|
178
|
+
* The request was rejected because the DryRun parameter was specified.
|
|
179
|
+
* </p>
|
|
180
|
+
*
|
|
176
181
|
* @throws {@link InvalidGrantTokenException} (client fault)
|
|
177
182
|
* <p>The request was rejected because the specified grant token is not valid.</p>
|
|
178
183
|
*
|
|
@@ -219,7 +224,9 @@ export interface EncryptCommandOutput extends EncryptResponse, __MetadataBearer
|
|
|
219
224
|
* </i>.</p>
|
|
220
225
|
* </li>
|
|
221
226
|
* <li>
|
|
222
|
-
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
227
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
228
|
+
* represents a general failure with many possible causes. To identify the cause, see the
|
|
229
|
+
* error message that accompanies the exception.</p>
|
|
223
230
|
* </li>
|
|
224
231
|
* </ul>
|
|
225
232
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { EndpointParameterInstructions } from "@
|
|
2
|
-
import { Command as $Command } from "@
|
|
3
|
-
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { GenerateDataKeyRequest, GenerateDataKeyResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
@@ -25,18 +25,19 @@ export interface GenerateDataKeyCommandOutput extends GenerateDataKeyResponse, _
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns a unique symmetric data key for use outside of KMS. This operation returns a
|
|
27
27
|
* plaintext copy of the data key and a copy that is encrypted under a symmetric encryption KMS
|
|
28
|
-
* key that you specify. The bytes in the plaintext key are random; they are not related
|
|
29
|
-
*
|
|
30
|
-
*
|
|
28
|
+
* key that you specify. The bytes in the plaintext key are random; they are not related to the
|
|
29
|
+
* caller or the KMS key. You can use the plaintext key to encrypt your data outside of KMS and
|
|
30
|
+
* store the encrypted data key with the encrypted data.</p>
|
|
31
31
|
* <p>To generate a data key, specify the symmetric encryption KMS key that will be used to
|
|
32
32
|
* encrypt the data key. You cannot use an asymmetric KMS key to encrypt data keys. To get the
|
|
33
33
|
* type of your KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
34
34
|
* <p>You must also specify the length of the data key. Use either the <code>KeySpec</code> or
|
|
35
|
-
*
|
|
35
|
+
* <code>NumberOfBytes</code> parameters (but not both). For 128-bit and 256-bit data keys, use
|
|
36
36
|
* the <code>KeySpec</code> parameter.</p>
|
|
37
|
-
* <p>To generate a 128-bit SM4 data key (China Regions only), specify a <code>KeySpec</code>
|
|
38
|
-
* <code>AES_128</code> or a <code>NumberOfBytes</code> value of <code>16</code>. The
|
|
39
|
-
* encryption key used in China Regions to encrypt your data key is an SM4 encryption
|
|
37
|
+
* <p>To generate a 128-bit SM4 data key (China Regions only), specify a <code>KeySpec</code>
|
|
38
|
+
* value of <code>AES_128</code> or a <code>NumberOfBytes</code> value of <code>16</code>. The
|
|
39
|
+
* symmetric encryption key used in China Regions to encrypt your data key is an SM4 encryption
|
|
40
|
+
* key.</p>
|
|
40
41
|
* <p>To get only an encrypted copy of the data key, use <a>GenerateDataKeyWithoutPlaintext</a>. To generate an asymmetric data key pair, use
|
|
41
42
|
* the <a>GenerateDataKeyPair</a> or <a>GenerateDataKeyPairWithoutPlaintext</a> operation. To get a cryptographically secure
|
|
42
43
|
* random byte string, use <a>GenerateRandom</a>.</p>
|
|
@@ -145,6 +146,7 @@ export interface GenerateDataKeyCommandOutput extends GenerateDataKeyResponse, _
|
|
|
145
146
|
* KeyEncryptionAlgorithm: "RSAES_OAEP_SHA_256",
|
|
146
147
|
* AttestationDocument: "BLOB_VALUE",
|
|
147
148
|
* },
|
|
149
|
+
* DryRun: true || false,
|
|
148
150
|
* };
|
|
149
151
|
* const command = new GenerateDataKeyCommand(input);
|
|
150
152
|
* const response = await client.send(command);
|
|
@@ -170,6 +172,11 @@ export interface GenerateDataKeyCommandOutput extends GenerateDataKeyResponse, _
|
|
|
170
172
|
* @throws {@link DisabledException} (client fault)
|
|
171
173
|
* <p>The request was rejected because the specified KMS key is not enabled.</p>
|
|
172
174
|
*
|
|
175
|
+
* @throws {@link DryRunOperationException} (client fault)
|
|
176
|
+
* <p>
|
|
177
|
+
* The request was rejected because the DryRun parameter was specified.
|
|
178
|
+
* </p>
|
|
179
|
+
*
|
|
173
180
|
* @throws {@link InvalidGrantTokenException} (client fault)
|
|
174
181
|
* <p>The request was rejected because the specified grant token is not valid.</p>
|
|
175
182
|
*
|
|
@@ -216,7 +223,9 @@ export interface GenerateDataKeyCommandOutput extends GenerateDataKeyResponse, _
|
|
|
216
223
|
* </i>.</p>
|
|
217
224
|
* </li>
|
|
218
225
|
* <li>
|
|
219
|
-
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
226
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
227
|
+
* represents a general failure with many possible causes. To identify the cause, see the
|
|
228
|
+
* error message that accompanies the exception.</p>
|
|
220
229
|
* </li>
|
|
221
230
|
* </ul>
|
|
222
231
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { EndpointParameterInstructions } from "@
|
|
2
|
-
import { Command as $Command } from "@
|
|
3
|
-
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { GenerateDataKeyPairRequest, GenerateDataKeyPairResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
@@ -36,9 +36,10 @@ export interface GenerateDataKeyPairCommandOutput extends GenerateDataKeyPairRes
|
|
|
36
36
|
* the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a
|
|
37
37
|
* custom key store. To get the type and origin of your KMS key, use the <a>DescribeKey</a> operation. </p>
|
|
38
38
|
* <p>Use the <code>KeyPairSpec</code> parameter to choose an RSA or Elliptic Curve (ECC) data
|
|
39
|
-
* key pair. In China Regions, you can also choose an SM2 data key pair. KMS recommends that
|
|
40
|
-
* ECC key pairs for signing, and use RSA and SM2 key pairs for either encryption or
|
|
41
|
-
* However, KMS cannot enforce any restrictions on the use of data key
|
|
39
|
+
* key pair. In China Regions, you can also choose an SM2 data key pair. KMS recommends that
|
|
40
|
+
* you use ECC key pairs for signing, and use RSA and SM2 key pairs for either encryption or
|
|
41
|
+
* signing, but not both. However, KMS cannot enforce any restrictions on the use of data key
|
|
42
|
+
* pairs outside of KMS.</p>
|
|
42
43
|
* <p>If you are using the data key pair to encrypt data, or for any operation where you don't
|
|
43
44
|
* immediately need a private key, consider using the <a>GenerateDataKeyPairWithoutPlaintext</a> operation.
|
|
44
45
|
* <code>GenerateDataKeyPairWithoutPlaintext</code> returns a plaintext public key and an
|
|
@@ -54,13 +55,14 @@ export interface GenerateDataKeyPairCommandOutput extends GenerateDataKeyPairRes
|
|
|
54
55
|
* key is a DER-encoded PKCS8 PrivateKeyInfo, as specified in <a href="https://tools.ietf.org/html/rfc5958">RFC 5958</a>.</p>
|
|
55
56
|
* <p>
|
|
56
57
|
* <code>GenerateDataKeyPair</code> also supports <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html">Amazon Web Services Nitro Enclaves</a>, which provide an
|
|
57
|
-
* isolated compute environment in Amazon EC2. To call <code>GenerateDataKeyPair</code> for an Amazon Web Services
|
|
58
|
-
* enclave, use the <a href="https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk">Amazon Web Services Nitro Enclaves SDK</a> or any Amazon Web Services SDK. Use the <code>Recipient</code>
|
|
59
|
-
* to provide the attestation document for the enclave.
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
*
|
|
58
|
+
* isolated compute environment in Amazon EC2. To call <code>GenerateDataKeyPair</code> for an Amazon Web Services
|
|
59
|
+
* Nitro enclave, use the <a href="https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk">Amazon Web Services Nitro Enclaves SDK</a> or any Amazon Web Services SDK. Use the <code>Recipient</code>
|
|
60
|
+
* parameter to provide the attestation document for the enclave.
|
|
61
|
+
* <code>GenerateDataKeyPair</code> returns the public data key and a copy of the private data
|
|
62
|
+
* key encrypted under the specified KMS key, as usual. But instead of a plaintext copy of the
|
|
63
|
+
* private data key (<code>PrivateKeyPlaintext</code>), the response includes a copy of the
|
|
64
|
+
* private data key encrypted under the public key from the attestation document
|
|
65
|
+
* (<code>CiphertextForRecipient</code>). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves uses KMS</a> in the <i>Key Management Service Developer Guide</i>..</p>
|
|
64
66
|
* <p>You can use an optional encryption context to add additional security to the encryption
|
|
65
67
|
* operation. If you specify an <code>EncryptionContext</code>, you must specify the same
|
|
66
68
|
* encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
|
|
@@ -122,6 +124,7 @@ export interface GenerateDataKeyPairCommandOutput extends GenerateDataKeyPairRes
|
|
|
122
124
|
* KeyEncryptionAlgorithm: "RSAES_OAEP_SHA_256",
|
|
123
125
|
* AttestationDocument: "BLOB_VALUE",
|
|
124
126
|
* },
|
|
127
|
+
* DryRun: true || false,
|
|
125
128
|
* };
|
|
126
129
|
* const command = new GenerateDataKeyPairCommand(input);
|
|
127
130
|
* const response = await client.send(command);
|
|
@@ -149,6 +152,11 @@ export interface GenerateDataKeyPairCommandOutput extends GenerateDataKeyPairRes
|
|
|
149
152
|
* @throws {@link DisabledException} (client fault)
|
|
150
153
|
* <p>The request was rejected because the specified KMS key is not enabled.</p>
|
|
151
154
|
*
|
|
155
|
+
* @throws {@link DryRunOperationException} (client fault)
|
|
156
|
+
* <p>
|
|
157
|
+
* The request was rejected because the DryRun parameter was specified.
|
|
158
|
+
* </p>
|
|
159
|
+
*
|
|
152
160
|
* @throws {@link InvalidGrantTokenException} (client fault)
|
|
153
161
|
* <p>The request was rejected because the specified grant token is not valid.</p>
|
|
154
162
|
*
|
|
@@ -195,7 +203,9 @@ export interface GenerateDataKeyPairCommandOutput extends GenerateDataKeyPairRes
|
|
|
195
203
|
* </i>.</p>
|
|
196
204
|
* </li>
|
|
197
205
|
* <li>
|
|
198
|
-
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
206
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
207
|
+
* represents a general failure with many possible causes. To identify the cause, see the
|
|
208
|
+
* error message that accompanies the exception.</p>
|
|
199
209
|
* </li>
|
|
200
210
|
* </ul>
|
|
201
211
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { EndpointParameterInstructions } from "@
|
|
2
|
-
import { Command as $Command } from "@
|
|
3
|
-
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { GenerateDataKeyPairWithoutPlaintextRequest, GenerateDataKeyPairWithoutPlaintextResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
@@ -35,9 +35,10 @@ export interface GenerateDataKeyPairWithoutPlaintextCommandOutput extends Genera
|
|
|
35
35
|
* the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a
|
|
36
36
|
* custom key store. To get the type and origin of your KMS key, use the <a>DescribeKey</a> operation. </p>
|
|
37
37
|
* <p>Use the <code>KeyPairSpec</code> parameter to choose an RSA or Elliptic Curve (ECC) data
|
|
38
|
-
* key pair. In China Regions, you can also choose an SM2 data key pair. KMS recommends that
|
|
39
|
-
* use ECC key pairs for signing, and use RSA and SM2 key pairs for either encryption or
|
|
40
|
-
* both. However, KMS cannot enforce any restrictions on the use of data key
|
|
38
|
+
* key pair. In China Regions, you can also choose an SM2 data key pair. KMS recommends that
|
|
39
|
+
* you use ECC key pairs for signing, and use RSA and SM2 key pairs for either encryption or
|
|
40
|
+
* signing, but not both. However, KMS cannot enforce any restrictions on the use of data key
|
|
41
|
+
* pairs outside of KMS.</p>
|
|
41
42
|
* <p>
|
|
42
43
|
* <code>GenerateDataKeyPairWithoutPlaintext</code> returns a unique data key pair for each
|
|
43
44
|
* request. The bytes in the key are not related to the caller or KMS key that is used to encrypt
|
|
@@ -101,6 +102,7 @@ export interface GenerateDataKeyPairWithoutPlaintextCommandOutput extends Genera
|
|
|
101
102
|
* GrantTokens: [ // GrantTokenList
|
|
102
103
|
* "STRING_VALUE",
|
|
103
104
|
* ],
|
|
105
|
+
* DryRun: true || false,
|
|
104
106
|
* };
|
|
105
107
|
* const command = new GenerateDataKeyPairWithoutPlaintextCommand(input);
|
|
106
108
|
* const response = await client.send(command);
|
|
@@ -126,6 +128,11 @@ export interface GenerateDataKeyPairWithoutPlaintextCommandOutput extends Genera
|
|
|
126
128
|
* @throws {@link DisabledException} (client fault)
|
|
127
129
|
* <p>The request was rejected because the specified KMS key is not enabled.</p>
|
|
128
130
|
*
|
|
131
|
+
* @throws {@link DryRunOperationException} (client fault)
|
|
132
|
+
* <p>
|
|
133
|
+
* The request was rejected because the DryRun parameter was specified.
|
|
134
|
+
* </p>
|
|
135
|
+
*
|
|
129
136
|
* @throws {@link InvalidGrantTokenException} (client fault)
|
|
130
137
|
* <p>The request was rejected because the specified grant token is not valid.</p>
|
|
131
138
|
*
|
|
@@ -172,7 +179,9 @@ export interface GenerateDataKeyPairWithoutPlaintextCommandOutput extends Genera
|
|
|
172
179
|
* </i>.</p>
|
|
173
180
|
* </li>
|
|
174
181
|
* <li>
|
|
175
|
-
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
182
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
183
|
+
* represents a general failure with many possible causes. To identify the cause, see the
|
|
184
|
+
* error message that accompanies the exception.</p>
|
|
176
185
|
* </li>
|
|
177
186
|
* </ul>
|
|
178
187
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { EndpointParameterInstructions } from "@
|
|
2
|
-
import { Command as $Command } from "@
|
|
3
|
-
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { GenerateDataKeyWithoutPlaintextRequest, GenerateDataKeyWithoutPlaintextResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
@@ -42,10 +42,11 @@ export interface GenerateDataKeyWithoutPlaintextCommandOutput extends GenerateDa
|
|
|
42
42
|
* <p>To request an asymmetric data key pair, use the <a>GenerateDataKeyPair</a> or
|
|
43
43
|
* <a>GenerateDataKeyPairWithoutPlaintext</a> operations.</p>
|
|
44
44
|
* <p>To generate a data key, you must specify the symmetric encryption KMS key that is used to
|
|
45
|
-
* encrypt the data key. You cannot use an asymmetric KMS key or a key in a custom key store to
|
|
46
|
-
* type of your KMS key, use the <a>DescribeKey</a>
|
|
45
|
+
* encrypt the data key. You cannot use an asymmetric KMS key or a key in a custom key store to
|
|
46
|
+
* generate a data key. To get the type of your KMS key, use the <a>DescribeKey</a>
|
|
47
|
+
* operation.</p>
|
|
47
48
|
* <p>You must also specify the length of the data key. Use either the <code>KeySpec</code> or
|
|
48
|
-
*
|
|
49
|
+
* <code>NumberOfBytes</code> parameters (but not both). For 128-bit and 256-bit data keys, use
|
|
49
50
|
* the <code>KeySpec</code> parameter.</p>
|
|
50
51
|
* <p>To generate an SM4 data key (China Regions only), specify a <code>KeySpec</code> value of
|
|
51
52
|
* <code>AES_128</code> or <code>NumberOfBytes</code> value of <code>16</code>. The symmetric
|
|
@@ -111,6 +112,7 @@ export interface GenerateDataKeyWithoutPlaintextCommandOutput extends GenerateDa
|
|
|
111
112
|
* GrantTokens: [ // GrantTokenList
|
|
112
113
|
* "STRING_VALUE",
|
|
113
114
|
* ],
|
|
115
|
+
* DryRun: true || false,
|
|
114
116
|
* };
|
|
115
117
|
* const command = new GenerateDataKeyWithoutPlaintextCommand(input);
|
|
116
118
|
* const response = await client.send(command);
|
|
@@ -134,6 +136,11 @@ export interface GenerateDataKeyWithoutPlaintextCommandOutput extends GenerateDa
|
|
|
134
136
|
* @throws {@link DisabledException} (client fault)
|
|
135
137
|
* <p>The request was rejected because the specified KMS key is not enabled.</p>
|
|
136
138
|
*
|
|
139
|
+
* @throws {@link DryRunOperationException} (client fault)
|
|
140
|
+
* <p>
|
|
141
|
+
* The request was rejected because the DryRun parameter was specified.
|
|
142
|
+
* </p>
|
|
143
|
+
*
|
|
137
144
|
* @throws {@link InvalidGrantTokenException} (client fault)
|
|
138
145
|
* <p>The request was rejected because the specified grant token is not valid.</p>
|
|
139
146
|
*
|
|
@@ -180,7 +187,9 @@ export interface GenerateDataKeyWithoutPlaintextCommandOutput extends GenerateDa
|
|
|
180
187
|
* </i>.</p>
|
|
181
188
|
* </li>
|
|
182
189
|
* <li>
|
|
183
|
-
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
190
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
191
|
+
* represents a general failure with many possible causes. To identify the cause, see the
|
|
192
|
+
* error message that accompanies the exception.</p>
|
|
184
193
|
* </li>
|
|
185
194
|
* </ul>
|
|
186
195
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { EndpointParameterInstructions } from "@
|
|
2
|
-
import { Command as $Command } from "@
|
|
3
|
-
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { GenerateMacRequest, GenerateMacResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
@@ -23,8 +23,9 @@ export interface GenerateMacCommandOutput extends GenerateMacResponse, __Metadat
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS
|
|
27
|
-
*
|
|
26
|
+
* <p>Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS
|
|
27
|
+
* key and a MAC algorithm that the key supports. HMAC KMS keys and the HMAC algorithms that
|
|
28
|
+
* KMS uses conform to industry standards defined in <a href="https://datatracker.ietf.org/doc/html/rfc2104">RFC 2104</a>.</p>
|
|
28
29
|
* <p>You can use value that GenerateMac returns in the <a>VerifyMac</a> operation to
|
|
29
30
|
* demonstrate that the original message has not changed. Also, because a secret key is used to
|
|
30
31
|
* create the hash, you can verify that the party that generated the hash has the required secret
|
|
@@ -64,6 +65,7 @@ export interface GenerateMacCommandOutput extends GenerateMacResponse, __Metadat
|
|
|
64
65
|
* GrantTokens: [ // GrantTokenList
|
|
65
66
|
* "STRING_VALUE",
|
|
66
67
|
* ],
|
|
68
|
+
* DryRun: true || false,
|
|
67
69
|
* };
|
|
68
70
|
* const command = new GenerateMacCommand(input);
|
|
69
71
|
* const response = await client.send(command);
|
|
@@ -84,6 +86,11 @@ export interface GenerateMacCommandOutput extends GenerateMacResponse, __Metadat
|
|
|
84
86
|
* @throws {@link DisabledException} (client fault)
|
|
85
87
|
* <p>The request was rejected because the specified KMS key is not enabled.</p>
|
|
86
88
|
*
|
|
89
|
+
* @throws {@link DryRunOperationException} (client fault)
|
|
90
|
+
* <p>
|
|
91
|
+
* The request was rejected because the DryRun parameter was specified.
|
|
92
|
+
* </p>
|
|
93
|
+
*
|
|
87
94
|
* @throws {@link InvalidGrantTokenException} (client fault)
|
|
88
95
|
* <p>The request was rejected because the specified grant token is not valid.</p>
|
|
89
96
|
*
|
|
@@ -130,7 +137,9 @@ export interface GenerateMacCommandOutput extends GenerateMacResponse, __Metadat
|
|
|
130
137
|
* </i>.</p>
|
|
131
138
|
* </li>
|
|
132
139
|
* <li>
|
|
133
|
-
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
140
|
+
* <p>For cryptographic operations on KMS keys in custom key stores, this exception
|
|
141
|
+
* represents a general failure with many possible causes. To identify the cause, see the
|
|
142
|
+
* error message that accompanies the exception.</p>
|
|
134
143
|
* </li>
|
|
135
144
|
* </ul>
|
|
136
145
|
*
|