import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GenerateDataKeyWithoutPlaintextRequest, GenerateDataKeyWithoutPlaintextResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link GenerateDataKeyWithoutPlaintextCommand}. */ export interface GenerateDataKeyWithoutPlaintextCommandInput extends GenerateDataKeyWithoutPlaintextRequest { } /** * @public * * The output of {@link GenerateDataKeyWithoutPlaintextCommand}. */ export interface GenerateDataKeyWithoutPlaintextCommandOutput extends GenerateDataKeyWithoutPlaintextResponse, __MetadataBearer { } declare const GenerateDataKeyWithoutPlaintextCommand_base: { new (input: GenerateDataKeyWithoutPlaintextCommandInput): import("@smithy/core/client").CommandImpl; new (input: GenerateDataKeyWithoutPlaintextCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

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

*

* GenerateDataKeyWithoutPlaintext is identical to the GenerateDataKey operation except that it does not return a plaintext copy of the * data key.

*

This operation is useful for systems that need to encrypt data at some point, but not * immediately. When you need to encrypt the data, you call the Decrypt * operation on the encrypted copy of the key.

*

It's also useful in distributed systems with different levels of trust. For example, you * might store encrypted data in containers. One component of your system creates new containers * and stores an encrypted data key with each container. Then, a different component puts the * data into the containers. That component first decrypts the data key, uses the plaintext data * key to encrypt data, puts the encrypted data into the container, and then destroys the * plaintext data key. In this system, the component that creates the containers never sees the * plaintext data key.

*

To request an asymmetric data key pair, use the GenerateDataKeyPair or * GenerateDataKeyPairWithoutPlaintext operations.

*

To generate a data key, you must specify the symmetric encryption KMS key that is used to * encrypt the data key. You cannot use an asymmetric KMS key or a key in a custom key store to * generate a data key. 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 an SM4 data key (China Regions only), specify a KeySpec value of * AES_128 or NumberOfBytes value of 16. The symmetric * encryption key used in China Regions to encrypt your data key is an SM4 encryption key.

*

If the operation succeeds, you will find the encrypted copy of the data key in the * CiphertextBlob field.

*

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.

*

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.

*

* 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:GenerateDataKeyWithoutPlaintext (key * policy)

*

* Related operations: *

* *

* 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, GenerateDataKeyWithoutPlaintextCommand } from "@aws-sdk/client-kms"; // ES Modules import * // const { KMSClient, GenerateDataKeyWithoutPlaintextCommand } = 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 = { // GenerateDataKeyWithoutPlaintextRequest * KeyId: "STRING_VALUE", // required * EncryptionContext: { // EncryptionContextType * "": "STRING_VALUE", * }, * KeySpec: "AES_256" || "AES_128", * NumberOfBytes: Number("int"), * GrantTokens: [ // GrantTokenList * "STRING_VALUE", * ], * DryRun: true || false, * }; * const command = new GenerateDataKeyWithoutPlaintextCommand(input); * const response = await client.send(command); * // { // GenerateDataKeyWithoutPlaintextResponse * // CiphertextBlob: new Uint8Array(), * // KeyId: "STRING_VALUE", * // KeyMaterialId: "STRING_VALUE", * // }; * * ``` * * @param GenerateDataKeyWithoutPlaintextCommandInput - {@link GenerateDataKeyWithoutPlaintextCommandInput} * @returns {@link GenerateDataKeyWithoutPlaintextCommandOutput} * @see {@link GenerateDataKeyWithoutPlaintextCommandInput} for command's `input` shape. * @see {@link GenerateDataKeyWithoutPlaintextCommandOutput} 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. For encapsulating and decapsulating * shared secrets, the KeyUsage must be ENCAPSULATE_DECAPSULATE. 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 an encrypted data key * ```javascript * // The following example generates an encrypted copy of a 256-bit symmetric data encryption key (data key). The data key is encrypted with the specified KMS key. * const input = { * KeyId: "alias/ExampleAlias", * KeySpec: "AES_256" * }; * const command = new GenerateDataKeyWithoutPlaintextCommand(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" * } * *\/ * ``` * * @public */ export declare class GenerateDataKeyWithoutPlaintextCommand extends GenerateDataKeyWithoutPlaintextCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GenerateDataKeyWithoutPlaintextRequest; output: GenerateDataKeyWithoutPlaintextResponse; }; sdk: { input: GenerateDataKeyWithoutPlaintextCommandInput; output: GenerateDataKeyWithoutPlaintextCommandOutput; }; }; }