AWS SDK または CLI で RetireGrant
を使用する
以下のコード例は、RetireGrant
の使用方法を示しています。
- CLI
-
- AWS CLI
-
カスタマーマスターキーの権限を廃止するには
次の
retire-grant
の例は、KMS キーから権限を削除します。次のコマンド例は、
grant-id
パラメータとkey-id
パラメータを指定します。key-id
パラメータの値は、KMS キーのキー ARN である必要があります。aws kms retire-grant \ --grant-id
1234a2345b8a4e350500d432bccf8ecd6506710e1391880c4f7f7140160c9af3
\ --key-idarn: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 バージョンの詳細も含まれています。
ReEncrypt
RevokeGrant