Skip to content

VerifyResponse

Source code in docs_src/capo_kms/types/verify_response.py
class VerifyResponse(TypedDict, closed=True):
    key_id: NotRequired["capo_kms.types.key_id_type.KeyIdType"]
    """<p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the asymmetric KMS key that was used to verify the signature.</p>"""
    signature_valid: "capo_kms.types.boolean_type.BooleanType"
    """<p>A Boolean value that indicates whether the signature was verified. A value of <code>True</code> indicates that the <code>Signature</code> was produced by signing the <code>Message</code> with the specified <code>KeyID</code> and <code>SigningAlgorithm.</code> If the signature is not verified, the <code>Verify</code> operation fails with a <code>KMSInvalidSignatureException</code> exception. </p>"""
    signing_algorithm: NotRequired[
        "capo_kms.types.signing_algorithm_spec.SigningAlgorithmSpec"
    ]
    """<p>The signing algorithm that was used to verify the signature.</p>"""

key_id instance-attribute

key_id: NotRequired[KeyIdType]

The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to verify the signature.

signature_valid instance-attribute

signature_valid: BooleanType

A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.

signing_algorithm instance-attribute

signing_algorithm: NotRequired[SigningAlgorithmSpec]

The signing algorithm that was used to verify the signature.