Module Values.DecryptResponseSource

Decrypts ciphertext that was encrypted by a KMS key using any of the following operations: Encrypt GenerateDataKey GenerateDataKeyPair GenerateDataKeyWithoutPlaintext GenerateDataKeyPairWithoutPlaintext You can use this operation to decrypt ciphertext that was encrypted under a symmetric encryption KMS key or an asymmetric encryption KMS key. When the KMS key is asymmetric, you must specify the KMS key and the encryption algorithm that was used to encrypt the ciphertext. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide. The Decrypt operation also decrypts ciphertext that was encrypted outside of KMS by the public key in an KMS asymmetric KMS key. However, it cannot decrypt symmetric ciphertext produced by other libraries, such as the Amazon Web Services Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with KMS. If the ciphertext was encrypted under a symmetric encryption KMS key, the KeyId parameter is optional. KMS can get this information from metadata that it adds to the symmetric ciphertext blob. This feature adds durability to your implementation by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost track of the key ID. However, specifying the KMS key is always recommended as a best practice. When you use the KeyId parameter to specify a KMS key, KMS only uses the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the Decrypt operation fails. This practice ensures that you use the KMS key that you intend. Whenever possible, use key policies to give users permission to call the Decrypt operation on a particular KMS key, instead of using IAM policies. Otherwise, you might create an IAM policy that gives the user Decrypt permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys in other accounts if the key policy for the cross-account KMS key permits it. If you must use an IAM policy for Decrypt permissions, limit the user to particular KMS keys or particular trusted accounts. For details, see Best practices for IAM policies in the Key Management Service Developer Guide. Decrypt also supports Amazon Web Services Nitro Enclaves and NitroTPM, which provide attested environments in Amazon EC2. To call Decrypt for a 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. Instead of the plaintext data, the response includes the plaintext data encrypted with 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. Cross-account use: Yes. To specify a KMS key in a different Amazon Web Services account, use the key ARN or alias ARN. A short key ID is also acceptable when decrypting symmetric ciphertexts, though using a full key ARN is recommended to be more explicit about the intended KMS key. Required permissions: kms:Decrypt (key policy) Related operations: Encrypt GenerateDataKey GenerateDataKeyPair ReEncrypt Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.

Sourcetype nonrec t = {
  1. keyId : KeyIdType.t option;
    (*

    The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.

    *)
  2. plaintext : PlaintextType.t option;
    (*

    Decrypted plaintext data. 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 Plaintext field is null or empty.

    *)
  3. encryptionAlgorithm : EncryptionAlgorithmSpec.t option;
    (*

    The encryption algorithm that was used to decrypt the ciphertext.

    *)
  4. ciphertextForRecipient : CiphertextType.t option;
    (*

    The plaintext data 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.

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

    The identifier of the key material used to decrypt the ciphertext. This field is present only when the operation uses a symmetric encryption KMS key. This field is omitted if the request includes the Recipient parameter.

    *)
}
Sourcetype nonrec error = [
  1. | `DependencyTimeoutException of DependencyTimeoutException.t
  2. | `DisabledException of DisabledException.t
  3. | `DryRunOperationException of DryRunOperationException.t
  4. | `IncorrectKeyException of IncorrectKeyException.t
  5. | `InvalidCiphertextException of InvalidCiphertextException.t
  6. | `InvalidGrantTokenException of InvalidGrantTokenException.t
  7. | `InvalidKeyUsageException of InvalidKeyUsageException.t
  8. | `KMSInternalException of KMSInternalException.t
  9. | `KMSInvalidStateException of KMSInvalidStateException.t
  10. | `KeyUnavailableException of KeyUnavailableException.t
  11. | `NotFoundException of NotFoundException.t
  12. | `Unknown_operation_error of string * string option
]
Sourceval make : ?keyId:??? -> ?plaintext:??? -> ?encryptionAlgorithm:??? -> ?ciphertextForRecipient:??? -> ?keyMaterialId:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `DependencyTimeoutException of DependencyTimeoutException.t | `DisabledException of DisabledException.t | `DryRunOperationException of DryRunOperationException.t | `IncorrectKeyException of IncorrectKeyException.t | `InvalidCiphertextException of InvalidCiphertextException.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 ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `DependencyTimeoutException of DependencyTimeoutException.t | `DisabledException of DisabledException.t | `DryRunOperationException of DryRunOperationException.t | `IncorrectKeyException of IncorrectKeyException.t | `InvalidCiphertextException of InvalidCiphertextException.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 ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Blob of PlaintextType.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