cancel_key_deletion¶
Operation¶
cancel_key_deletion
async
¶
cancel_key_deletion(request: CancelKeyDeletionInput | CancelKeyDeletionInputDict, /, *, plugins: list[Plugin] | None = None) -> CancelKeyDeletionOutput
cancel_key_deletion(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CancelKeyDeletionInputDict]) -> CancelKeyDeletionOutput
Cancels the deletion of a KMS key. When this operation succeeds, the key
state of the KMS key is Disabled. To enable the KMS key, use
EnableKey.
For more information about scheduling and canceling deletion of a KMS key, see Deleting 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:CancelKeyDeletion (key policy)
Related operations: ScheduleKeyDeletion
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CancelKeyDeletionOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
CancelKeyDeletionInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CancelKeyDeletionInput structure.
Attributes¶
key_id
class-attribute
instance-attribute
¶
key_id: str | None = ...
Identifies the KMS key whose deletion is being canceled.
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.
Dictionaries¶
CancelKeyDeletionInputDict
¶
Bases: TypedDict
Dictionary form of CancelKeyDeletionInput.
Attributes¶
key_id
instance-attribute
¶
Identifies the KMS key whose deletion is being canceled.
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.
Output¶
CancelKeyDeletionOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CancelKeyDeletionOutput structure.
Attributes¶
key_id
class-attribute
instance-attribute
¶
key_id: str | None = ...
The Amazon Resource Name (key ARN) of the KMS key whose deletion is canceled.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.