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"],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#grant_tokensArray<String>

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*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token [2]: docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token

Returns:

  • (Array<String>)

1568
1569
1570
1571
1572
1573
# File 'lib/aws-sdk-kms/types.rb', line 1568

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

#key_idString

Describes the specified KMS key.

If you specify a predefined Amazon Web Services alias (an Amazon Web Services alias with no key ID), KMS associates the alias with an

Amazon Web Services managed key][1

and returns its `KeyId` and

`Arn` in the response.

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 ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

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

Returns:

  • (String)

1568
1569
1570
1571
1572
1573
# File 'lib/aws-sdk-kms/types.rb', line 1568

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