示例工程教程后端【免費(fèi)下載鏈接】aws-doc-sdk-examplesWelcome to the AWS Code Examples Repository. This repo contains code examples used in the AWS documentation, AWS SDK Developer Guides, and more. For more information, see the Readme.md file below.項目地址https://gitcode.com/gh_mirrors/aw/aws-doc-sdk-examples點(diǎn)擊查看免費(fèi)下載本篇指南以 python/example_code/pinpoint/README.md 為核心骨架系統(tǒng)講解如何使用 AWS SDK for PythonBoto3調(diào)用 Amazon Pinpoint 服務(wù)通過實際源碼覆蓋四種典型消息發(fā)送場景API 發(fā)送簡單郵件、API 發(fā)送 SMS、SMTP 接口發(fā)送郵件、以及基于消息模板的郵件/SMS 發(fā)送。讀完本文你將掌握send_messages請求結(jié)構(gòu)的完整寫法、各類參數(shù)的取值與注意事項以及如何在本地用 pytest 對 Pinpoint 代碼做單元測試。概述Amazon Pinpoint 與 Boto3Amazon Pinpoint 幫助你通過電子郵件、短信、語音消息和推送通知與客戶互動。Amazon Pinpoint 是 AWS 提供的多渠道客戶互動服務(wù)可用于營銷推廣、事務(wù)性通知等場景。在 aws-doc-sdk-examples 倉庫的 python/example_code/pinpoint 目錄下提供了使用 AWS SDK for PythonBoto3操作 Amazon Pinpoint 的完整可運(yùn)行示例。所有示例均圍繞 Pinpoint 的核心 APIsend_messages展開覆蓋郵件與 SMS 兩種渠道并區(qū)分“直接發(fā)送”與“模板發(fā)送”兩種模式。從源碼結(jié)構(gòu)看該目錄下的示例文件遵循“獨(dú)立單動作”的組織方式——每個文件都包含一個main()入口和可復(fù)用的發(fā)送函數(shù)既可以直接從命令行運(yùn)行演示也可以將發(fā)送函數(shù)導(dǎo)入到自己的業(yè)務(wù)代碼中復(fù)用文件發(fā)送場景pinpoint_send_email_message_api.py通過 Pinpoint API 發(fā)送含 HTML 與純文本雙版本內(nèi)容的郵件pinpoint_send_sms_message_api.py通過 Pinpoint API 發(fā)送 SMS 短信pinpoint_send_email_smtp.py通過 Amazon Pinpoint SMTP 服務(wù)器發(fā)送郵件pinpoint_send_templated_email_message.py使用預(yù)定義郵件模板發(fā)送郵件pinpoint_send_templated_sms_message.py使用預(yù)定義 SMS 模板發(fā)送短信? 重要提醒成本與權(quán)限運(yùn)行本目錄代碼前需要了解以下約束運(yùn)行這些代碼可能會在你的 AWS 賬戶中產(chǎn)生費(fèi)用。請參考 AWS Pricing 與 Free Tier 了解定價。運(yùn)行測試同樣可能產(chǎn)生費(fèi)用集成測試會真實調(diào)用 AWS 服務(wù)。建議遵循最低權(quán)限原則least privilege至少只授予完成任務(wù)所需的最小權(quán)限集。這些代碼并未在所有 AWS 區(qū)域完成測試請確認(rèn)你的目標(biāo)區(qū)域支持 Amazon Pinpoint。在實際生產(chǎn)環(huán)境中還應(yīng)特別注意發(fā)件地址與收件地址的驗證要求詳見下文各示例的參數(shù)說明。環(huán)境準(zhǔn)備前置條件與依賴安裝前置條件按照 python/README.md 中的說明你需要擁有 AWS 賬戶并按 AWS Tools and SDKs Shared Configuration and Credentials Reference Guide 配置默認(rèn)憑證與默認(rèn)區(qū)域通常通過~/.aws/credentials與~/.aws/config完成。Python 3.6 或更高版本。安裝依賴在虛擬環(huán)境中安裝示例所需的依賴包python -m pip install -r requirements.txt本目錄的 requirements.txt 內(nèi)容如下boto31.26.79 pytest7.2.1其中boto31.26.79提供了pinpoint服務(wù)的客戶端pytest7.2.1用于運(yùn)行 test 目錄下的單元測試。推薦的標(biāo)準(zhǔn)操作流程是先進(jìn)入示例目錄創(chuàng)建并激活虛擬環(huán)境再安裝依賴python -m venv .venv source .venv/bin/activate # Linux、macOS 或 UnixWindows 下使用 .venv\Scripts\activate python -m pip install -r requirements.txt單動作示例調(diào)用單個服務(wù)函數(shù)原 README 將示例歸類為Single actions單動作即展示如何調(diào)用單個服務(wù)函數(shù)的代碼片段核心入口是 SendMessages —— pinpoint_send_email_message_api.py#L11。實際上目錄內(nèi) 5 個示例文件都圍繞同一個服務(wù)調(diào)用send_messages展開區(qū)別僅在于MessageRequest的載荷結(jié)構(gòu)。下面逐一深入講解。1. 通過 API 發(fā)送簡單郵件對應(yīng)文件pinpoint_send_email_message_api.py核心函數(shù)send_email_message的簽名與參數(shù)說明如下def send_email_message( pinpoint_client, app_id, sender, to_addresses, char_set, subject, html_message, text_message, ):各參數(shù)含義pinpoint_clientBoto3 Pinpoint 客戶端由boto3.client(pinpoint)創(chuàng)建。app_id發(fā)送消息時使用的 Amazon Pinpoint 項目 ID。sender發(fā)件人地址From。該地址必須在發(fā)送郵件的 AWS 區(qū)域中完成 Pinpoint 驗證。to_addresses收件人地址列表To。如果你的 Pinpoint 賬戶仍處于沙箱sandbox狀態(tài)這些地址必須經(jīng)過驗證。char_set主題行和郵件正文使用的字符編碼示例中使用UTF-8。subject郵件主題。html_message面向支持 HTML 的郵件客戶端的郵件正文。text_message面向不支持 HTML 的郵件客戶端的純文本正文。返回值一個 dict鍵為收件人地址、值為對應(yīng)的 Message ID。核心的 API 請求結(jié)構(gòu)response pinpoint_client.send_messages( ApplicationIdapp_id, MessageRequest{ Addresses: { to_address: {ChannelType: EMAIL} for to_address in to_addresses }, MessageConfiguration: { EmailMessage: { FromAddress: sender, SimpleEmail: { Subject: {Charset: char_set, Data: subject}, HtmlPart: {Charset: char_set, Data: html_message}, TextPart: {Charset: char_set, Data: text_message}, }, } }, }, )關(guān)鍵設(shè)計點(diǎn)Addresses中每個收件地址通過ChannelType: EMAIL顯式指定消息渠道使同一個MessageRequest可以混合不同渠道的收件人。SimpleEmail結(jié)構(gòu)同時提供HtmlPart與TextPart郵件客戶端會自動選擇可渲染的版本從而兼顧 HTML 與純文本用戶。字符編碼通過Charset單獨(dú)指定可以靈活適配多語言內(nèi)容。錯誤處理與返回解析try: response pinpoint_client.send_messages(...) except ClientError: logger.exception(Couldnt send email.) raise else: return { to_address: message[MessageId] for to_address, message in response[MessageResponse][Result].items() }發(fā)送失敗時拋出botocore.exceptions.ClientError成功時從MessageResponse.Result中逐地址提取MessageId方便后續(xù)做送達(dá)追蹤。2. 通過 API 發(fā)送 SMS 短信對應(yīng)文件pinpoint_send_sms_message_api.py核心函數(shù)簽名def send_sms_message( pinpoint_client, app_id, origination_number, destination_number, message, message_type, ):參數(shù)要點(diǎn)app_idPinpoint 項目 ID該項目的 SMS 渠道必須已啟用。destination_number收件人手機(jī)號必須使用 E.164 格式例如14255550142。origination_number發(fā)件手機(jī)號必須與你的 Pinpoint 賬戶關(guān)聯(lián)且為 E.164 格式。messageSMS 消息正文內(nèi)容。message_type消息類型。發(fā)送時效性敏感內(nèi)容指定TRANSACTIONAL營銷推廣內(nèi)容指定PROMOTIONAL——該字段直接決定 Pinpoint 對短信的優(yōu)先級路由與計費(fèi)模式。返回值消息 ID字符串。請求結(jié)構(gòu)response pinpoint_client.send_messages( ApplicationIdapp_id, MessageRequest{ Addresses: {destination_number: {ChannelType: SMS}}, MessageConfiguration: { SMSMessage: { Body: message, MessageType: message_type, OriginationNumber: origination_number, } }, }, )main()中的示例參數(shù)為origination_number 12065550199、destination_number 14255550142、message_type TRANSACTIONAL。返回時通過response[MessageResponse][Result][destination_number][MessageId]取得消息 ID。3. 通過 SMTP 接口發(fā)送郵件對應(yīng)文件pinpoint_send_email_smtp.py與 API 方式不同SMTP 方式不依賴 Boto3 客戶端而是使用 Python 標(biāo)準(zhǔn)庫smtplib與email.mime直接連接 Amazon Pinpoint SMTP 服務(wù)器。核心函數(shù)def send_smtp_message( smtp_server, smtp_username, smtp_password, sender, to_address, cc_address, subject, html_message, text_message, ):內(nèi)部實現(xiàn)要點(diǎn)構(gòu)造 MIME 消息使用MIMEMultipart(alternative)作為容器分別用MIMEText(html_message, html)和MIMEText(text_message, plain)附加 HTML 與純文本兩個版本建立安全連接依次調(diào)用smtp_server.ehlo()→starttls()→ehlo()smtplib文檔建議在starttls()前后各調(diào)用一次ehlo()→login(smtp_username, smtp_password)發(fā)送消息smtp_server.sendmail(sender, to_address, msg.as_string())。注釋中還提示可用set_debuglevel(1)將 SMTP 服務(wù)器響應(yīng)輸出到 stdout 便于排錯。連接參數(shù)在main()中定義host email-smtp.us-west-2.amazonaws.com如果使用的區(qū)域不是美國西部俄勒岡us-west-2需要替換為該區(qū)域?qū)?yīng)的 Amazon Pinpoint SMTP 端點(diǎn)。port 587標(biāo)準(zhǔn) SMTP 提交端口。憑證smtp_username AKIAIOSFODNN7EXAMPLE示例中的 IAM 訪問密鑰占位值需要替換為你的 Pinpoint SMTP 用戶名smtp_password從環(huán)境變量SMTP_PASSWORD中讀取避免把憑證硬編碼進(jìn)代碼smtp_password environ[SMTP_PASSWORD]使用with smtplib.SMTP(host, port) as smtp_server:確保會話結(jié)束后連接自動關(guān)閉。4. 使用模板發(fā)送郵件對應(yīng)文件pinpoint_send_templated_email_message.py模板發(fā)送將郵件內(nèi)容的管理從代碼中剝離出來——正文、主題等由 Pinpoint 中預(yù)先創(chuàng)建的模板維護(hù)代碼只需引用模板名稱與版本。核心函數(shù)def send_templated_email_message( pinpoint_client, project_id, sender, to_addresses, template_name, template_version ):請求結(jié)構(gòu)的關(guān)鍵差異在于增加了TemplateConfiguration并且EmailMessage中不再內(nèi)聯(lián)SimpleEmail內(nèi)容response pinpoint_client.send_messages( ApplicationIdproject_id, MessageRequest{ Addresses: { to_address: {ChannelType: EMAIL} for to_address in to_addresses }, MessageConfiguration: {EmailMessage: {FromAddress: sender}}, TemplateConfiguration: { EmailTemplate: { Name: template_name, Version: template_version, } }, }, )template_name指定使用的郵件模板名稱template_version指定模板版本號main()中示例為My_Email_Template與1。模板機(jī)制便于在 Pinpoint 控制臺統(tǒng)一維護(hù)文案并通過版本號實現(xiàn)灰度升級。5. 使用模板發(fā)送 SMS對應(yīng)文件pinpoint_send_templated_sms_message.pydef send_templated_sms_message( pinpoint_client, project_id, destination_number, message_type, origination_number, template_name, template_version, ):請求結(jié)構(gòu)將模板配置掛載到SMSTemplate鍵下SMSMessage中同樣不再內(nèi)聯(lián)Bodyresponse pinpoint_client.send_messages( ApplicationIdproject_id, MessageRequest{ Addresses: {destination_number: {ChannelType: SMS}}, MessageConfiguration: { SMSMessage: { MessageType: message_type, OriginationNumber: origination_number, } }, TemplateConfiguration: { SMSTemplate: {Name: template_name, Version: template_version} }, }, )值得注意的是該文件的main()在創(chuàng)建客戶端時顯式指定了區(qū)域boto3.client(pinpoint, region_nameregion)示例region us-east-1與其余文件依賴默認(rèn)區(qū)域配置的方式形成對照——當(dāng)默認(rèn)區(qū)域與 Pinpoint 項目所在區(qū)域不一致時應(yīng)顯式傳入region_name。運(yùn)行示例原 README 的指令說明如下每個文件都可以在命令提示符下單獨(dú)運(yùn)行。例如要發(fā)送一封郵件在命令提示符下運(yùn)行python pinpoint_send_email_message_api.py同理其余 4 個文件均可按相同方式獨(dú)立執(zhí)行python pinpoint_send_sms_message_api.py python pinpoint_send_email_smtp.py python pinpoint_send_templated_email_message.py python pinpoint_send_templated_sms_message.py運(yùn)行前請務(wù)必將代碼中的占位值替換為真實參數(shù)app_id/project_id替換為你的 Pinpoint 項目 ID示例值形如ce796be37f32f178af652b26eexamplesender替換為已完成驗證的發(fā)件地址to_address/destination_number替換為已驗證的收件地址或 E.164 格式手機(jī)號origination_number替換為與賬戶關(guān)聯(lián)的發(fā)件號碼SMTP 方式還需設(shè)置SMTP_PASSWORD環(huán)境變量。每個文件運(yùn)行成功后會打印類似Message sent! Message IDs: {...}或Email sent!的輸出。需要更多參數(shù)說明時可參考各文件的main()函數(shù)與函數(shù) docstring。測試單元測試與集成測試原 README 指出運(yùn)行測試的通用說明參見 python/README.md#Tests并提醒運(yùn)行測試可能產(chǎn)生 AWS 費(fèi)用。本目錄的測試代碼位于 python/example_code/pinpoint/testconftest.py加載公共測試夾具其中sys.path.append(../..)使測試可以導(dǎo)入python/test_tools下的工具模塊。test_pinpoint.py覆蓋 5 個示例文件的單元測試。單元測試botocore Stubber 機(jī)制單元測試使用 botocore Stubber 對服務(wù)調(diào)用進(jìn)行樁響應(yīng)stub運(yùn)行時不向 AWS 發(fā)送真實請求返回模擬響應(yīng)因此不會產(chǎn)生費(fèi)用。測試借助make_stubber夾具與 python/test_tools/pinpoint_stubber.py 中的PinpointStubber類協(xié)同工作。以test_send_email_message為例它通過pytest.mark.parametrize(error_code, [None, TestException])同時驗證成功路徑與異常路徑pinpoint_stubber.stub_send_email_messages( app_id, sender, [to_address], char_set, subject, html_message, text_message, [message_id], error_codeerror_code, )成功分支error_code is None斷言返回的消息 ID 與樁值一致失敗分支error_code TestException斷言調(diào)用拋出ClientError且exc_info.value.response[Error][Code]與錯誤碼匹配。PinpointStubber中對應(yīng)實現(xiàn)了 4 個樁函數(shù)其expected_params與示例代碼中的請求結(jié)構(gòu)嚴(yán)格一一對應(yīng)例如 stub_send_email_messages 與 stub_send_sms_message 分別校驗了 EMAIL/SMS 的MessageRequest載荷與TemplateConfiguration結(jié)構(gòu)。這從側(cè)面印證了示例代碼中請求參數(shù)的真實性——測試期望的參數(shù)與發(fā)送代碼實際構(gòu)造的參數(shù)必須完全一致否則樁會拋出參數(shù)不匹配錯誤。SMTP 示例的測試test_send_smtp_message則使用mock.MagicMock()模擬 SMTP 會話斷言login使用正確的用戶名/密碼、sendmail以(sender, to_address, 消息內(nèi)容)被調(diào)用。運(yùn)行單元測試排除集成標(biāo)記不產(chǎn)生費(fèi)用python -m pytest -m not integ集成測試真實調(diào)用 AWS集成測試會向 AWS 發(fā)起真實請求、創(chuàng)建并銷毀賬戶中的資源可能產(chǎn)生費(fèi)用請謹(jǐn)慎運(yùn)行python -m pytest -m integ更多資源Amazon Pinpoint 開發(fā)者指南Amazon Pinpoint API 參考SDK for Python (Boto3) Amazon Pinpoint 參考Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.SPDX-License-Identifier: Apache-2.0贊分享示例工程教程后端【免費(fèi)下載鏈接】aws-doc-sdk-examplesWelcome to the AWS Code Examples Repository. This repo contains code examples used in the AWS documentation, AWS SDK Developer Guides, and more. For more information, see the Readme.md file below.項目地址https://gitcode.com/gh_mirrors/aw/aws-doc-sdk-examples點(diǎn)擊查看免費(fèi)下載相關(guān)推薦使用 PythonBoto3調(diào)用 Amazon Pinpoint SMS and Voice 發(fā)送語音消息從源碼到實戰(zhàn)使用 PythonBoto3調(diào)用 Amazon Pinpoint SMS and Voice 發(fā)送語音消息從源碼到實戰(zhàn) 導(dǎo)讀 本文基于 aws doc s示例工程教程后端使用 AWS SDK for JavaScript v2 調(diào)用 Amazon Pinpoint SMS and Voice API 發(fā)送語音消息使用 AWS SDK for JavaScript v2 調(diào)用 Amazon Pinpoint SMS and Voice API 發(fā)送語音消息 Amazon示例工程教程后端使用 AWS SDK for PythonBoto3操作 Amazon Aurora完整示例與實戰(zhàn)指南使用 AWS SDK for PythonBoto3操作 Amazon Aurora完整示例與實戰(zhàn)指南 本指南以 python/example_code/示例工程教程后端創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考