Module Values.GenerateDataKeyPairWithoutPlaintextResponseSource

Returns a unique asymmetric data key pair for use outside of KMS. This operation returns a plaintext public key and a copy of the private key that is encrypted under the symmetric encryption KMS key you specify. Unlike GenerateDataKeyPair, this operation does not return a plaintext private key. 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 GenerateDataKeyPairWithoutPlaintext 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. GenerateDataKeyPairWithoutPlaintext returns a unique data key pair for each request. The bytes in the key are not related to the caller or 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. 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:GenerateDataKeyPairWithoutPlaintext (key policy) Related operations: Decrypt Encrypt GenerateDataKey GenerateDataKeyPair GenerateDataKeyWithoutPlaintext Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.

Sourcetype nonrec t = {
  1. 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.

    *)
  2. 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.

    *)
  3. keyId : KeyIdType.t option;
    (*

    The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.

    *)
  4. keyPairSpec : DataKeyPairSpec.t option;
    (*

    The type of data key pair that was generated.

    *)
  5. keyMaterialId : BackingKeyIdType.t option;
    (*

    The identifier of the key material used to encrypt the private key.

    *)
}
Sourcetype nonrec error = [
  1. | `DependencyTimeoutException of DependencyTimeoutException.t
  2. | `DisabledException of DisabledException.t
  3. | `DryRunOperationException of DryRunOperationException.t
  4. | `InvalidGrantTokenException of InvalidGrantTokenException.t
  5. | `InvalidKeyUsageException of InvalidKeyUsageException.t
  6. | `KMSInternalException of KMSInternalException.t
  7. | `KMSInvalidStateException of KMSInvalidStateException.t
  8. | `KeyUnavailableException of KeyUnavailableException.t
  9. | `NotFoundException of NotFoundException.t
  10. | `UnsupportedOperationException of UnsupportedOperationException.t
  11. | `Unknown_operation_error of string * string option
]
Sourceval make : ?privateKeyCiphertextBlob:??? -> ?publicKey:??? -> ?keyId:??? -> ?keyPairSpec:??? -> ?keyMaterialId:??? -> unit -> t
Sourceval 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 ]
Sourceval 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 ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Blob of CiphertextType.t | `Enum of string | `String of KeyIdType.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t