import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient"; import type { GenerateDataKeyRequest, GenerateDataKeyResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GenerateDataKeyCommand}. */ export interface GenerateDataKeyCommandInput extends GenerateDataKeyRequest { } /** * @public * * The output of {@link GenerateDataKeyCommand}. */ export interface GenerateDataKeyCommandOutput extends GenerateDataKeyResponse, __MetadataBearer { } declare const GenerateDataKeyCommand_base: { new (input: GenerateDataKeyCommandInput): import("@smithy/core/client").CommandImpl; new (input: GenerateDataKeyCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Returns a unique symmetric data key for use outside of KMS. This operation returns a * plaintext copy of the data key and a copy that is encrypted under a symmetric encryption KMS * key that you specify. The bytes in the plaintext key are random; they are not related to the * caller or the KMS key. You can use the plaintext key to encrypt your data outside of KMS and * store the encrypted data key with the encrypted data.

To generate a data key, specify the symmetric encryption KMS key that will be used to * encrypt the data key. You cannot use an asymmetric KMS key to encrypt data keys. To get the * type of your KMS key, use the DescribeKey operation.

You must also specify the length of the data key. Use either the KeySpec or * NumberOfBytes parameters (but not both). For 128-bit and 256-bit data keys, use * the KeySpec parameter.

To generate a 128-bit SM4 data key (China Regions only), specify a KeySpec * value of AES_128 or a NumberOfBytes value of 16. The * symmetric encryption key used in China Regions to encrypt your data key is an SM4 encryption * key.

To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use * the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure * random byte string, use GenerateRandom.

You can use an optional encryption context to add additional security to the encryption * operation. If you specify an EncryptionContext, you must specify the same * encryption context (a case-sensitive exact match) when decrypting the encrypted data key. * Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the * Key Management Service Developer Guide.

* GenerateDataKey also supports Amazon Web Services Nitro Enclaves, which provide an * isolated compute environment in Amazon EC2. To call GenerateDataKey for an Amazon Web Services Nitro * enclave or NitroTPM, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the * Recipient parameter to provide the attestation document for the attested * environment. GenerateDataKey returns a copy of the data key encrypted under the * specified KMS key, as usual. But instead of a plaintext copy of the data key, the response * includes a copy of the data key encrypted under the public key from the attestation document * (CiphertextForRecipient). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.

The KMS key that you use for this operation must be in a compatible key state. For * details, see Key states of KMS keys in the Key Management Service Developer Guide.

* How to use your data key *

We recommend that you use the following pattern to encrypt data locally in your * application. You can write your own code or use a client-side encryption library, such as the * Amazon Web Services Encryption SDK, the * Amazon DynamoDB Encryption Client, * or Amazon S3 * client-side encryption to do these tasks for you.

To encrypt data outside of KMS:

*
Use the GenerateDataKey operation to get a data key.
*
*
Use the plaintext data key (in the Plaintext field of the response) to * encrypt your data outside of KMS. Then erase the plaintext data key from memory.
*
*
Store the encrypted data key (in the CiphertextBlob field of the * response) with the encrypted data.
*

To decrypt data outside of KMS:

*
Use the Decrypt operation to decrypt the encrypted data key. The * operation returns a plaintext copy of the data key.
*
*
Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext * data key from memory.
*

* Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify * the key ARN or alias ARN in the value of the KeyId parameter.

* Required permissions: kms:GenerateDataKey (key policy)

* Related operations: *

*
* Decrypt *
*
*
* Encrypt *
*
*
* GenerateDataKeyPair *
*
*
* GenerateDataKeyPairWithoutPlaintext *
*
*
* GenerateDataKeyWithoutPlaintext *
*

