Amazonka.KMS.DisableKey

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 states of KMS keys 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 states of KMS keys 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

Creating a Request

data DisableKey

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

ToJSON DisableKey

Defined in Amazonka.KMS.DisableKey

Methods

toJSON :: DisableKey -> Value

toEncoding :: DisableKey -> Encoding

toJSONList :: [DisableKey] -> Value

toEncodingList :: [DisableKey] -> Encoding

ToHeaders DisableKey

Defined in Amazonka.KMS.DisableKey

Methods

toHeaders :: DisableKey -> [Header]

ToPath DisableKey

Defined in Amazonka.KMS.DisableKey

Methods

toPath :: DisableKey -> ByteString

ToQuery DisableKey

Defined in Amazonka.KMS.DisableKey

Methods

toQuery :: DisableKey -> QueryString

AWSRequest DisableKey

Defined in Amazonka.KMS.DisableKey

Associated Types

type AWSResponse DisableKey

Methods

request :: (Service -> Service) -> DisableKey -> Request DisableKey

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DisableKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DisableKey)))

Generic DisableKey

Defined in Amazonka.KMS.DisableKey

Associated Types

type Rep DisableKey :: Type -> Type

Methods

from :: DisableKey -> Rep DisableKey x

to :: Rep DisableKey x -> DisableKey

Read DisableKey

Defined in Amazonka.KMS.DisableKey

Methods

readsPrec :: Int -> ReadS DisableKey

readList :: ReadS [DisableKey]

readPrec :: ReadPrec DisableKey

readListPrec :: ReadPrec [DisableKey]

Show DisableKey

Defined in Amazonka.KMS.DisableKey

Methods

showsPrec :: Int -> DisableKey -> ShowS

show :: DisableKey -> String

showList :: [DisableKey] -> ShowS

NFData DisableKey

Defined in Amazonka.KMS.DisableKey

Methods

rnf :: DisableKey -> ()

Eq DisableKey

Defined in Amazonka.KMS.DisableKey

Methods

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

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

Hashable DisableKey

Defined in Amazonka.KMS.DisableKey

Methods

hashWithSalt :: Int -> DisableKey -> Int

hash :: DisableKey -> Int

type AWSResponse DisableKey

Defined in Amazonka.KMS.DisableKey

type AWSResponse DisableKey = DisableKeyResponse

type Rep DisableKey

Defined in Amazonka.KMS.DisableKey

type Rep DisableKey = D1 ('MetaData "DisableKey" "Amazonka.KMS.DisableKey" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DisableKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDisableKey

Arguments

:: Text

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:

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

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

See: newDisableKeyResponse smart constructor.

Constructors

DisableKeyResponse'

Instances

Generic DisableKeyResponse

Defined in Amazonka.KMS.DisableKey

Associated Types

type Rep DisableKeyResponse :: Type -> Type

Methods

from :: DisableKeyResponse -> Rep DisableKeyResponse x

to :: Rep DisableKeyResponse x -> DisableKeyResponse

Read DisableKeyResponse

Defined in Amazonka.KMS.DisableKey

Methods

readsPrec :: Int -> ReadS DisableKeyResponse

readList :: ReadS [DisableKeyResponse]

readPrec :: ReadPrec DisableKeyResponse

readListPrec :: ReadPrec [DisableKeyResponse]

Show DisableKeyResponse

Defined in Amazonka.KMS.DisableKey

Methods

showsPrec :: Int -> DisableKeyResponse -> ShowS

show :: DisableKeyResponse -> String

showList :: [DisableKeyResponse] -> ShowS

NFData DisableKeyResponse

Defined in Amazonka.KMS.DisableKey

Methods

rnf :: DisableKeyResponse -> ()

Eq DisableKeyResponse

Defined in Amazonka.KMS.DisableKey

Methods

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

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

type Rep DisableKeyResponse

Defined in Amazonka.KMS.DisableKey

type Rep DisableKeyResponse = D1 ('MetaData "DisableKeyResponse" "Amazonka.KMS.DisableKey" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DisableKeyResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDisableKeyResponse :: DisableKeyResponse

Create a value of DisableKeyResponse with all optional fields omitted.

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