Class: Aws::KMS::Types::DescribeKeyRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kms/types.rb

Overview

Note:

When making an API call, you may pass DescribeKeyRequest data as a hash:

{
  key_id: "KeyIdType", # required
  grant_tokens: ["GrantTokenType"],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#grant_tokens ⇒ Array<String>

A list of grant tokens.

For more information, see [Grant Tokens] in the *AWS Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token

Returns:

  • (Array<String>) 


576
577
578
579
580
 
# File 'lib/aws-sdk-kms/types.rb', line 576

class DescribeKeyRequest < Struct.new(
  :key_id,
  :grant_tokens)
  include Aws::Structure
end

#key_id ⇒ String

Describes the specified customer master key (CMK).

If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an [AWS managed CMK] and returns its ‘KeyId` and `Arn` in the response.

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.

[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys

Returns:

  • (String) 


576
577
578
579
580
 
# File 'lib/aws-sdk-kms/types.rb', line 576

class DescribeKeyRequest < Struct.new(
  :key_id,
  :grant_tokens)
  include Aws::Structure
end