Module Values.VerifyMacResponseSource

Verifies the hash-based message authentication code (HMAC) for a specified message, HMAC KMS key, and MAC algorithm. To verify the HMAC, VerifyMac computes an HMAC using the message, HMAC KMS key, and MAC algorithm that you specify, and compares the computed HMAC to the HMAC that you specify. If the HMACs are identical, the verification succeeds; otherwise, it fails. Verification indicates that the message hasn't changed since the HMAC was calculated, and the specified key was used to generate and verify the HMAC. HMAC KMS keys and the HMAC algorithms that KMS uses conform to industry standards defined in RFC 2104. This operation is part of KMS support for HMAC KMS keys. For details, see HMAC keys 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 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:VerifyMac (key policy) Related operations: GenerateMac 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 HMAC KMS key used in the verification.

    *)
  2. macValid : BooleanType.t option;
    (*

    A Boolean value that indicates whether the HMAC was verified. A value of True indicates that the HMAC (Mac) was generated with the specified Message, HMAC KMS key (KeyID) and MacAlgorithm.. If the HMAC is not verified, the VerifyMac operation fails with a KMSInvalidMacException exception. This exception indicates that one or more of the inputs changed since the HMAC was computed.

    *)
  3. macAlgorithm : MacAlgorithmSpec.t option;
    (*

    The MAC algorithm used in the verification.

    *)
}
Sourcetype nonrec error = [
  1. | `DisabledException of DisabledException.t
  2. | `DryRunOperationException of DryRunOperationException.t
  3. | `InvalidGrantTokenException of InvalidGrantTokenException.t
  4. | `InvalidKeyUsageException of InvalidKeyUsageException.t
  5. | `KMSInternalException of KMSInternalException.t
  6. | `KMSInvalidMacException of KMSInvalidMacException.t
  7. | `KMSInvalidStateException of KMSInvalidStateException.t
  8. | `KeyUnavailableException of KeyUnavailableException.t
  9. | `NotFoundException of NotFoundException.t
  10. | `Unknown_operation_error of string * string option
]
Sourceval make : ?keyId:??? -> ?macValid:??? -> ?macAlgorithm:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `DisabledException of DisabledException.t | `DryRunOperationException of DryRunOperationException.t | `InvalidGrantTokenException of InvalidGrantTokenException.t | `InvalidKeyUsageException of InvalidKeyUsageException.t | `KMSInternalException of KMSInternalException.t | `KMSInvalidMacException of KMSInvalidMacException.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 -> [> `DisabledException of DisabledException.t | `DryRunOperationException of DryRunOperationException.t | `InvalidGrantTokenException of InvalidGrantTokenException.t | `InvalidKeyUsageException of InvalidKeyUsageException.t | `KMSInternalException of KMSInternalException.t | `KMSInvalidMacException of KMSInvalidMacException.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 * [> `Boolean of BooleanType.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