New API Documentation - Developer Preview Available
We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.
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 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.
The request was rejected because the state of the specified resource is not valid for this
request.
This exceptions means one of the following:
The key state of the KMS key is not compatible with the operation.
To find the key state, use the DescribeKey operation. For more
information about which key states are compatible with each KMS operation, see
Key states of KMS keys in the Key Management Service Developer Guide.
For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.
Base exception class for all service exceptions from KMS service.
Example
To delete imported key material
// The following example deletes the imported key material from the specified KMS key. constinput = { "KeyId":"1234abcd-12ab-34cd-56ef-1234567890ab" }; constcommand = newDeleteImportedKeyMaterialCommand(input); awaitclient.send(command); // example id: to-delete-imported-key-material-1478561674507
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 toPendingImport
.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 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:DeleteImportedKeyMaterial (key policy)
Related operations:
GetParametersForImport
ImportKeyMaterial
Example
Use a bare-bones client and the command you need to make an API call.
Param
DeleteImportedKeyMaterialCommandInput
Returns
DeleteImportedKeyMaterialCommandOutput
See
input
shape.response
shape.config
shape.Throws
DependencyTimeoutException (server fault)
The system timed out while trying to fulfill the request. You can retry the request.
Throws
InvalidArnException (client fault)
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
Throws
KMSInternalException (server fault)
The request was rejected because an internal exception occurred. The request can be retried.
Throws
KMSInvalidStateException (client fault)
The request was rejected because the state of the specified resource is not valid for this request.
This exceptions means one of the following:
The key state of the KMS key is not compatible with the operation.
To find the key state, use the DescribeKey operation. For more information about which key states are compatible with each KMS operation, see Key states of KMS keys in the Key Management Service Developer Guide .
For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.
Throws
NotFoundException (client fault)
The request was rejected because the specified entity or resource could not be found.
Throws
UnsupportedOperationException (client fault)
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
Throws
KMSServiceException
Base exception class for all service exceptions from KMS service.
Example
To delete imported key material