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

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $kms = Paws->service('KMS');
my $GetPublicKeyResponse = $kms->GetPublicKey(
  KeyId       => 'MyKeyIdType',
  GrantTokens => [
    'MyGrantTokenType', ...    # min: 1, max: 8192
  ],    # OPTIONAL
);

# Results:
my $CustomerMasterKeySpec = $GetPublicKeyResponse->CustomerMasterKeySpec;
my $EncryptionAlgorithms  = $GetPublicKeyResponse->EncryptionAlgorithms;
my $KeyId                 = $GetPublicKeyResponse->KeyId;
my $KeyUsage              = $GetPublicKeyResponse->KeyUsage;
my $PublicKey             = $GetPublicKeyResponse->PublicKey;
my $SigningAlgorithms     = $GetPublicKeyResponse->SigningAlgorithms;

# Returns a L<Paws::KMS::GetPublicKeyResponse> 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/GetPublicKey

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 includes the public key.

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetPublicKey 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