Class: Aws::KMS::Types::DescribeKeyRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::KMS::Types::DescribeKeyRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-kms/types.rb
Overview
When making an API call, you may pass DescribeKeyRequest data as a hash:
{
key_id: "KeyIdType", # required
grant_tokens: ["GrantTokenType"],
}
Instance Attribute Summary collapse
-
#grant_tokens ⇒ Array<String>
A list of grant tokens.
-
#key_id ⇒ String
A unique identifier for the customer master key.
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
546 547 548 549 550 |
# File 'lib/aws-sdk-kms/types.rb', line 546 class DescribeKeyRequest < Struct.new( :key_id, :grant_tokens) include Aws::Structure end |
#key_id ⇒ String
A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by “alias/”.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
-
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
Alias Name Example - alias/MyAliasName
546 547 548 549 550 |
# File 'lib/aws-sdk-kms/types.rb', line 546 class DescribeKeyRequest < Struct.new( :key_id, :grant_tokens) include Aws::Structure end |