Network.AWS.KMS.DisableKey

Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.

For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide .

Creating a Request

disableKey

Arguments

:: Text

dkKeyId

-> DisableKey

Creates a value of DisableKey with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dkKeyId - A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey .

data DisableKey

See: disableKey smart constructor.

Instances

Eq DisableKey

Methods

(==) :: DisableKey -> DisableKey -> Bool

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

Data DisableKey

Methods

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

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

toConstr :: DisableKey -> Constr

dataTypeOf :: DisableKey -> DataType

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

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

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

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

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

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

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

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

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

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

Read DisableKey

Methods

readsPrec :: Int -> ReadS DisableKey

readList :: ReadS [DisableKey]

readPrec :: ReadPrec DisableKey

readListPrec :: ReadPrec [DisableKey]

Show DisableKey

Methods

showsPrec :: Int -> DisableKey -> ShowS

show :: DisableKey -> String

showList :: [DisableKey] -> ShowS

Generic DisableKey

Associated Types

type Rep DisableKey :: * -> *

Methods

from :: DisableKey -> Rep DisableKey x

to :: Rep DisableKey x -> DisableKey

Hashable DisableKey

Methods

hashWithSalt :: Int -> DisableKey -> Int

hash :: DisableKey -> Int

ToJSON DisableKey

Methods

toJSON :: DisableKey -> Value

toEncoding :: DisableKey -> Encoding

toJSONList :: [DisableKey] -> Value

toEncodingList :: [DisableKey] -> Encoding

NFData DisableKey

Methods

rnf :: DisableKey -> ()

AWSRequest DisableKey

Associated Types

type Rs DisableKey :: *

Methods

request :: DisableKey -> Request DisableKey

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

ToHeaders DisableKey

Methods

toHeaders :: DisableKey -> [Header]

ToPath DisableKey

Methods

toPath :: DisableKey -> ByteString

ToQuery DisableKey

Methods

toQuery :: DisableKey -> QueryString

type Rep DisableKey

type Rep DisableKey = D1 * (MetaData "DisableKey" "Network.AWS.KMS.DisableKey" "amazonka-kms-1.6.0-6a1SDMHmleyARI8mxMgB7S" True) (C1 * (MetaCons "DisableKey'" PrefixI True) (S1 * (MetaSel (Just Symbol "_dkKeyId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

type Rs DisableKey

type Rs DisableKey = DisableKeyResponse

Request Lenses

dkKeyId :: Lens' DisableKey Text

A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey .

Destructuring the Response

disableKeyResponse :: DisableKeyResponse

Creates a value of DisableKeyResponse with the minimum fields required to make a request.

data DisableKeyResponse

See: disableKeyResponse smart constructor.

Instances

Eq DisableKeyResponse

Methods

(==) :: DisableKeyResponse -> DisableKeyResponse -> Bool

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

Data DisableKeyResponse

Methods

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

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

toConstr :: DisableKeyResponse -> Constr

dataTypeOf :: DisableKeyResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read DisableKeyResponse

Methods

readsPrec :: Int -> ReadS DisableKeyResponse

readList :: ReadS [DisableKeyResponse]

readPrec :: ReadPrec DisableKeyResponse

readListPrec :: ReadPrec [DisableKeyResponse]

Show DisableKeyResponse

Methods

showsPrec :: Int -> DisableKeyResponse -> ShowS

show :: DisableKeyResponse -> String

showList :: [DisableKeyResponse] -> ShowS

Generic DisableKeyResponse

Associated Types

type Rep DisableKeyResponse :: * -> *

Methods

from :: DisableKeyResponse -> Rep DisableKeyResponse x

to :: Rep DisableKeyResponse x -> DisableKeyResponse

NFData DisableKeyResponse

Methods

rnf :: DisableKeyResponse -> ()

type Rep DisableKeyResponse

type Rep DisableKeyResponse = D1 * (MetaData "DisableKeyResponse" "Network.AWS.KMS.DisableKey" "amazonka-kms-1.6.0-6a1SDMHmleyARI8mxMgB7S" False) (C1 * (MetaCons "DisableKeyResponse'" PrefixI False) (U1 *))