SignRequest

public struct SignRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

    Declaration

    Swift

    public let grantTokens: [String]?

  • Identifies an asymmetric CMK. AWS KMS uses the private key in the asymmetric CMK to sign the message. The KeyUsage type of the CMK must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with “alias/”. To specify a CMK in a different AWS account, you must use the key ARN or alias ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

    Declaration

    Swift

    public let keyId: String

  • Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide the message digest. If you provide a message, AWS KMS generates a hash digest of the message and then signs it.

    Declaration

    Swift

    public let message: Data

  • Tells AWS KMS whether the value of the Message parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.

    Declaration

    Swift

    public let messageType: MessageType?

  • Specifies the signing algorithm to use when signing the message. Choose an algorithm that is compatible with the type and size of the specified asymmetric CMK.

    Declaration

    Swift

    public let signingAlgorithm: SigningAlgorithmSpec

  • Undocumented

    Declaration

    Swift

    public init(grantTokens: [String]? = nil, keyId: String, message: Data, messageType: MessageType? = nil, signingAlgorithm: SigningAlgorithmSpec)

  • Declaration

    Swift

    public func validate(name: String) throws