kms/aws.sdk.kotlin.services.kms.model/SignRequest

SignRequest

class SignRequest

Types

Builder

class Builder

Companion

object Companion

Properties

dryRun

val dryRun: Boolean?

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

grantTokens

val grantTokens: List<String>?

A list of grant tokens.

keyId

val keyId: String?

Identifies an asymmetric KMS key. KMS uses the private key in the asymmetric KMS key to sign the message. The KeyUsage type of the KMS key must be SIGN_VERIFY. To find the KeyUsage of a KMS key, use the DescribeKey operation.

message

val message: ByteArray?

Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide a message digest.

messageType

val messageType: MessageType?

Tells KMS whether the value of the Message parameter should be hashed as part of the signing algorithm. Use RAW for unhashed messages; use DIGEST for message digests, which are already hashed; use EXTERNAL_MU for 64-byte representative μ used in ML-DSA signing as defined in NIST FIPS 204 Section 6.2.

signingAlgorithm

val signingAlgorithm: SigningAlgorithmSpec?

Specifies the signing algorithm to use when signing the message.

Functions

copy

inline fun copy(block: SignRequest.Builder.() -> Unit = {}): SignRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String