本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
自定义消息 Lambda 触发器
如果您对要发送给用户的电子邮件和SMS消息有外部标准，或者想要在运行时将自己的逻辑应用于用户消息的格式时，请将自定义消息触发器添加到您的用户池中。自定义消息 Lambda 会在您的用户池发送所有电子邮件和SMS消息之前接收这些内容。然后，您的 Lambda 函数就有机会修改消息内容和主题。
Amazon Cognito 会在发送电子邮件或电话验证消息或多重身份验证 () 代码之前调用此触发器。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 |
自定义消息 – 当用户的电子邮件或电话号码发生更改时，此触发器自动向用户发送验证码。不可用于其他属性。 |
CustomMessage_VerifyUserAttribute |
自定义消息 – 当用户针对新的电子邮件或电话号码手动请求验证码时，此触发器向用户发送验证码。 |
CustomMessage_Authentication |
自定义消息-在身份验证期间发送MFA代码。 |
自定义消息 Lambda 触发器参数
Amazon Cognito 传递给此 Lambda 函数的请求是以下参数和 Amazon Cognito 添加到所有请求中的常用参数的组合。
自定义消息请求参数
- userAttributes
-
表示用户属性的一个或多个名称/值对。
- codeParameter
-
一个字符串，用作自定义消息中验证码的占位符。
- usernameParameter
-
用户名。Amazon Cognito 在管理员创建的用户发出的请求中包含此参数。
- clientMetadata
-
一个或多个键值对，您可以将其作为自定义输入内容提供给为自定义消息触发器指定的 Lambda 函数。调用自定义消息函数的请求不包括在 and 操作中的 ClientMetadata 参数中AdminInitiateAuth传递的数据。InitiateAuthAPI要将此数据传递给您的 Lambda 函数，您可以在以下操作API中使用该 ClientMetadata 参数：
自定义消息响应参数
在响应中，指定要在发送给用户的消息中使用的自定义文本。有关 Amazon Cognito 适用于这些参数的字符串限制，请参阅。MessageTemplateType
- smsMessage
-
要发送给用户的自定义SMS消息。必须包含您在请求中收到的
codeParameter值。 - emailMessage
-
发送给用户的自定义电子邮件。可以在
emailMessage参数中使用HTML格式。必须包含您在请求中收到的codeParameter值作为变量{####}。只有在用户池的EmailSendingAccount属性为DEVELOPER时，Amazon Cognito 才可以使用emailMessage参数。如果用户池的EmailSendingAccount属性不是DEVELOPER且返回了emailMessage参数，Amazon Cognito 会生成 400 错误代码com.amazonaws.cognito.identity.idp.model.InvalidLambdaResponseException。当您选择亚马逊简单电子邮件服务 (AmazonSES) 发送电子邮件时，用户池的EmailSendingAccount属性为DEVELOPER。否则，该值为COGNITO_DEFAULT。 - emailSubject
-
自定义消息的主题行。只有当用户池的 EmailSendingAccount属性为时，您才能使用该
emailSubject参数DEVELOPER。如果用户池的EmailSendingAccount属性不是DEVELOPER且 Amazon Cognito 返回了emailSubject参数，Amazon Cognito 会生成 400 错误代码com.amazonaws.cognito.identity.idp.model.InvalidLambdaResponseException。用户池的EmailSendingAccount属性是您选择使用亚马逊简单电子邮件服务 (AmazonSES) 发送电子邮件DEVELOPER时。否则，该值为COGNITO_DEFAULT。
用于注册的自定义消息示例
此示例 Lambda 函数可在服务要求应用程序向用户发送验证码时自定义电子邮件或SMS消息。
Amazon Cognito 可以在多个事件中调用 Lambda 触发器：注册后、重新发送验证码时、恢复忘记的密码时或验证用户属性时。回复包括两者的消息SMS和电子邮件。该消息必须包含代码参数 "####"。此参数是用户收到的验证码的占位符。
电子邮件的最大长度为 20,000 UTF -8 个字符，。此长度包括验证码。您可以在这些电子邮件中使用HTML标签。
SMS消息的最大长度为 140 UTF -8 个字符。此长度包括验证码。
Amazon Cognito 将事件信息传递给 Lambda 函数。随后，该函数将相同事件对象随同响应中的任何更改返回给 Amazon Cognito。在 Lambda 控制台中，您可以设置一个测试事件，该事件包含与您的 Lambda 触发器相关的数据。以下是此代码示例的一个测试事件：
管理员创建用户的自定义消息示例
Amazon Cognito 向此示例自定义消息 Lambda 函数发送的请求的triggerSource值为，用户名CustomMessage_AdminCreateUser和临时密码均为。该函数${event.request.codeParameter}从请求中的临时密码和${event.request.usernameParameter}请求中的用户名填充。
您的自定义消息必须在响应对象codeParameter和emailMessage中usernameParameter插入smsMessage和的值。在此示例中，该函数将相同的消息写入响应字段event.response.smsMessage和event.response.emailMessage。
电子邮件的最大长度为 20,000 UTF -8 个字符。此长度包括验证码。你可以在这些电子邮件中使用HTML标签。SMS消息的最大长度为 140 UTF -8 个字符。此长度包括验证码。
回复包括两者的消息SMS和电子邮件。
Amazon Cognito 将事件信息传递给 Lambda 函数。随后，该函数将相同事件对象随同响应中的任何更改返回给 Amazon Cognito。在 Lambda 控制台中，您可以设置一个测试事件，该事件包含与您的 Lambda 触发器相关的数据。以下是此代码示例的一个测试事件：
