Struct VerifyMacOutput

#[non_exhaustive]
pub struct VerifyMacOutput {
    pub key_id: Option<String>,
    pub mac_valid: bool,
    pub mac_algorithm: Option<MacAlgorithmSpec>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key_id: Option<String>

The HMAC KMS key used in the verification.

mac_valid: bool

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.

mac_algorithm: Option<MacAlgorithmSpec>

The MAC algorithm used in the verification.

Implementations

impl VerifyMacOutput

pub fn key_id(&self) -> Option<&str>

The HMAC KMS key used in the verification.

pub fn mac_valid(&self) -> bool

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.

pub fn mac_algorithm(&self) -> Option<&MacAlgorithmSpec>

The MAC algorithm used in the verification.

impl VerifyMacOutput

pub fn builder() -> VerifyMacOutputBuilder

Creates a new builder-style object to manufacture VerifyMacOutput.

Trait Implementations

impl Clone for VerifyMacOutput

fn clone(&self) -> VerifyMacOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VerifyMacOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for VerifyMacOutput

fn eq(&self, other: &VerifyMacOutput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for VerifyMacOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for VerifyMacOutput