/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::KMS::Verify

NAME

Paws::KMS::Verify - Arguments for method Verify on Paws::KMS

DESCRIPTION

This class represents the parameters used for calling the method Verify on the AWS Key Management Service service. Use the attributes of this class as arguments to method Verify.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to Verify.

SYNOPSIS

my $kms = Paws->service('KMS');
my $VerifyResponse = $kms->Verify(
  KeyId            => 'MyKeyIdType',
  Message          => 'BlobPlaintextType',
  Signature        => 'BlobCiphertextType',
  SigningAlgorithm => 'RSASSA_PSS_SHA_256',
  GrantTokens      => [
    'MyGrantTokenType', ...    # min: 1, max: 8192
  ],    # OPTIONAL
  MessageType => 'RAW',    # OPTIONAL
);

# Results:
my $KeyId            = $VerifyResponse->KeyId;
my $SignatureValid   = $VerifyResponse->SignatureValid;
my $SigningAlgorithm = $VerifyResponse->SigningAlgorithm;

# Returns a L<Paws::KMS::VerifyResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/kms/Verify

ATTRIBUTES

GrantTokens => ArrayRef[Str|Undef]

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 (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) in the AWS Key Management Service Developer Guide.

REQUIRED KeyId => Str

Identifies the asymmetric CMK that will be used to verify the signature. This must be the same CMK that was used to generate the signature. If you specify a different CMK, the signature verification fails.

To specify a CMK, use its key ID, key 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.

REQUIRED Message => Str

Specifies the message that was signed. You can submit a raw message of up to 4096 bytes, or a hash digest of the message. If you submit a digest, use the MessageType parameter with a value of DIGEST.

If the message specified here is different from the message that was signed, the signature verification fails. A message and its hash digest are considered to be the same message.

MessageType => Str

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.

Use the DIGEST value only when the value of the Message parameter is a message digest. If you use the DIGEST value with a raw message, the security of the verification operation can be compromised.

Valid values are: "RAW", "DIGEST"

REQUIRED Signature => Str

The signature that the Sign operation generated.

REQUIRED SigningAlgorithm => Str

The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.

Valid values are: "RSASSA_PSS_SHA_256", "RSASSA_PSS_SHA_384", "RSASSA_PSS_SHA_512", "RSASSA_PKCS1_V1_5_SHA_256", "RSASSA_PKCS1_V1_5_SHA_384", "RSASSA_PKCS1_V1_5_SHA_512", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512"

SEE ALSO

This class forms part of Paws, documenting arguments for method Verify in Paws::KMS

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues