kms_generate_mac: Generates a hash-based message authentication code (HMAC) for...

In paws.security.identity: 'Amazon Web Services' Security, Identity, & Compliance Services

Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS key and a MAC algorithm that the key supports

Description

Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS key and a MAC algorithm that the key supports. HMAC KMS keys and the HMAC algorithms that KMS uses conform to industry standards defined in RFC 2104.

See https://www.paws-r-sdk.com/docs/kms_generate_mac/ for full documentation.

Usage

kms_generate_mac(
  Message,
  KeyId,
  MacAlgorithm,
  GrantTokens = NULL,
  DryRun = NULL
)

Arguments

Message	[required] The message to be hashed. Specify a message of up to 4,096 bytes. generate_mac and verify_mac 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.
KeyId	[required] 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 describe_key operation and see the KeySpec field in the response.
MacAlgorithm	[required] 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 describe_key operation and see the MacAlgorithms field in the describe_key response.
GrantTokens	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.
DryRun	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.

paws.security.identity documentation built on Sept. 12, 2024, 6:30 a.m.