| Copyright | (c) 2013-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.KMS.DescribeKey
Description
Provides detailed information about the specified customer master key.
- describeKey :: Text -> DescribeKey
- data DescribeKey
- dGrantTokens :: Lens' DescribeKey [Text]
- dKeyId :: Lens' DescribeKey Text
- describeKeyResponse :: Int -> DescribeKeyResponse
- data DescribeKeyResponse
- dkrsKeyMetadata :: Lens' DescribeKeyResponse (Maybe KeyMetadata)
- dkrsResponseStatus :: Lens' DescribeKeyResponse Int
Creating a Request
Arguments
| :: Text | |
| -> DescribeKey |
Creates a value of DescribeKey with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeKey Source
See: describeKey smart constructor.
Instances
Request Lenses
dGrantTokens :: Lens' DescribeKey [Text] Source
A list of grant tokens.
For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.
dKeyId :: Lens' DescribeKey Text Source
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
Destructuring the Response
Arguments
| :: Int | |
| -> DescribeKeyResponse |
Creates a value of DescribeKeyResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeKeyResponse Source
See: describeKeyResponse smart constructor.
Response Lenses
dkrsKeyMetadata :: Lens' DescribeKeyResponse (Maybe KeyMetadata) Source
Metadata associated with the key.
dkrsResponseStatus :: Lens' DescribeKeyResponse Int Source
The response status code.