はじめに
Amazon SNSを使ってHTTP/SでAPIを叩いていきます。
ここでは各AWSサービスの説明は省きます。
AWS超初心者です。
目的
- Amazon SNSからHTTP/SでAPIを実行する。
- Amazon SNSからWEBAPIを実行するとき、エンドポイント（受信側）でやることはなにか調べる。
（記事がほとんど見つからなかった）
構成
今回は、APIはAPIGateway + Lambdaで用意。
エンドポイント（受信側）でやること
AWSの公式ドキュメントを見たら、やることは大きく分けて3つあるらしい。
- 受信準備が完了していることを確認する（エンドポイントで「私はAmazon SNSからの通知を受け取れる状態にありますよ～」ということを確認する）
- Amazon SNSからの通知を受け取る
- Amazon SNSからサブスクリプション登録解除の情報を受け取る
最初は、ただAmazon SNSから通知先のエンドポイントを設定してメッセージを送信すればよいと思っていましたが
それだけだと上手くいかないようです。
APIの用意
まず、エンドポイントであるAPIを作っていきます。
やりたいことができれば何でもいいのですが、今回は入り口をAPI Gateway、実行される処理をLambdaにしてみました。
API Gatewayに紐づける
こんな感じでLambdaをAPI Gatewayに紐づけてあげましょう。
エンドポイントの確認
上記のようにLambdaのコンソールから見れます。
「APIエンドポイント」のURLをコピーしておきましょう。
Amazon SNSでトピックの作成
次にAmazon SNSを用意して、トピックを作成後、通知先のエンドポイントを設定します。
通知先のエンドポイントを設定する
Amazon SNSのコンソール画面から通知先のエンドポイントを設定してみるとこんな画面になります。
ステータスが「保留中の確認」となっています。
ステータスを「確認済み」にしないと、トピックからメッセージを発行してもエンドポイントに通知されません。
AWSドキュメント
受信登録が確認されるまで、Amazon SNS はこのエンドポイントに通知を送信しません。
APIをLambdaで実装
pythonで作りました。boto3は使っていません。
import requests
import json
def lambda_handler(event, context):
path = event['path']
user_agent = event['headers']['User-Agent']
# この関数がAmazon SNS経由で呼ばれた場合
if path == '/testFunction' and user_agent == 'Amazon Simple Notification Service Agent':
type = event['headers']['x-amz-sns-message-type']
# 文字列をdictに変換してbodyの中身を参照できるようにする
body_unicode = event['body']
body_dict = json.loads(body_unicode)
if type == 'SubscriptionConfirmation':
# サブスクライブされた場合の受信登録確認用処理
subscribeurl = body_dict['SubscribeURL']
# 受信登録の確認用URLを叩く
response = requests.get(subscribeurl)
if response.status_code == 200:
print("SubscriptionConfirmation")
elif type == 'Notification':
# 通知がきた場合の処理
message = body_dict['Message']
print('Amazon SNSからのメッセージ：' + message)
print("Notification")
elif type == 'UnsubscribeConfirmation ':
# 退会通知がきた場合の処理
print("UnsubscribeConfirmation")
# レスポンス整形
res = {
"isBase64Encoded": False,
"statusCode": 200,
"headers": {},
"body": type
}
return json.dumps(res)
else :
print('SNS経由じゃないよ')
res = {
"isBase64Encoded": "false",
"statusCode": "200",
"headers": {},
"body": "not testFunction for Amazon SNS"
}
return json.dumps(res)
コードの説明
基本的には前述している「エンドポイントでやること」をもとに作成しています。
Amazon SNSのメッセージタイプがわかるevent['headers']['x-amz-sns-message-type']の値によって処理を分けています。
参考：AWS公式ドキュメント
コードは、Amazon SNS がエンドポイントに送信する HTTP POST リクエストの HTTP ヘッダーを読み取る必要があります。また、コードは Amazon SNS が送信したメッセージのタイプを示すヘッダーフィールド x-amz-sns-message-type を探す必要があります。
- エンドポイントでやること
- 受信準備が完了していることを確認する（エンドポイントで「私はAmazon SNSからの通知を受け取れる状態にありますよ～」ということを確認する）
- Amazon SNSからの通知を受け取る
- Amazon SNSからサブスクリプション登録解除の情報を受け取る
「1. 受信準備が完了していることを確認する」をやってみる
1は、response = requests.get(subscribeurl)で実現しています。
Amazon SNSのコンソール画面から「リクエストの確認」をします。
リロードすると、ステータスが「保留中の確認」から「確認済み」になっていることを確認できます。
注意点
さて、ここで2点ほど注意点（というかはまったポイント）を紹介します。
import requestsできない
上記のコードはそのままでは実行できません。
requestsは外部モジュールなので、Lambdaで使えるように環境構築してあげる必要があります。
まずrequestsモジュールをローカルにインポート後zip化してから、zipをLambdaにアップロードします。
以下の記事を参考にしました。
https://hacknote.jp/archives/48083/
zip化できるならコマンドでもツール（7zipとか）でも構いません。
pipコマンドは使えるようにしなきゃいけませんね…。
- SubscribeURLを取得できない
これ、めちゃくちゃはまりました。
Amazon SNSから取得したリクエストeventはdict型だと思っていたのですが、
eventを掘り下げていくとbody部分が文字列になっていて、SubscribeURLを参照できなかった。。。
以下の素晴らしい記事を参考に解決できました。よかった。
https://dev.classmethod.jp/articles/lambda-python-tips-all-events-are-not-dict/
Amazon SNSから通知を送る
最後にPublishしていきましょう。
今回は特にトリガーとなる処理を用意していないので、コンソールから手動でエンドポイントに通知します。
メッセージの発行
エンドポイントでメッセージを受信したことの確認
ちゃんとエンドポイントに設定したLambdaの処理が行われていることを確認できました。
最後に
これでなんとなくAmazon SNSからHTTP/Sで受信するときの動きがわかったような気がします。
また何か発見があったら更新します。