* Eventual consistency: The KMS API follows an eventual consistency model. * For more information, see KMS eventual consistency.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { KMSClient, GenerateDataKeyCommand } from "@aws-sdk/client-kms"; // ES Modules import * // const { KMSClient, GenerateDataKeyCommand } = require("@aws-sdk/client-kms"); // CommonJS import * // import type { KMSClientConfig } from "@aws-sdk/client-kms"; * const config = {}; // type is KMSClientConfig * const client = new KMSClient(config); * const input = { // GenerateDataKeyRequest * KeyId: "STRING_VALUE", // required * EncryptionContext: { // EncryptionContextType * "": "STRING_VALUE", * }, * NumberOfBytes: Number("int"), * KeySpec: "AES_256" || "AES_128", * GrantTokens: [ // GrantTokenList * "STRING_VALUE", * ], * Recipient: { // RecipientInfo * KeyEncryptionAlgorithm: "RSAES_OAEP_SHA_256", * AttestationDocument: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") * }, * DryRun: true || false, * }; * const command = new GenerateDataKeyCommand(input); * const response = await client.send(command); * // { // GenerateDataKeyResponse * // CiphertextBlob: new Uint8Array(), * // Plaintext: new Uint8Array(), * // KeyId: "STRING_VALUE", * // CiphertextForRecipient: new Uint8Array(), * // KeyMaterialId: "STRING_VALUE", * // }; * * ``` * * @param GenerateDataKeyCommandInput - {@link GenerateDataKeyCommandInput} * @returns {@link GenerateDataKeyCommandOutput} * @see {@link GenerateDataKeyCommandInput} for command's `input` shape. * @see {@link GenerateDataKeyCommandOutput} for command's `response` shape. * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape. * * @throws {@link DependencyTimeoutException} (server fault) *

The system timed out while trying to fulfill the request. You can retry the * request.

* * @throws {@link DisabledException} (client fault) *

The request was rejected because the specified KMS key is not enabled.

* * @throws {@link DryRunOperationException} (client fault) *

The request was rejected because the DryRun parameter was specified.

* * @throws {@link InvalidGrantTokenException} (client fault) *

The request was rejected because the specified grant token is not valid.

* * @throws {@link InvalidKeyUsageException} (client fault) *

The request was rejected for one of the following reasons:

*
The KeyUsage value of the KMS key is incompatible with the API * operation.
*
*
The encryption algorithm or signing algorithm specified for the operation is * incompatible with the type of key material in the KMS key (KeySpec).
*

For encrypting, decrypting, re-encrypting, and generating data keys, the * KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying * messages, the KeyUsage must be SIGN_VERIFY. For generating and * verifying message authentication codes (MACs), the KeyUsage must be * GENERATE_VERIFY_MAC. For deriving key agreement secrets, the * KeyUsage must be KEY_AGREEMENT. To find the KeyUsage * of a KMS key, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular KMS key, use the * DescribeKey operation.

* * @throws {@link KeyUnavailableException} (server fault) *

The request was rejected because the specified KMS key was not available. You can retry * the request.

* * @throws {@link KMSInternalException} (server fault) *

The request was rejected because an internal exception occurred. The request can be * retried.

* * @throws {@link KMSInvalidStateException} (client fault) *

The request was rejected because the state of the specified resource is not valid for this * request.

This exceptions means one of the following:

*
The key state of the KMS key is not compatible with the operation.
*
To find the key state, use the DescribeKey operation. For more * information about which key states are compatible with each KMS operation, see * Key states of KMS keys in the * Key Management Service Developer Guide * .
*
*
For cryptographic operations on KMS keys in custom key stores, this exception * represents a general failure with many possible causes. To identify the cause, see the * error message that accompanies the exception.
*

* * @throws {@link NotFoundException} (client fault) *

The request was rejected because the specified entity or resource could not be * found.

* * @throws {@link KMSServiceException} *

Base exception class for all service exceptions from KMS service.

* * * @example To generate a data key * ```javascript * // The following example generates a 256-bit symmetric data encryption key (data key) in two formats. One is the unencrypted (plainext) data key, and the other is the data key encrypted with the specified KMS key. * const input = { * KeyId: "alias/ExampleAlias", * KeySpec: "AES_256" * }; * const command = new GenerateDataKeyCommand(input); * const response = await client.send(command); * /* response is * { * CiphertextBlob: "", * KeyId: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", * KeyMaterialId: "0b7fd7ddbac6eef27907413567cad8c810e2883dc8a7534067a82ee1142fc1e6", * Plaintext: "" * } * *\/ * ``` * * @public */ export declare class GenerateDataKeyCommand extends GenerateDataKeyCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GenerateDataKeyRequest; output: GenerateDataKeyResponse; }; sdk: { input: GenerateDataKeyCommandInput; output: GenerateDataKeyCommandOutput; }; }; }