kms_get_public_key: Returns the public key of an asymmetric KMS key

In paws.security.identity: 'Amazon Web Services' Security, Identity, & Compliance Services

Returns the public key of an asymmetric KMS key

Description

Returns the public key of an asymmetric KMS key. Unlike the private key of a asymmetric KMS key, which never leaves KMS unencrypted, callers with kms:GetPublicKey permission can download the public key of an asymmetric KMS key. You can share the public key to allow others to encrypt messages and verify signatures outside of KMS. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

See https://www.paws-r-sdk.com/docs/kms_get_public_key/ for full documentation.

Usage

kms_get_public_key(KeyId, GrantTokens = NULL)

Arguments

KeyId

[required] Identifies the asymmetric KMS key that includes the public key. To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services 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 KMS key, use list_keys or describe_key. To get the alias name and alias ARN, use list_aliases.

GrantTokens

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.

paws.security.identity documentation built on Sept. 12, 2023, 1:10 a.m.