カスタムメッセージの Lambda トリガー
Amazon Cognito は、E メールまたは電話による確認メッセージ、または多要素認証 (MFA) コードを送信する前にこのトリガーを呼び出します。カスタムメッセージトリガーを使用して、メッセージを動的にカスタマイズできます。静的なカスタムメッセージは、Amazon Cognito
リクエストには codeParameter が含まれます。これは、Amazon Cognito がユーザーに配信するコードのプレースホルダーとなる文字列です。メッセージ本文で検証コードを表示する位置に codeParameter 文字列を挿入します。Amazon Cognito がこのレスポンスを受信すると、Amazon Cognito が codeParameter 文字列を実際の検証コードに置き換えます。
注記
CustomMessage_AdminCreateUser トリガーソースがあるカスタムメッセージの Lambda 関数 はユーザー名と検証コードを返します。管理者が作成したユーザーはユーザー名とコードの両方を受け取る必要があるため、関数からの応答には request.usernameParameter と request.codeParameterの両方を含める必要があります。
カスタムメッセージの Lambda トリガーのソース
| triggerSource 値 | イベント |
|---|---|
CustomMessage_SignUp |
カスタムメッセージ - サインアップ後に確認コードを送信するため. |
CustomMessage_AdminCreateUser |
カスタムメッセージ – 新規ユーザーに一時パスワードを送信するため. |
CustomMessage_ResendCode |
カスタムメッセージ – 既存ユーザーに確認コードを再送するため. |
CustomMessage_ForgotPassword |
カスタムメッセージ - 忘れたパスワードのリクエスト用の確認コードを送信するため. |
CustomMessage_UpdateUserAttribute |
カスタムメッセージ - ユーザーの E メールまたは電話番号が変更されると、このトリガーは検証コードをそのユーザーに自動的に送信します。他の属性には使用できません。 |
CustomMessage_VerifyUserAttribute |
カスタムメッセージ – ユーザーが手動で新しい E メールや電話番号の認証コードをリクエストすると、このトリガーからユーザーに認証コードが送信されます。 |
CustomMessage_Authentication |
カスタムメッセージ - 認証時に MFA コードを送信するため. |
カスタムメッセージの Lambda トリガーのパラメータ
これらは、Amazon Cognito が共通パラメータのイベント情報と共にこの Lambda 関数に渡すパラメータです。
カスタムメッセージリクエストパラメータ
- userAttributes
-
ユーザー属性を表す 1 つ以上の名前 - 値ペア。
- codeParameter
-
カスタムメッセージで、検証コードのプレースホルダーとして使用する文字列。
- usernameParameter
-
ユーザー名。Amazon Cognito は、管理者が作成したユーザーからのリクエストにこのパラメータを含めます。
- clientMetadata
-
カスタムメッセージのトリガーに指定する Lambda 関数へのカスタム入力として提供できる 1 つ、または複数のキー/値ペア。カスタムメッセージ関数を呼び出すリクエストには、AdminInitiateAuth および InitiateAuth API オペレーションの ClientMetadata パラメータで渡されたデータは含まれません。このデータを Lambda 関数に渡すには、以下の API アクションで ClientMetadata パラメータを使用できます。
カスタムメッセージレスポンスパラメータ
レスポンスで、ユーザーへのメッセージに使用するカスタムテキストを指定します。
- smsMessage
-
ユーザーに送信されるカスタム SMS メッセージ。リクエストで受信する
codeParameter値を含める必要があります。 - emailMessage
-
ユーザーに送信するカスタム E メールメッセージ。
emailMessageパラメータで HTML 書式を使用できます。リクエストで受信されるcodeParameter値を変数{####}として含める必要があります。Amazon Cognito は、ユーザープールのEmailSendingAccount属性がDEVELOPERの場合のみ、emailMessageパラメータを使用できます。ユーザープールのEmailSendingAccount属性が、DEVELOPERではなく、emailMessageパラメータが返されると、Amazon Cognito は 400 エラーコードcom.amazonaws.cognito.identity.idp.model.InvalidLambdaResponseExceptionを生成します。Amazon Simple Email Service (Amazon SES) を使用して E メールメッセージを送信する場合、ユーザープールのEmailSendingAccount属性はDEVELOPERです。それ以外の場合、値はCOGNITO_DEFAULTです。 - emailSubject
-
カスタムメッセージの件名。
emailSubjectパラメータは、ユーザープールの EmailSendingAccount 属性がDEVELOPERの場合にのみ使用できます。ユーザープールのEmailSendingAccount属性がDEVELOPERではなく、Amazon Cognito がemailSubjectパラメータを返した場合、Amazon Cognito は 400 エラーコードcom.amazonaws.cognito.identity.idp.model.InvalidLambdaResponseExceptionを生成します。Amazon Simple Email Service (Amazon SES) を使用して E メールメッセージを送信する場合、ユーザープールのEmailSendingAccount属性はDEVELOPERです。それ以外の場合、値はCOGNITO_DEFAULTです。
サインアップのカスタムメッセージの例
この Lambda 関数の例は、サービスでアプリがユーザーへの検証コードの送信が必要とされる場合に、E メールまたは SMS メッセージをカスタマイズします。
Amazon Cognito は、登録後、検証コードの再送信時、パスワードを忘れた場合、ユーザー属性の検証時といった複数のイベントで Lambda トリガーを呼び出すことができます。レスポンスには、SMS と E メールの両方のメッセージが含まれます。メッセージにはコードのパラメータ "####" を含める必要があります。このパラメータは、ユーザーが受け取る検証コードのプレースホルダーです。
E メールメッセージの最大長は 20,000 UTF-8 文字です。この長さには検証コードが含まれます。これらの E メールメッセージでは、HTML タグを使用できます。
SMS メッセージの最大長は 140 UTF-8 文字です。この長さには検証コードが含まれます。
Amazon Cognito は Lambda 関数にイベント情報を渡します。関数はレスポンスで、同じイベントオブジェクトを変更と共に Amazon Cognito に返します。Lambda コンソールで、Lambda トリガーに関連するデータを使用したテストイベントをセットアップできます。以下は、このコードサンプルのテストイベントです。
管理者作成ユーザーのカスタムメッセージの例
カスタムメッセージの Lambda 関数と CustomMessage_AdminCreateUser トリガーはユーザー名と検証コードを返します。このため、メッセージ本文に request.usernameParameter および request.codeParameter の両方を含めてください。
コードのパラメータ値 #### は、の一時パスワードのプレースホルダーであり、「username」はユーザーが受け取るユーザー名のプレースホルダーです。
E メールメッセージの最大長は 20,000 UTF-8 文字です。この長さには検証コードが含まれます。これらの E メールでは HTML タグを使用できます。SMS メッセージの最大長は 140 UTF-8 文字です。この長さには検証コードが含まれます。
レスポンスには、SMS と E メールの両方のメッセージが含まれます。
Amazon Cognito は Lambda 関数にイベント情報を渡します。関数はレスポンスで、同じイベントオブジェクトを変更と共に Amazon Cognito に返します。Lambda コンソールで、Lambda トリガーに関連するデータを使用したテストイベントをセットアップできます。以下は、このコードサンプルのテストイベントです。
