Class: Aws::KMS::Types::GenerateMacRequest

Inherits:

Struct

• Object
• Struct
• Aws::KMS::Types::GenerateMacRequest

Defined in:

gems/aws-sdk-kms/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 HMAC KMS key to use in the operation.

• #mac_algorithm ⇒ String

  The MAC algorithm used in the operation.

• #message ⇒ String

  The message to be hashed.

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.

Returns:

• (Boolean)

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

class GenerateMacRequest < Struct.new(
  :message,
  :key_id,
  :mac_algorithm,
  :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.

Returns:

• (Array<String>)

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

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

#key_id ⇒ String

The HMAC KMS key to use in the operation. The MAC algorithm computes the HMAC for the message and the key as described in RFC 2104.

To identify an HMAC KMS key, use the DescribeKey operation and see the KeySpec field in the response.

Returns:

• (String)

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

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

#mac_algorithm ⇒ String

The MAC algorithm used in the operation.

The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that your HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms field in the DescribeKey response.

Returns:

• (String)

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

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

#message ⇒ String

The message to be hashed. Specify a message of up to 4,096 bytes.

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

Returns:

• (String)

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

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