Values.GenerateDataKeyPairResponseSourceReturns a unique asymmetric data key pair for use outside of KMS. This operation returns a plaintext public key, a plaintext private key, and a copy of the private key that is encrypted under the symmetric encryption KMS key you specify. You can use the data key pair to perform asymmetric cryptography and implement digital signatures outside of KMS. The bytes in the keys are random; they are not related to the caller or to the KMS key that is used to encrypt the private key. You can use the public key that GenerateDataKeyPair returns to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key. To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation. Use the KeyPairSpec parameter to choose an RSA or Elliptic Curve (ECC) data key pair. In China Regions, you can also choose an SM2 data key pair. KMS recommends that you use ECC key pairs for signing, and use RSA and SM2 key pairs for either encryption or signing, but not both. However, KMS cannot enforce any restrictions on the use of data key pairs outside of KMS. If you are using the data key pair to encrypt data, or for any operation where you don't immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation. GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an encrypted private key, but omits the plaintext private key that you need only to decrypt ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use the Decrypt operation to decrypt the encrypted private key in the data key pair. GenerateDataKeyPair returns a unique data key pair for each request. The bytes in the keys are random; they are not related to the caller or the KMS key that is used to encrypt the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in RFC 5280. The private key is a DER-encoded PKCS8 PrivateKeyInfo, as specified in RFC 5958. GenerateDataKeyPair also supports Amazon Web Services Nitro Enclaves, which provide an isolated compute environment in Amazon EC2. To call GenerateDataKeyPair 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. GenerateDataKeyPair returns the public data key and a copy of the private data key encrypted under the specified KMS key, as usual. But instead of a plaintext copy of the private data key (PrivateKeyPlaintext), the response includes a copy of the private 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. 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:GenerateDataKeyPair (key policy) Related operations: Decrypt Encrypt GenerateDataKey GenerateDataKeyPairWithoutPlaintext GenerateDataKeyWithoutPlaintext Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
type nonrec t = {privateKeyCiphertextBlob : CiphertextType.t option;The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
*)privateKeyPlaintext : PlaintextType.t option;The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. If the response includes the CiphertextForRecipient field, the PrivateKeyPlaintext field is null or empty.
*)publicKey : PublicKeyType.t option;The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
*)keyId : KeyIdType.t option;The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.
*)keyPairSpec : DataKeyPairSpec.t option;The type of data key pair that was generated.
*)ciphertextForRecipient : CiphertextType.t option;The plaintext private data key encrypted with the public key from the attestation document. This ciphertext can be decrypted only by using a private key from the attested environment. This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave or NitroTPM. 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.
*)keyMaterialId : BackingKeyIdType.t option;The identifier of the key material used to encrypt the private key.
*)}type nonrec error = [ | `DependencyTimeoutException of DependencyTimeoutException.t| `DisabledException of DisabledException.t| `DryRunOperationException of DryRunOperationException.t| `InvalidGrantTokenException of InvalidGrantTokenException.t| `InvalidKeyUsageException of InvalidKeyUsageException.t| `KMSInternalException of KMSInternalException.t| `KMSInvalidStateException of KMSInvalidStateException.t| `NotFoundException of NotFoundException.t| `UnsupportedOperationException of UnsupportedOperationException.t| `Unknown_operation_error of string * string option ]val error_of_json :
string ->
Yojson.Safe.t ->
[> `DependencyTimeoutException of DependencyTimeoutException.t
| `DisabledException of DisabledException.t
| `DryRunOperationException of DryRunOperationException.t
| `InvalidGrantTokenException of InvalidGrantTokenException.t
| `InvalidKeyUsageException of InvalidKeyUsageException.t
| `KMSInternalException of KMSInternalException.t
| `KMSInvalidStateException of KMSInvalidStateException.t
| `KeyUnavailableException of KeyUnavailableException.t
| `NotFoundException of NotFoundException.t
| `Unknown_operation_error of string * string option
| `UnsupportedOperationException of UnsupportedOperationException.t ]val error_of_xml :
string ->
Awso.Xml.t ->
[> `DependencyTimeoutException of DependencyTimeoutException.t
| `DisabledException of DisabledException.t
| `DryRunOperationException of DryRunOperationException.t
| `InvalidGrantTokenException of InvalidGrantTokenException.t
| `InvalidKeyUsageException of InvalidKeyUsageException.t
| `KMSInternalException of KMSInternalException.t
| `KMSInvalidStateException of KMSInvalidStateException.t
| `KeyUnavailableException of KeyUnavailableException.t
| `NotFoundException of NotFoundException.t
| `Unknown_operation_error of string * string option
| `UnsupportedOperationException of UnsupportedOperationException.t ]val to_value :
t ->
[> `Structure of
(string
* [> `Blob of CiphertextType.t
| `Enum of string
| `String of KeyIdType.t ])
list ]