対称CMKを使用してプレーンテキストを暗号化します。
- KMSは、指定されたCMKのプライマリバージョンを使用してデータを暗号化します。
- 6 KB以下のデータのみ暗号化できます。 たとえば、この操作を呼び出して、RSAキー、データベースアクセスパスワード、またはその他の機密情報を暗号化できます。
- リージョン間で暗号化されたデータを移行する場合、移行先リージョンでこの操作を呼び出して、移行元リージョンで移行されたデータの暗号化に使用されるデータキーのプレーンテキストを暗号化できます。 このようにして、データ鍵の暗号文が宛先領域において生成される。 Decrypt操作を呼び出して、データキーを復号化することもできます。
デバッグ
リクエストパラメーター
パラメーター | データ型 | 必須/任意 | 例 | 説明 |
---|---|---|---|---|
アクション | String | 必須 | Encrypt |
実行する操作です。 値をEncryptに設定します。 |
KeyId | String | 必須 | 1234abcd-12ab-34cd-56ef-12345678 **** |
CMKのグローバル一意ID。 このパラメーターをCMKにバインドされているエイリアスに設定することもできます。 詳細については、「エイリアスの使用」をご参照ください。 |
平文 | String | 必須 | SGVsbG8gd29y **** |
暗号化するプレーンテキスト。 プレーンテキストはBase64エンコードする必要があります。 |
EncryptionContext | ジェソン | 任意 | {"例":"例"} |
キーと値のペアで構成されるJSON文字列。 このパラメーターを指定すると、Decrypt操作を呼び出すときに同等の値が必要になります。 詳細については、「EncryptionContext」をご参照ください。 |
レスポンスパラメーター
パラメーター | データ型 | 例 | 説明 |
---|---|---|---|
CiphertextBlob | String | DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl + TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK **** |
プライマリCMKバージョンを使用して暗号化されるデータの暗号文。 |
KeyId | String | 1234abcd-12ab-34cd-56ef-12345678 **** |
グローバルに一意な CMK の ID。 KeyIdパラメーターをエイリアスに設定すると、エイリアスがバインドされているCMKのIDが返されます。 |
KeyVersionId | String | 86a9efd9-3d16-4894-bd4f-1fc43f3f **** |
プレーンテキストの暗号化に使用されるキーバージョンのID。 CMKのプライマリバージョンです。 |
RequestId | String | 475f1620-b9d3-4d35-b5c6-3fbdd941423d |
リクエストの ID です。 |
例
リクエストの例
http(s)://[Endpoint]/?Action=Encrypt
&KeyId=1234abcd-12ab-34cd-56ef-12345678 ****
&プレーンテキスト=SGVsbG8gd29y ****
&<共通リクエストパラメーター>
正常に処理された場合のレスポンス例
XML
形式
<KMS>
<RequestId>475f1620-b9d3-4d35-b5c6-3fbdd941423d</RequestId>
<CiphertextBlob>DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl + TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK ****</CiphertextBlob>
<KeyId>1234abcd-12ab-34cd-56ef-12345678 ****</KeyId>
<KeyVersionId>86a9efd9-3d16-4894-bd4f-1fc43f3f ****</KeyVersionId>
</KMS>
JSON
形式
{
"RequestId":"475f1620-b9d3-4d35-b5c6-3fbdd941423d" 、
"CiphertextBlob":"DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****",
"KeyId":"1234abcd-12ab-34cd-56ef-12345678 ****" 、
"KeyVersionId":"86a9efd9-3d16-4894-bd4f-1fc43f3f ****"
}
エラーコード
エラーコードリストについては、「API エラーセンター」をご参照ください。