ブラウザのURLからAPI Gateway(REST API)＋Lambda(Python)経由でDynamoDBを操作してみた第1回

ブラウザからいろいろな操作ができると便利なので試しにDynamoDBを操作する仕組みを作ってみた。※タイトルが長い。。

◆やること

ブラウザのURL(https://xxx.com/[resource]?[key]=[value]のような形)でAPI Gateway(REST API)に接続し、バックエンドのLambda(Python)からDynamoDBに接続する。
※今回はDynamoDBからデータを取得するまでを実施する。

構成

◆実践！

１．IAMポリシー作成
　１－１．[IAM]-[ポリシー]-[ポリシー作成]
　１－２．JSONに下記を入力

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "Stmt1428341300017",
      "Action": [
        "dynamodb:DeleteItem",
        "dynamodb:GetItem",
        "dynamodb:PutItem",
        "dynamodb:Query",
        "dynamodb:Scan",
        "dynamodb:UpdateItem"
      ],
      "Effect": "Allow",
      "Resource": "*"
    },
    {
      "Sid": "",
      "Resource": "*",
      "Action": [
        "logs:CreateLogGroup",
        "logs:CreateLogStream",
        "logs:PutLogEvents"
      ],
      "Effect": "Allow"
    }
  ]
}

　１－３．確認して作成画面が表示されたら下記を入力
　　・ポリシー名：lambda-dynamo-policy
　　・説明：空白
　１－４．[ポリシーの作成]をクリック

２．ロール作成
　２－１．[IAM]-[ロール]-[ロールを作成]
　２－２．信頼されたエンティティを選択が表示されたら下記を入力
　　・信頼されたエンティティタイプ：AWSのサービス
　　・ユースケース：Lambda
　２－３．[次へ]をクリック
　２－４．許可を追加が表示されたら[lambda-dynamo-policy]を選択
　２－５．[次へ]をクリック
　２－６．ロール名は[lambda-dynamo-role]を入力し、[ロールを作成]をクリック

３．DynamoDBテーブル作成
　３－１．[DynamoDB]-[テーブル]-[テーブルの作成]
　３－２．テーブルの作成画面が表示されたら下記を入力
　　・テーブル名：sample-dynamodb
　　・パーティションキー：id
　３－３．[テーブルの作成]をクリック

４．DynamoDB項目作成
　４－１．[DynamoDB]-[テーブル]-[sample-dynamodb]
　４－２．[アクション]-[項目を作成]
　４－３．下記を入力
　　・id：123
　　・value：test ※[新しい属性の追加]-[文字列]で追加して入力する

５．Lambda関数作成
　５－１．[Lambda]-[関数]-[関数の作成]
　５－２．関数の作成画面が表示されたら下記を入力
　　・一から作成：✅
　　・関数名：sample-function
　　・ランタイム：Python3.10
　　・実行ロール：既存のロールを使用する
　　・既存のロール：lambda-dynamo-role
　５－３．[関数の作成]をクリック
　５－４．コードに下記を入力
　　※POSTやPUT、DELETEもあるが今回はGETのみ使用

import json
import boto3

# DynamoDB クライアントの作成
dynamodb = boto3.client('dynamodb')
table_name = 'sample-dynamodb'


def lambda_handler(event, context):
    method = event["httpMethod"]
    
    if method == "GET":
        return get(event, context)
    elif method == "POST":
        return post(event, context)
    elif method == "PUT":
        return put(event, context)
    elif method == "DELETE":
        return delete(event, context)
    else:
        return {
            "statusCode": 400,
            "body": json.dumps({"error": "Unsupported method"})
        }
        
def get(event, context):
    id = event["queryStringParameters"]["id"]
    options = {
        'TableName': table_name,
        'Key': {
            'id': {'S': id},
        }
    }
    response = dynamodb.get_item(**options)
    
    if 'Item' in response:
        return {
            "statusCode": 200,
            "body": json.dumps(response[Item])
        }
    else:
        return {
            "statusCode": 404,
            "body": json.dumps({"error": "Item not found"})
        }

６．Lambdaテスト
　６－１．作成したLambda関数を選択し、[Test]をクリック
　６－２．テストイベントを設定が表示されたら下記を入力
　　・新しいイベントを作成：✅
　　・イベント名：MyEvent
　　・イベントJSON：下記を入力

{
    "httpMethod": "GET",
    "queryStringParameters": {
        "id": "123"
    }
}

　６－３．[Test]をクリック
　６－４．下記のように返答が返ってくることを確認

Response
{
  "statusCode": 200,
  "body": "{\"Item\": {\"id\": {\"S\": \"123\"}, \"value\": {\"S\": \"test\"}}, \"ResponseMetadata\": {\"RequestId\": \"4706DNS6IB93JOE09NC25FEFN3VV4KQNSO5AEMVJF66Q9ASUAAJG\", \"HTTPStatusCode\": 200, \"HTTPHeaders\": {\"server\": \"Server\", \"date\": \"Sun, 07 May 2023 08:03:42 GMT\", \"content-type\": \"application/x-amz-json-1.0\", \"content-length\": \"48\", \"connection\": \"keep-alive\", \"x-amzn-requestid\": \"4706DNS6IB93JOE09NC25FEFN3VV4KQNSO5AEMVJF66Q9ASUAAJG\", \"x-amz-crc32\": \"2920716868\"}, \"RetryAttempts\": 0}}"
}

７．API Gateway作成
　７－１．[API Gateway]-[REST API]内の[構築]をクリック
　７－２．[新しいAPI]を選択し、下記を入力
　　・API名：SampleAPI
　　・説明：空白
　　・エンドポイントタイプ：リージョン
　７－３．[APIの作成]をクリック
　７－４．[アクション]プルダウンから[メソッドの作成]を選択
　７－５．追加されたプルダウンから[GET]を選択
　７－６．[GET]の隣の✅をクリック
　７－７．右ペインに/ - GET - セットアップが表示されたら下記を入力
　　・統合タイプ：Lambda 関数
　　・Lambdaプロキシ統合の使用：✅
　　・Lambdaリージョン：ap-northeast-1
　　・Lambda関数：sample-function
　　・デフォルトタイムアウトの使用：✅
　７－８．[保存]をクリック
　７－９．[アクション]プルダウンから[APIのデプロイ]を選択
　７－１０．APIのデプロイウインドウが表示されたら下記を入力
　　・デプロイされるステージ：[新しいステージ]
　　・ステージ名：test
　　・ステージの説明：空白
　　・デプロイメントの説明：空白
　７－１１．[デプロイ]をクリック

８．API Gateway動作確認
　８－１．API Gateway-[API]-[sample-api]
　８－２．左ペイン[ステージ]-[test]-[URLの呼び出し]をクリック
　８－３．URLの末尾に[?id=123]を追記
　　例）https://xxxxx.execute-api.ap-northeast-1.amazonaws.com/test?id=123
　　※valueが表示されることを確認