Class: Aws::KMS::Types::VerifyMacRequest

Inherits:

Struct

• Object
• Struct
• Aws::KMS::Types::VerifyMacRequest

Includes:

Structure

Defined in:

lib/aws-sdk-kms/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:message]

Instance Attribute Summary

• #dry_run ⇒ Boolean

  Checks if your request will succeed.

• #grant_tokens ⇒ Array<String>

  A list of grant tokens.

• #key_id ⇒ String

  The KMS key that will be used in the verification.

• #mac ⇒ String

  The HMAC to verify.

• #mac_algorithm ⇒ String

  The MAC algorithm that will be used in the verification.

• #message ⇒ String

  The message that will be used in the verification.

Instance Attribute Details

#dry_run ⇒ Boolean

Checks if your request will succeed. ‘DryRun` is an optional parameter.

To learn more about how to use this parameter, see [Testing your KMS API calls] in the *Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html

Returns:

• (Boolean)

# File 'lib/aws-sdk-kms/types.rb', line 6285

class VerifyMacRequest < Struct.new(
  :message,
  :key_id,
  :mac_algorithm,
  :mac,
  :grant_tokens,
  :dry_run)
  SENSITIVE = [:message]
  include Aws::Structure
end

#grant_tokens ⇒ Array<String>

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved *eventual consistency*. For more information, see [Grant token] and [Using a grant token] in the *Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token [2]: docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token

Returns:

• (Array<String>)

# File 'lib/aws-sdk-kms/types.rb', line 6285

class VerifyMacRequest < Struct.new(
  :message,
  :key_id,
  :mac_algorithm,
  :mac,
  :grant_tokens,
  :dry_run)
  SENSITIVE = [:message]
  include Aws::Structure
end

#key_id ⇒ String

The KMS key that will be used in the verification.

Enter a key ID of the KMS key that was used to generate the HMAC. If you identify a different KMS key, the ‘VerifyMac` operation fails.

Returns:

• (String)

# File 'lib/aws-sdk-kms/types.rb', line 6285

class VerifyMacRequest < Struct.new(
  :message,
  :key_id,
  :mac_algorithm,
  :mac,
  :grant_tokens,
  :dry_run)
  SENSITIVE = [:message]
  include Aws::Structure
end

#mac ⇒ String

The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you specified the same message, HMAC KMS key, and MAC algorithm as the values specified in this request.

Returns:

• (String)

# File 'lib/aws-sdk-kms/types.rb', line 6285

class VerifyMacRequest < Struct.new(
  :message,
  :key_id,
  :mac_algorithm,
  :mac,
  :grant_tokens,
  :dry_run)
  SENSITIVE = [:message]
  include Aws::Structure
end

#mac_algorithm ⇒ String

The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to compute the HMAC. This algorithm must be supported by the HMAC KMS key identified by the ‘KeyId` parameter.

Returns:

• (String)

# File 'lib/aws-sdk-kms/types.rb', line 6285

class VerifyMacRequest < Struct.new(
  :message,
  :key_id,
  :mac_algorithm,
  :mac,
  :grant_tokens,
  :dry_run)
  SENSITIVE = [:message]
  include Aws::Structure
end

#message ⇒ String

The message that will be used in the verification. Enter the same message that was used to generate the HMAC.

GenerateMac and ‘VerifyMac` do not provide special handling for message digests. If you generated an HMAC for a hash digest of a message, you must verify the HMAC for the same hash digest.

Returns:

• (String)

# File 'lib/aws-sdk-kms/types.rb', line 6285

class VerifyMacRequest < Struct.new(
  :message,
  :key_id,
  :mac_algorithm,
  :mac,
  :grant_tokens,
  :dry_run)
  SENSITIVE = [:message]
  include Aws::Structure
end