AWSKMSGenerateMacRequest

Objective-C

@interface AWSKMSGenerateMacRequest

Swift

class AWSKMSGenerateMacRequest

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable dryRun;

    Swift

    var dryRun: NSNumber? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable grantTokens;

    Swift

    var grantTokens: [String]? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable keyId;

    Swift

    var keyId: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSKMSMacAlgorithmSpec macAlgorithm;

    Swift

    var macAlgorithm: AWSKMSMacAlgorithmSpec { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSData *_Nullable message;

    Swift

    var message: Data? { get set }