非対称キーを使用してデータに署名します。

使用上の注意

キーの仕様と暗号化モードの詳細については、「キーの種類と仕様」をご参照ください。

使用上の注意

プロトコルバッファを使用してすべてのリクエストパラメータをエンコードした後、リクエストボディの長さは3 MBを超えることはできません。リクエストボディが3 MBを超えると、サーバーはリクエストを拒否し、HTTP 413ステータスコードを返します。署名するメッセージのサイズが大きい場合は、メッセージのダイジェストをローカルで生成し、署名または検証操作を呼び出して署名と検証を行うことをお勧めします。

リクエストパラメーター

パラメーター	型	必須 / 任意	例	説明
KeyId	String	対象	1234abcd-12ab-34cd-56ef-12345678 ****	キーのグローバル一意ID。このパラメーターを、キーにバインドされているエイリアスに設定することもできます。
アルゴリズム	String	対象	RSAES_OAEP_SHA_256	署名アルゴリズム。有効な値： RSA_PSS_SHA_256 RSA_PKCS1_SHA_256 ECDSA_SHA_256 SM2DSA
MessageType	String	対象	RAW	メッセージタイプ。有効な値： RAW: 生データ。デフォルト値です。 DIGEST: 生データのメッセージダイジェスト。 Key Management Service (KMS) は、生データのメッセージダイジェストを処理しません。 KMSは秘密鍵を直接使用してデータに署名します。
メッセージ	バイト	対象	バイナリデータ	署名するメッセージ。The message to sign. MessageTypeパラメーターをRAWに設定します。algorithmパラメーターで指定されたハッシュアルゴリズムを使用して、生データのダイジェストを生成し、ダイジェストに署名します。 MessageTypeパラメーターはDIGESTに設定されています。ダイジェストの長さは最大32バイトです。

レスポンスパラメーター

パラメーター	タイプ	例	説明
Signature	バイト	バイナリデータ	計算された署名値。
KeyId	String	1234abcd-12ab-34cd-56ef-12345678 ****	キーのグローバル一意ID。 KeyIdパラメーターがキーのエイリアスに設定されている場合、エイリアスがバインドされているキーのIDが返されます。
アルゴリズム	String	RSAES_OAEP_SHA_256	署名アルゴリズム。
MessageType	String	RAW	メッセージのタイプ。
RequestId	String	475f1620-b9d3-4d35-b5c6-3fbdd941423d	リクエスト ID。

エラーコード

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