キーローテーションポリシーを更新します。

使用上の注意

自動キーローテーションが有効な場合、KMSはあらかじめ設定されたローテーション期間が到来した後、自動的にキーバージョンを作成します。 さらに、KMSは新しいキーバージョンを主キーバージョンとして設定します。

自動キーローテーションポリシーは、次のキーに対して設定できません。

  • 非対称キー
  • サービスマネージドキー
  • KMSにインポートされた独自のキー (BYOK) を持参する
  • 有効状態でないキー

この例では、キーIDが1234abcd-12ab-34cd-56ef-12345678 **** のCMKに対して、キーの自動ローテーションが有効になっています。 自動ローテーション期間は30日です。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 UpdateRotationPolicy

実行する操作です。UpdateRotationPolicy に値を設定する。

EnableAutomaticRotation Boolean 必須 true

自動キーローテーションを有効にするかどうかを指定します。設定可能な値は以下のとおりです。

  • true: 自動キーローテーションを有効にします。
  • false: 自動キー回転を無効にします。
KeyId String 必須 1234abcd-12ab-34cd-56ef-12345678****

顧客マスターキー (CMK) のID。 IDはグローバルに一意である必要があります。

RotationInterval String 任意 30d

自動キー回転の期間。 値をinteger[unit] 形式で指定します。 以下の単位がサポートされる: d (日) 、h (時間) 、m (分) 、およびs (秒) 。 たとえば、7dまたは604800秒を使用して7日間の期間を指定できます。 期間は7日から730日までの範囲です。

注 EnableAutomaticRotationパラメーターをtrueに設定する場合は、このパラメーターも指定する必要があります。 EnableAutomaticRotationパラメーターをfalseに設定すると、このパラメーターを指定しないままにすることができます。

レスポンスパラメーター

パラメーター データ型 例 説明
RequestId String efb1cbbd-a093-4278-bc03-639dd4fcc207

リクエストの ID です。

例

リクエストの例

https:// [エンドポイント]/? アクション=UpdateRotationPolicy
&EnableAutomaticRotation=true
&KeyId=1234abcd-12ab-34cd-56ef-12345678 ****
&RotationInterval=30d
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式 

<KMS>
    <RequestId>efb1cbbd-a093-4278-bc03-639dd4fcc207</RequestId>
</KMS>

JSON 形式 

{
    "RequestId": "efb1cbbd-a093-4278-bc03-639dd4fcc207"
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。