すべてのプロダクト
Search
ドキュメントセンター

:UpdateKeyDescription

最終更新日:Dec 21, 2025

キーの説明を更新します。

操作説明

この操作は、カスタマーマスターキー (CMK) の説明を指定された内容に更新します。CMK の元の説明は、DescribeKey 操作を呼び出す際に `Description` パラメーターで指定されたものです。この操作を呼び出すことで、CMK の説明を追加、変更、または削除できます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター

必須 / 任意

説明

KeyId

string

必須

CMK の ID。ID はグローバルに一意である必要があります。

1234abcd-12ab-34cd-56ef-12345678****

Description

string

必須

CMK の説明。この説明には、保護するデータの種類や CMK を使用できるアプリケーションなど、CMK の目的が含まれます。

key description example

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID。問題の特定やトラブルシューティングに使用されます。

3455b9b4-95c1-419d-b310-db6a53b09a39

成功レスポンス

JSONJSON

{
  "RequestId": "3455b9b4-95c1-419d-b310-db6a53b09a39"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。