将 RetireGrant 与 AWS SDK 或 CLI 配合使用 - AWS Key Management Service

RetireGrant 与 AWS SDK 或 CLI 配合使用

以下代码示例演示如何使用 RetireGrant

CLI
AWS CLI

停用对客户主密钥的授权

以下 retire-grant 示例从 KMS 密钥中删除授权。

以下示例命令指定 grant-idkey-id 参数。key-id 参数值必须为 KMS 密钥的密钥 ARN。

aws kms retire-grant \ --grant-id 1234a2345b8a4e350500d432bccf8ecd6506710e1391880c4f7f7140160c9af3 \ --key-id arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

此命令不生成任何输出。要确认授权是否已停用,请使用 list-grants 命令。

有关更多信息,请参阅《AWS Key Management Service 开发人员指南》中的停用和撤消授权

  • 有关 API 详细信息,请参阅《AWS CLI 命令参考》中的 RetireGrant

Python
SDK for Python (Boto3)
注意

查看 GitHub,了解更多信息。查找完整示例,学习如何在 AWS 代码示例存储库中进行设置和运行。

class GrantManager: def __init__(self, kms_client): self.kms_client = kms_client @classmethod def from_client(cls) -> "GrantManager": """ Creates a GrantManager instance with a default KMS client. :return: An instance of GrantManager initialized with the default KMS client. """ kms_client = boto3.client("kms") return cls(kms_client) def retire_grant(self, grant): """ Retires a grant so that it can no longer be used. :param grant: The grant to retire. """ try: self.kms_client.retire_grant(GrantToken=grant["GrantToken"]) except ClientError as err: logger.error( "Couldn't retire grant %s. Here's why: %s", grant["GrantId"], err.response["Error"]["Message"], ) else: print(f"Grant {grant['GrantId']} retired.")
  • 有关 API 详细信息,请参阅《AWS SDK for Python (Boto3) API 参考》中的 RetireGrant

有关 AWS SDK 开发人员指南和代码示例的完整列表,请参阅 将此服务与 AWS SDK 结合使用。本主题还包括有关入门的信息以及有关先前的 SDK 版本的详细信息。