KMS / Client / get_key_last_usage
get_key_last_usage¶
- KMS.Client.get_key_last_usage(**kwargs)¶
Returns usage information about the last successful cryptographic operation performed with a specified KMS key, including the operation type, timestamp, and associated CloudTrail event ID.
The
TrackingStartDatein theGetKeyLastUsageresponse indicates the date from which KMS began recording cryptographic activity for a given key. Use this value together withKeyCreationDateto understand the key’s usage history:If the
KeyLastUsageresponse element is present, the key has been used for a successful cryptographic operation since theTrackingStartDate. The response includes the operation type, timestamp, and associated CloudTrail event ID.If the
KeyLastUsageresponse element is empty andKeyCreationDateis on or afterTrackingStartDate, the key has not been used for a successful cryptographic operation since it was created.If the
KeyLastUsageresponse element is empty andKeyCreationDateis beforeTrackingStartDate, there is no record of the key being used for a successful cryptographic operation since theTrackingStartDate. However, the key may have been used before tracking began. To determine whether the key was used before theTrackingStartDate, examine your past CloudTrail logs.
For multi-Region KMS keys, primary and replica keys track last usage independently. Each key in a multi-Region key set maintains its own usage information.
The
ReEncryptoperation uses two keys: a source key for decryption and a destination key for encryption. Usage information is recorded for both keys independently, each with the CloudTrail event ID from the respective key owner’s account.Note
Do not use
GetKeyLastUsageas the sole indicator when scheduling a key for deletion. Instead, first disable the key and monitor CloudTrail forDisabledExceptionentries, as there could be infrequent workflows that are dependent on the key. By looking for this exception, you can identify potential dependencies and workload failures before they occur.Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:GetKeyLastUsage (key policy)
Related operations:
DescribeKey
DisableKey
ScheduleKeyDeletion
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
See also: AWS API Documentation
Request Syntax
response = client.get_key_last_usage( KeyId='string' )
- Parameters:
KeyId (string) –
[REQUIRED]
Identifies the KMS key to get usage information for. To specify a KMS key, use its key ID or key ARN. Alias names are not supported.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID:
1234abcd-12ab-34cd-56ef-1234567890abKey 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.
- Return type:
dict
- Returns:
Response Syntax
{ 'KeyId': 'string', 'KeyLastUsage': { 'Operation': 'Decrypt'|'DeriveSharedSecret'|'Encrypt'|'GenerateDataKey'|'GenerateDataKeyPair'|'GenerateDataKeyPairWithoutPlaintext'|'GenerateDataKeyWithoutPlaintext'|'GenerateMac'|'ReEncrypt'|'Sign'|'Verify'|'VerifyMac', 'Timestamp': datetime(2015, 1, 1), 'CloudTrailEventId': 'string', 'KmsRequestId': 'string' }, 'TrackingStartDate': datetime(2015, 1, 1), 'KeyCreationDate': datetime(2015, 1, 1) }
Response Structure
(dict) –
KeyId (string) –
The globally unique identifier for the KMS key.
KeyLastUsage (dict) –
Contains usage information about the last time the KMS key was used for a successful cryptographic operation. If the key has not been used since tracking began, this response element is empty.
Operation (string) –
The last successful cryptographic operation the KMS key was used for. Absent if the key has not been used since KMS began tracking.
Timestamp (datetime) –
The date and time when the KMS key was most recently used for a successful cryptographic operation. Absent if the key has not been used since KMS began tracking.
CloudTrailEventId (string) –
The CloudTrail
eventIdassociated with the last successful cryptographic operation. Absent if the key has not been used since KMS began tracking.KmsRequestId (string) –
The KMS request ID associated with the last successful cryptographic operation. Absent if the key has not been used since KMS began tracking.
TrackingStartDate (datetime) –
The date from which KMS began recording cryptographic activity for this key, or the date the KMS key was created, whichever is later.
KeyCreationDate (datetime) –
The date and time when the KMS key was created.
Exceptions
KMS.Client.exceptions.NotFoundExceptionKMS.Client.exceptions.InvalidArnExceptionKMS.Client.exceptions.DependencyTimeoutExceptionKMS.Client.exceptions.KMSInternalException