Skip to content

VerifyMacResponse

Source code in docs_src/capo_kms/types/verify_mac_response.py 
13
14
15
16
17
18
19
class VerifyMacResponse(TypedDict, closed=True):
    key_id: NotRequired["capo_kms.types.key_id_type.KeyIdType"]
    """<p>The HMAC KMS key used in the verification.</p>"""
    mac_valid: "capo_kms.types.boolean_type.BooleanType"
    """<p>A Boolean value that indicates whether the HMAC was verified. A value of <code>True</code> indicates that the HMAC (<code>Mac</code>) was generated with the specified <code>Message</code>, HMAC KMS key (<code>KeyID</code>) and <code>MacAlgorithm.</code>.</p> <p>If the HMAC is not verified, the <code>VerifyMac</code> operation fails with a <code>KMSInvalidMacException</code> exception. This exception indicates that one or more of the inputs changed since the HMAC was computed.</p>"""
    mac_algorithm: NotRequired["capo_kms.types.mac_algorithm_spec.MacAlgorithmSpec"]
    """<p>The MAC algorithm used in the verification.</p>"""

key_id instance-attribute 

key_id: NotRequired[KeyIdType]

The HMAC KMS key used in the verification.

mac_algorithm instance-attribute 

mac_algorithm: NotRequired[MacAlgorithmSpec]

The MAC algorithm used in the verification.

mac_valid instance-attribute 

mac_valid: BooleanType

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.