libZSservicesZSamazonka-kmsZSamazonka-kms
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.KMS.DeleteImportedKeyMaterial

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

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

Read DeleteImportedKeyMaterial Source # 
Instance details

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Show DeleteImportedKeyMaterial Source # 
Instance details

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Generic DeleteImportedKeyMaterial Source # 
Instance details

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Associated Types

type Rep DeleteImportedKeyMaterial :: Type -> Type #

NFData DeleteImportedKeyMaterial Source # 
Instance details

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Hashable DeleteImportedKeyMaterial Source # 
Instance details

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

ToJSON DeleteImportedKeyMaterial Source # 
Instance details

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

AWSRequest DeleteImportedKeyMaterial Source # 
Instance details

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

ToHeaders DeleteImportedKeyMaterial Source # 
Instance details

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

ToPath DeleteImportedKeyMaterial Source # 
Instance details

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

ToQuery DeleteImportedKeyMaterial Source # 
Instance details

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

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

newDeleteImportedKeyMaterial Source #

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.

Instances

Instances details
Eq DeleteImportedKeyMaterialResponse Source # 
Instance details

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Read DeleteImportedKeyMaterialResponse Source # 
Instance details

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Show DeleteImportedKeyMaterialResponse Source # 
Instance details

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Generic DeleteImportedKeyMaterialResponse Source # 
Instance details

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Associated Types

type Rep DeleteImportedKeyMaterialResponse :: Type -> Type #

NFData DeleteImportedKeyMaterialResponse Source # 
Instance details

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

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.