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.DeleteImportedKeyMaterial

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Deletes key material that you previously imported. This operation makes the specified KMS key unusable. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide.

When the specified KMS key is in the PendingDeletion state, this operation does not change the KMS key's state. Otherwise, it changes the KMS key's state to PendingImport.

After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the KMS key.

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:DeleteImportedKeyMaterial (key policy)

Related operations:

GetParametersForImport
ImportKeyMaterial

Synopsis

data DeleteImportedKeyMaterial = DeleteImportedKeyMaterial' {
- keyId :: Text
}
newDeleteImportedKeyMaterial :: Text -> DeleteImportedKeyMaterial
deleteImportedKeyMaterial_keyId :: Lens' DeleteImportedKeyMaterial Text
data DeleteImportedKeyMaterialResponse = DeleteImportedKeyMaterialResponse' {
}
newDeleteImportedKeyMaterialResponse :: DeleteImportedKeyMaterialResponse

Creating a Request

data DeleteImportedKeyMaterial Source #

See: newDeleteImportedKeyMaterial smart constructor.

Constructors

DeleteImportedKeyMaterial'

Fields

keyId :: Text
Identifies the KMS key from which you are deleting imported key material. The Origin of the KMS key must be EXTERNAL.
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 DeleteImportedKeyMaterial Source #
Instance details Defined in Amazonka.KMS.DeleteImportedKeyMaterial Methods (==) :: DeleteImportedKeyMaterial -> DeleteImportedKeyMaterial -> Bool # (/=) :: DeleteImportedKeyMaterial -> DeleteImportedKeyMaterial -> Bool #
Read DeleteImportedKeyMaterial Source #
Instance details Defined in Amazonka.KMS.DeleteImportedKeyMaterial Methods readsPrec :: Int -> ReadS DeleteImportedKeyMaterial # readList :: ReadS [DeleteImportedKeyMaterial] # readPrec :: ReadPrec DeleteImportedKeyMaterial # readListPrec :: ReadPrec [DeleteImportedKeyMaterial] #
Show DeleteImportedKeyMaterial Source #
Instance details Defined in Amazonka.KMS.DeleteImportedKeyMaterial Methods showsPrec :: Int -> DeleteImportedKeyMaterial -> ShowS # show :: DeleteImportedKeyMaterial -> String # showList :: [DeleteImportedKeyMaterial] -> ShowS #
Generic DeleteImportedKeyMaterial Source #
Instance details Defined in Amazonka.KMS.DeleteImportedKeyMaterial Associated Types type Rep DeleteImportedKeyMaterial :: Type -> Type # Methods from :: DeleteImportedKeyMaterial -> Rep DeleteImportedKeyMaterial x # to :: Rep DeleteImportedKeyMaterial x -> DeleteImportedKeyMaterial #
NFData DeleteImportedKeyMaterial Source #
Instance details Defined in Amazonka.KMS.DeleteImportedKeyMaterial Methods rnf :: DeleteImportedKeyMaterial -> () #
Hashable DeleteImportedKeyMaterial Source #
Instance details Defined in Amazonka.KMS.DeleteImportedKeyMaterial Methods hashWithSalt :: Int -> DeleteImportedKeyMaterial -> Int # hash :: DeleteImportedKeyMaterial -> Int #
ToJSON DeleteImportedKeyMaterial Source #
Instance details Defined in Amazonka.KMS.DeleteImportedKeyMaterial Methods toJSON :: DeleteImportedKeyMaterial -> Value # toEncoding :: DeleteImportedKeyMaterial -> Encoding # toJSONList :: [DeleteImportedKeyMaterial] -> Value # toEncodingList :: [DeleteImportedKeyMaterial] -> Encoding #
AWSRequest DeleteImportedKeyMaterial Source #
Instance details Defined in Amazonka.KMS.DeleteImportedKeyMaterial Associated Types type AWSResponse DeleteImportedKeyMaterial # Methods request :: DeleteImportedKeyMaterial -> Request DeleteImportedKeyMaterial # response :: MonadResource m => Logger -> Service -> Proxy DeleteImportedKeyMaterial -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteImportedKeyMaterial))) #
ToHeaders DeleteImportedKeyMaterial Source #
Instance details Defined in Amazonka.KMS.DeleteImportedKeyMaterial Methods toHeaders :: DeleteImportedKeyMaterial -> [Header] #
ToPath DeleteImportedKeyMaterial Source #
Instance details Defined in Amazonka.KMS.DeleteImportedKeyMaterial Methods toPath :: DeleteImportedKeyMaterial -> ByteString #
ToQuery DeleteImportedKeyMaterial Source #
Instance details Defined in Amazonka.KMS.DeleteImportedKeyMaterial Methods toQuery :: DeleteImportedKeyMaterial -> QueryString #
type Rep DeleteImportedKeyMaterial Source #
Instance details Defined in Amazonka.KMS.DeleteImportedKeyMaterial type Rep DeleteImportedKeyMaterial = D1 ('MetaData "DeleteImportedKeyMaterial" "Amazonka.KMS.DeleteImportedKeyMaterial" "libZSservicesZSamazonka-kmsZSamazonka-kms" 'False) (C1 ('MetaCons "DeleteImportedKeyMaterial'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteImportedKeyMaterial Source #
Instance details Defined in Amazonka.KMS.DeleteImportedKeyMaterial type AWSResponse DeleteImportedKeyMaterial = DeleteImportedKeyMaterialResponse

newDeleteImportedKeyMaterial Source #

Arguments

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

Create a value of DeleteImportedKeyMaterial 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:DeleteImportedKeyMaterial', deleteImportedKeyMaterial_keyId - Identifies the KMS key from which you are deleting imported key material. The Origin of the KMS key must be EXTERNAL.

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

deleteImportedKeyMaterial_keyId :: Lens' DeleteImportedKeyMaterial Text Source #

Identifies the KMS key from which you are deleting imported key material. The Origin of the KMS key must be EXTERNAL.

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 DeleteImportedKeyMaterialResponse Source #

See: newDeleteImportedKeyMaterialResponse smart constructor.

Constructors

DeleteImportedKeyMaterialResponse'

Instances

Instances details

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

newDeleteImportedKeyMaterialResponse :: DeleteImportedKeyMaterialResponse Source #

Create a value of DeleteImportedKeyMaterialResponse with all optional fields omitted.

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