Network.AWS.KMS.DescribeKey

Provides detailed information about the specified customer master key (CMK).

To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Creating a Request

describeKey

Arguments

:: Text

dKeyId

-> 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:

• dGrantTokens - A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide .
• dKeyId - A unique identifier for the customer master key (CMK). 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:key1234abcd-12ab-34cd-56ef-1234567890ab * Alias name: aliasExampleAlias * Alias ARN: arn:aws:kms:us-east-2:111122223333:aliasExampleAlias@ 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 .

data DescribeKey

See: describeKey smart constructor.

Instances

Eq DescribeKey

Defined in Network.AWS.KMS.DescribeKey

Methods

(==) :: DescribeKey -> DescribeKey -> Bool

(/=) :: DescribeKey -> DescribeKey -> Bool

Data DescribeKey

Defined in Network.AWS.KMS.DescribeKey

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeKey -> c DescribeKey

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeKey

toConstr :: DescribeKey -> Constr

dataTypeOf :: DescribeKey -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeKey)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeKey)

gmapT :: (forall b. Data b => b -> b) -> DescribeKey -> DescribeKey

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeKey -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeKey -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeKey -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeKey -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeKey -> m DescribeKey

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeKey -> m DescribeKey

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeKey -> m DescribeKey

Read DescribeKey

Defined in Network.AWS.KMS.DescribeKey

Methods

readsPrec :: Int -> ReadS DescribeKey

readList :: ReadS [DescribeKey]

readPrec :: ReadPrec DescribeKey

readListPrec :: ReadPrec [DescribeKey]

Show DescribeKey

Defined in Network.AWS.KMS.DescribeKey

Methods

showsPrec :: Int -> DescribeKey -> ShowS

show :: DescribeKey -> String

showList :: [DescribeKey] -> ShowS

Generic DescribeKey

Defined in Network.AWS.KMS.DescribeKey

Associated Types

type Rep DescribeKey :: Type -> Type

Methods

from :: DescribeKey -> Rep DescribeKey x

to :: Rep DescribeKey x -> DescribeKey

Hashable DescribeKey

Defined in Network.AWS.KMS.DescribeKey

Methods

hashWithSalt :: Int -> DescribeKey -> Int

hash :: DescribeKey -> Int

ToJSON DescribeKey

Defined in Network.AWS.KMS.DescribeKey

Methods

toJSON :: DescribeKey -> Value

toEncoding :: DescribeKey -> Encoding

toJSONList :: [DescribeKey] -> Value

toEncodingList :: [DescribeKey] -> Encoding

AWSRequest DescribeKey

Defined in Network.AWS.KMS.DescribeKey

Associated Types

type Rs DescribeKey :: Type

Methods

request :: DescribeKey -> Request DescribeKey

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeKey -> ClientResponse -> m (Response DescribeKey)

ToHeaders DescribeKey

Defined in Network.AWS.KMS.DescribeKey

Methods

toHeaders :: DescribeKey -> [Header]

ToPath DescribeKey

Defined in Network.AWS.KMS.DescribeKey

Methods

toPath :: DescribeKey -> ByteString

ToQuery DescribeKey

Defined in Network.AWS.KMS.DescribeKey

Methods

toQuery :: DescribeKey -> QueryString

NFData DescribeKey

Defined in Network.AWS.KMS.DescribeKey

Methods

rnf :: DescribeKey -> ()

type Rep DescribeKey

Defined in Network.AWS.KMS.DescribeKey

type Rep DescribeKey = D1 (MetaData "DescribeKey" "Network.AWS.KMS.DescribeKey" "amazonka-kms-1.6.1-1UDljZYfeha1jjHbbMax4v" False) (C1 (MetaCons "DescribeKey'" PrefixI True) (S1 (MetaSel (Just "_dGrantTokens") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_dKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))

type Rs DescribeKey

Defined in Network.AWS.KMS.DescribeKey

type Rs DescribeKey = DescribeKeyResponse

Request Lenses

dGrantTokens :: Lens' DescribeKey [Text]

A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide .

dKeyId :: Lens' DescribeKey Text

A unique identifier for the customer master key (CMK). 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:key1234abcd-12ab-34cd-56ef-1234567890ab * Alias name: aliasExampleAlias * Alias ARN: arn:aws:kms:us-east-2:111122223333:aliasExampleAlias@ 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 .

Destructuring the Response

describeKeyResponse

Arguments

:: Int

dkrsResponseStatus

-> 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:

• dkrsKeyMetadata - Metadata associated with the key.
• dkrsResponseStatus - -- | The response status code.

data DescribeKeyResponse

See: describeKeyResponse smart constructor.

Instances

Eq DescribeKeyResponse

Defined in Network.AWS.KMS.DescribeKey

Methods

(==) :: DescribeKeyResponse -> DescribeKeyResponse -> Bool

(/=) :: DescribeKeyResponse -> DescribeKeyResponse -> Bool

Data DescribeKeyResponse

Defined in Network.AWS.KMS.DescribeKey

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeKeyResponse -> c DescribeKeyResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeKeyResponse

toConstr :: DescribeKeyResponse -> Constr

dataTypeOf :: DescribeKeyResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeKeyResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeKeyResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeKeyResponse -> DescribeKeyResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeKeyResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeKeyResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeKeyResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeKeyResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeKeyResponse -> m DescribeKeyResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeKeyResponse -> m DescribeKeyResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeKeyResponse -> m DescribeKeyResponse

Read DescribeKeyResponse

Defined in Network.AWS.KMS.DescribeKey

Methods

readsPrec :: Int -> ReadS DescribeKeyResponse

readList :: ReadS [DescribeKeyResponse]

readPrec :: ReadPrec DescribeKeyResponse

readListPrec :: ReadPrec [DescribeKeyResponse]

Show DescribeKeyResponse

Defined in Network.AWS.KMS.DescribeKey

Methods

showsPrec :: Int -> DescribeKeyResponse -> ShowS

show :: DescribeKeyResponse -> String

showList :: [DescribeKeyResponse] -> ShowS

Generic DescribeKeyResponse

Defined in Network.AWS.KMS.DescribeKey

Associated Types

type Rep DescribeKeyResponse :: Type -> Type

Methods

from :: DescribeKeyResponse -> Rep DescribeKeyResponse x

to :: Rep DescribeKeyResponse x -> DescribeKeyResponse

NFData DescribeKeyResponse

Defined in Network.AWS.KMS.DescribeKey

Methods

rnf :: DescribeKeyResponse -> ()

type Rep DescribeKeyResponse

Defined in Network.AWS.KMS.DescribeKey

type Rep DescribeKeyResponse = D1 (MetaData "DescribeKeyResponse" "Network.AWS.KMS.DescribeKey" "amazonka-kms-1.6.1-1UDljZYfeha1jjHbbMax4v" False) (C1 (MetaCons "DescribeKeyResponse'" PrefixI True) (S1 (MetaSel (Just "_dkrsKeyMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe KeyMetadata)) :*: S1 (MetaSel (Just "_dkrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

dkrsKeyMetadata :: Lens' DescribeKeyResponse (Maybe KeyMetadata)

Metadata associated with the key.

dkrsResponseStatus :: Lens' DescribeKeyResponse Int

• - | The response status code.