[Boto3]空要素を無視してJSONデータをDynamodbに書き込む方法

Question

AWS DynamoDBに下記のような問題データを書き込みたいと考えています。
問題データは100問ほどありますが、必ずしも画像を必要としないため、image_urlがあるものとないものが混在します。

(questionList.json)

{
      "q_id" : "001",
      "q_body" : "日本の首都はどこか。",
      "q_answer" : "東京",
      "image_url" : "/tokyo.jpg",
      "keywords" : [
        "日本",
        "東京"
      ]
    },
    {
      "q_id" : "002",
      "q_body" : "アメリカの首都はどこか。",
      "q_answer" : "ワシントンD.C",
      "image_url" : "",
      "keywords" : [
        "アメリカ",
        "ワシントンD.C."
      ]
    },

書き込みテスト段階なので、書き込み先のDynamodbは本番環境ではなく、serverlessフレームワークのserverless-dynamodb-localプラグインを使用したlocalhost:8000に用意しています。

上記のJSONデータをこのDynamodbに書き込むために、Boto3(AWS SDK for Python)で下記のようなコードを記述しました。

(questionListLoad.py)

from __future__ import print_function
import boto3
import codecs
import json

dynamodb = boto3.resource('dynamodb', region_name='ap-northeast-1', endpoint_url="http://localhost:8000")

table = dynamodb.Table('questionListTable')

with open("questionList.json", "r", encoding='utf-8_sig') as json_file:
    items = json.load(json_file)
    for item in items:
        q_id = item['q_id']
        q_body = item['q_body']
        q_answer = item['q_answer']
        image_url = item['image_url']
        keywords = item['keywords']

        print("Adding detail:", q_id, q_body)

        table.put_item(
            Item={
                'q_id': q_id,
                'q_body': q_body,
                'q_answer': q_answer,
                'image_url': image_url,
                'keywords': keywords,
            }
        )

このコードを実行すると、空文字の部分で下記のようなエラーが発生します。

botocore.exceptions.ClientError: An error occurred (ValidationException) when calling the PutItem operation: One or more parameter values were invalid: An AttributeValue may not contain an empty string

どうやらJSONの空文字が原因のようです。
試しに空文字を含むimage_urlを下記のように書き込み対象から外すと、問題なく書き込みが完了しました。

with open("questionList.json", "r", encoding='utf-8_sig') as json_file:
    details = json.load(json_file)
    for detail in details:
        q_id = detail['q_id']
        q_body = detail['q_body']
        q_answer = detail['q_answer']
        #image_url = detail['image_url']
        keywords = detail['keywords']

        print("Adding detail:", q_id, q_body)

        table.put_item(
            Item={
                'q_id': q_id,
                'q_body': q_body,
                'q_answer': q_answer,
                #'image_url': image_url,
                'keywords': keywords,
            }
        )

DynamoDBはNoSQLなので、特性を活かした上手な方法が他にあるかも知れませんが、上記のようなデータを空文字を無視して書き込むためには、どのようにコードを修正すればよいでしょうか。「もしimage_urlが存在するなら書き込む。なければ無視する」ということがしたいです。

よろしくお願いします。

Answer 1

Node.jsでは空文字をNULL型にすることは可能らしいですがboto3においてはまだ未対応なようです
(feature-requestとして同様の機能の要望は挙がっているようです)

NodeではconvertEmptyValuesというオプションがあるようです
DynamoDB は空の値を登録できないけど DynamoDB document client のコンストラクタにオプションを渡すだけで空の値を NULL 型には変換できるよ？

Comments

[退会済みユーザー]

貴重な情報ありがとうございます。引用して頂いた記事は、どこかで見た気がしたけど思い出せなかったものなので助かりました。またNodeを利用する際には参考にさせてもらいます。

Answer 2

An AttributeValue may not contain an empty string
ということなので、空白文字かnull(None)を設定すれば良いのではないでしょうか。

私の環境では以下で問題なく動作しました。

...
        image_url = item['image_url'] if item['image_url'] else None
...

Comments

[退会済みユーザー]

ありがとうございます！解決法に基づき、無事データを書き込むことができました。

Answer 3

moonphaseさんの解答に基づき、コードを変更したところ、問題なくデータを書き込むことができました。テスト段階では、image_urlほかkeywordsにも空白が含まれていたため、次のように変更しています。

from __future__ import print_function
import boto3
import codecs
import json

dynamodb = boto3.resource('dynamodb', region_name='ap-northeast-1', endpoint_url="http://localhost:8000")

table = dynamodb.Table('questionListTable')

with open("questionList.json", "r", encoding='utf-8_sig') as json_file:
    items = json.load(json_file)
    for item in items:
        q_id = item['q_id']
        q_body = item['q_body']
        q_answer = item['q_answer']
        image_url = item['image_url'] if item['image_url'] else None
        keywords = item['keywords'] if item['keywords'] else None

        print("Adding detail:", q_id, q_body)

        table.put_item(
            Item={
                'q_id': q_id,
                'q_body': q_body,
                'q_answer': q_answer,
                'image_url': image_url,
                'keywords': keywords,
            }
        )

Dynamodbの状況を確認するために、serverlessフレームワークのofflineプラグインを利用して、ローカル環境にAPI Gatewayを実行させます。Postmanを用いて実際にAPIを呼んだところ、値にはNullがきちんと挿入されていました。

{
      "q_id" : "001",
      "q_body" : "日本の首都はどこか。",
      "q_answer" : "東京",
      "image_url" : "/tokyo.jpg",
      "keywords" : [
        "日本",
        "東京"
      ]
    },
    {
      "q_id" : "002",
      "q_body" : "アメリカの首都はどこか。",
      "q_answer" : "ワシントンD.C",
      "image_url" : "null",
      "keywords" : [
        "アメリカ",
        "ワシントンD.C."
      ]
    },