Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.KMS.DisableKey

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Sets the state of a KMS key to disabled. This change temporarily prevents use of the KMS key for cryptographic operations.

For more information about how key state affects the use of a KMS key, see Key state: Effect on your KMS key in the /Key Management Service Developer Guide/ .

The KMS key that you use for this operation must be in a compatible key state. For details, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:DisableKey (key policy)

Related operations: EnableKey

Synopsis

data DisableKey = DisableKey' {
- keyId :: Text
}
newDisableKey :: Text -> DisableKey
disableKey_keyId :: Lens' DisableKey Text
data DisableKeyResponse = DisableKeyResponse' {
}
newDisableKeyResponse :: DisableKeyResponse

Creating a Request

data DisableKey Source #

See: newDisableKey smart constructor.

Constructors

DisableKey'
Fields keyId :: Text Identifies the KMS key to disable. Specify the key ID or key ARN of the KMS key. 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 KMS key, use ListKeys or DescribeKey.

Instances

Instances details

Eq DisableKey Source #
Instance details Defined in Amazonka.KMS.DisableKey Methods (==) :: DisableKey -> DisableKey -> Bool # (/=) :: DisableKey -> DisableKey -> Bool #
Read DisableKey Source #
Instance details Defined in Amazonka.KMS.DisableKey Methods readsPrec :: Int -> ReadS DisableKey # readList :: ReadS [DisableKey] # readPrec :: ReadPrec DisableKey # readListPrec :: ReadPrec [DisableKey] #
Show DisableKey Source #
Instance details Defined in Amazonka.KMS.DisableKey Methods showsPrec :: Int -> DisableKey -> ShowS # show :: DisableKey -> String # showList :: [DisableKey] -> ShowS #
Generic DisableKey Source #
Instance details Defined in Amazonka.KMS.DisableKey Associated Types type Rep DisableKey :: Type -> Type # Methods from :: DisableKey -> Rep DisableKey x # to :: Rep DisableKey x -> DisableKey #
NFData DisableKey Source #
Instance details Defined in Amazonka.KMS.DisableKey Methods rnf :: DisableKey -> () #
Hashable DisableKey Source #
Instance details Defined in Amazonka.KMS.DisableKey Methods hashWithSalt :: Int -> DisableKey -> Int # hash :: DisableKey -> Int #
ToJSON DisableKey Source #
Instance details Defined in Amazonka.KMS.DisableKey Methods toJSON :: DisableKey -> Value # toEncoding :: DisableKey -> Encoding # toJSONList :: [DisableKey] -> Value # toEncodingList :: [DisableKey] -> Encoding #
AWSRequest DisableKey Source #
Instance details Defined in Amazonka.KMS.DisableKey Associated Types type AWSResponse DisableKey # Methods request :: DisableKey -> Request DisableKey # response :: MonadResource m => Logger -> Service -> Proxy DisableKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DisableKey))) #
ToHeaders DisableKey Source #
Instance details Defined in Amazonka.KMS.DisableKey Methods toHeaders :: DisableKey -> [Header] #
ToPath DisableKey Source #
Instance details Defined in Amazonka.KMS.DisableKey Methods toPath :: DisableKey -> ByteString #
ToQuery DisableKey Source #
Instance details Defined in Amazonka.KMS.DisableKey Methods toQuery :: DisableKey -> QueryString #
type Rep DisableKey Source #
Instance details Defined in Amazonka.KMS.DisableKey type Rep DisableKey = D1 ('MetaData "DisableKey" "Amazonka.KMS.DisableKey" "libZSservicesZSamazonka-kmsZSamazonka-kms" 'False) (C1 ('MetaCons "DisableKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DisableKey Source #
Instance details Defined in Amazonka.KMS.DisableKey type AWSResponse DisableKey = DisableKeyResponse

newDisableKey Source #

Arguments

:: Text	`$sel:keyId:DisableKey'`
-> DisableKey

Create a value of DisableKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:keyId:DisableKey', disableKey_keyId - Identifies the KMS key to disable.

Specify the key ID or key ARN of the KMS key.

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 KMS key, use ListKeys or DescribeKey.

Request Lenses

disableKey_keyId :: Lens' DisableKey Text Source #

Identifies the KMS key to disable.

Specify the key ID or key ARN of the KMS key.

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 KMS key, use ListKeys or DescribeKey.

Destructuring the Response

data DisableKeyResponse Source #

See: newDisableKeyResponse smart constructor.

Constructors

DisableKeyResponse'

Instances

Instances details

Eq DisableKeyResponse Source #
Instance details Defined in Amazonka.KMS.DisableKey Methods (==) :: DisableKeyResponse -> DisableKeyResponse -> Bool # (/=) :: DisableKeyResponse -> DisableKeyResponse -> Bool #
Read DisableKeyResponse Source #
Instance details Defined in Amazonka.KMS.DisableKey Methods readsPrec :: Int -> ReadS DisableKeyResponse # readList :: ReadS [DisableKeyResponse] # readPrec :: ReadPrec DisableKeyResponse # readListPrec :: ReadPrec [DisableKeyResponse] #
Show DisableKeyResponse Source #
Instance details Defined in Amazonka.KMS.DisableKey Methods showsPrec :: Int -> DisableKeyResponse -> ShowS # show :: DisableKeyResponse -> String # showList :: [DisableKeyResponse] -> ShowS #
Generic DisableKeyResponse Source #
Instance details Defined in Amazonka.KMS.DisableKey Associated Types type Rep DisableKeyResponse :: Type -> Type # Methods from :: DisableKeyResponse -> Rep DisableKeyResponse x # to :: Rep DisableKeyResponse x -> DisableKeyResponse #
NFData DisableKeyResponse Source #
Instance details Defined in Amazonka.KMS.DisableKey Methods rnf :: DisableKeyResponse -> () #
type Rep DisableKeyResponse Source #
Instance details Defined in Amazonka.KMS.DisableKey type Rep DisableKeyResponse = D1 ('MetaData "DisableKeyResponse" "Amazonka.KMS.DisableKey" "libZSservicesZSamazonka-kmsZSamazonka-kms" 'False) (C1 ('MetaCons "DisableKeyResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDisableKeyResponse :: DisableKeyResponse Source #

Create a value of DisableKeyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.