Alexaスキル（C#）からDynamoDBにアクセスするには？（テーブル作成まで）

2018年11月9日追記

Waitメソッドによって非同期メソッド（CreateTableAsync）の完了を待機することでDynamoDBへテーブル作成処理をちゃんと完了させるようにしました。
が、こちらの方の非同期処理に関する記事を読んで、Resultプロパティを使って非同期メソッドの結果も取得した方が汎用的と思い、Waitメソッドではなく、Resultプロパティを使うように修正しました。
ありがとうございました。

2018年11月9日追記2

CreateTableしたときに、同名のテーブルが存在すると例外が発生してしまいます。
これを回避するために、CreateTableの前にテーブルの存在確認をするようにしました。
テーブルの存在確認は、ListTablesAsyncメソッドによってテーブルの一覧を取得し、指定した名前のテーブルが存在するかをLinqのExistsメソッドを使って確認しているだけのシンプルなものです。

はじめに

この記事で、公式Alexaチュートリアル第3回の内容をC#で実装しました。

次は第4回になるわけですが、第4回は永続的なデータの保持ということでデータをDynamoDBに保存する、という内容になっています。

そこでまずはC#からDynamoDBにアクセスする方法を学ばなければなりません。
今回はそういう内容です。

準備

公式Alexaチュートリアル第4回を完了しておいてください。Node.jsでそのままやってくださってOKです。
なぜかというと、チュートリアルではSDK for Node.jsが提供しているsetPersistentAttributesメソッドを使ってDynamoDBにデータを保存しているのですが、どのような情報がどのような形で保存されるのかを確認するためです。

SDK for Node.jsのメソッドを使えばDynamoDBにデータを保存するときのあれやこれやをよろしくやってくれるので、開発者はメソッド一発でデータをDynamoDBに保存することができます。

しかし、C#の場合、それを自分でやる必要があるため、こうして確認し、そのとおりにデータを保存してみようという考えです。

DynamoDB上でのデータの形式を確認

公式チュートリアル第4回を完了して、スキルをひととおり動かすとDynamoDBにはユーザーの星座データが保存されます。
AWSのウェブコンソールでDynamoDB内のデータを見てみましょう。
DynamoDBを選択して、左側の一覧から「テーブル」を選択すると、おそらく「HoroscopeSkillTable」かもしくはスキル名を冠したテーブルが表示されると思います。

このテーブルをクリックして開き、右側のタブから「項目」を選択すると、以下のようにテーブルの内容が表示されます。

idとattributesという2つの列を持つテーブルです。

idって何？

このidというのはリクエストのJSONでいうところのuserId項目になります。このuserIdは何かというと、こちらに説明のあるとおり、利用者のユニークなIDです。
そのスキルが有効（インストール）にされたときに割り当てられ、そのスキルがいつか無効にされるまではそのスキルの利用において同じIDが使われます。

Alexaスキルのテストを行うと毎回違うIDになってしまいますが、実際には上記のとおりになるということです。

attributesは？

テストのために、公式チュートリアル第4回のコードに、「test」というキーで整数「5」を追加しています。

        //永続アトリビュートの取得
        const persistentAttributes = await attributesManager.getPersistentAttributes();//
        persistentAttributes.sign = sign;
        ///////////テスト用・追加////////////
        persistentAttributes.test=5;//整数を入れてみる

DynamoDBにはこんな感じでデータが保存されます。

中はこんな感じと。

C#でDynamoDBにアクセスしよう

準備

AWSSDK.DynamoDBv2のインストール（Nugetで）

C#からDynamoDBにアクセスするにはどうしたら良いのか調べてみると、AmazonさんがそのためのパッケージをNugetで配布してくれていました。
それが「AWSSDK.DynamoDBv2」です。

これをインストールします。

テスト用のAWS Lambdaプロジェクトを作成

次はAlexaスキルから呼び出してDynamoDBにテーブルを作るテストをするためだけのAWS Lambdaプロジェクトを作りましょう。
テストするなら実際と同じ環境でテストしたいですからね。
こちらの記事を読んでいただいて、プロジェクトの作成と「Alexa.NET」のインストールをしてください。
そして、Function.csの内容は以下のようなリクエストを受け取ってレスポンスを返すだけのシンプルな状態にしておきます。

Function.cs

using System.Threading.Tasks;
using Amazon.Lambda.Core;
using Alexa.NET.Request;
using Alexa.NET.Response;


// Assembly attribute to enable the Lambda function's JSON input to be converted into a .NET class.
[assembly: LambdaSerializer(typeof(Amazon.Lambda.Serialization.Json.JsonSerializer))]

namespace DynamoDBTest
{
    public class Function
    {

        /// <summary>
        /// A simple function that takes a string and does a ToUpper
        /// </summary>
        /// <param name="input"></param>
        /// <param name="context"></param>
        /// <returns></returns>
        public SkillResponse FunctionHandler(SkillRequest input, ILambdaContext context)
        {
            //ここにDynamoDBにアクセスするコードを追加していく

            return new SkillResponse
            {
                Version = "1.0",
                Response = new ResponseBody()
            };
        }
    }
}

まずはテーブル作成

テーブルを作成するコードを追加します

こちらにC#からDynamoDBへアクセスするサンプルコードが掲載されています
ので、これを参考にします。
これはコマンドラインアプリケーションからDynamoDBにアクセスするサンプルコードなので、AWS Lambdaから利用する場合はいくらか調整する必要があります。

調整の結果が以下です。

Function.cs

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Amazon.Lambda.Core;
using Alexa.NET.Request;
using Alexa.NET.Response;
using Amazon.DynamoDBv2;
using Amazon.DynamoDBv2.Model;


// Assembly attribute to enable the Lambda function's JSON input to be converted into a .NET class.
[assembly: LambdaSerializer(typeof(Amazon.Lambda.Serialization.Json.JsonSerializer))]

namespace DynamoDBTest
{
    public class Function
    {
        /// <summary>
        /// A simple function that takes a string and does a ToUpper
        /// </summary>
        /// <param name="input"></param>
        /// <param name="context"></param>
        /// <returns></returns>
        public SkillResponse FunctionHandler(SkillRequest input, ILambdaContext context)
        {
            //ここにDynamoDBにアクセスするコードを追加していく
            string tableName = "TestTable";//テーブル名
            AmazonDynamoDBClient client = new AmazonDynamoDBClient();//主役。これを介してDynamoDBにアクセスする

            //同名テーブルの存在確認
            if (!IsTableExist(client, tableName))
            {
                //テーブルを作成
                CreateTable(client, tableName);
            }

            return new SkillResponse
            {
                Version = "1.0",
                Response = new ResponseBody()
            };
        }


        /// <summary>
        /// DynamoDBにテーブルを作成する
        /// </summary>
        /// <param name="client"></param>
        /// <param name="tableName"></param>
        private void CreateTable(IAmazonDynamoDB client,string tableName)
        {
            //リクエストを構築
            var request = new CreateTableRequest
            {
                //テーブルの列情報を設定
                //「ThisIsId」と「ThisIsSomthing」という2つの列を持つテーブルを作る
                AttributeDefinitions = new List<AttributeDefinition>()
                {
                    new AttributeDefinition
                    {
                        AttributeName = "ThisIsId",//カラム名
                        AttributeType = "N"
                    },
                    new AttributeDefinition
                    {
                        AttributeName = "ThisIsSomething",//カラム名
                        AttributeType = "N"
                    }
                },
                //勉強中
                KeySchema = new List<KeySchemaElement>
                {
                    new KeySchemaElement
                    {
                        AttributeName = "ThisIsId",
                        KeyType = "HASH" //Partition key
                    },
                    new KeySchemaElement
                    {
                        AttributeName = "ThisIsSomething",
                        KeyType = "RANGE" //Sort key
                    }
                },
                //勉強中
                ProvisionedThroughput = new ProvisionedThroughput
                {
                    ReadCapacityUnits = 5,
                    WriteCapacityUnits = 5
                },
                //テーブル名
                TableName = tableName
            };

            //テーブル作成リクエストを投げる！
            //ただし、非同期メソッドの返りを待たねければならない。
            //待たないと先にこのLambdaが終了して、DynamoDBのテーブル作成処理を完了せずに終わる。
            //でもメソッドにasyncつけたら、最終的にスキルのレスポンスの型もTask<SkillResponse>にしなきゃいけなくなってだめ。
            //.Wait()メソッドで非同期メソッドを同期メソッドにしちゃえば、返り値も変えなくていいし、テーブル作成完了まで待つことができる。
            //一回完結のサーバー側の処理で非同期でなきゃいけない理由ないしね。
            //client.CreateTableAsync(request).Wait();

            //Waitメソッドではただ非同期メソッドの完了を待つだけでしたが、非同期メソッドの返り値を取得したい場合は、Resultプロパティを使いましょう。
            //Resultプロパティにアクセスすることで、非同期メソッドの完了を待った上で結果を取得することができます。
            //結果を使って何か処理を行いたい場合はこちらが良いのではないでしょうか。
            var result=client.CreateTableAsync(request).Result;
        }


        /// <summary>
        /// 同名のテーブルが存在するかをチェックします。
        /// </summary>
        /// <param name="client"></param>
        /// <param name="tableName"></param>
        /// <returns></returns>
        private bool IsTableExist(IAmazonDynamoDB client,string tableName)
        {
            //テーブル一覧を取得
            var tableList=client.ListTablesAsync().Result;
            //TableNamesプロパティをチェック
            return tableList.TableNames.Exists(s => s.Equals(tableName));
        }
    }
}

公式ページのサンプルコードでは同期メソッドのCreateTableメソッドが使用されていましたが、今はCreateTableAsyncしか提供されていないんですかね？
ともかく、スキルとしての返り値の制限からasync、awaitを使った非同期メソッドの利用はできないので、非同期メソッドを同期メソッドとして使えば問題はないということです。

AWS Lambdaにデプロイします

デプロイの方法はこれまたこちらを参考にしていただくとして、一つ注意があります。
それは「Role」についてです。
今回はDynamoDBにアクセスするので、このプログラムにその権限を与える必要があります。
AWSコンソールでIAMの設定から必要な権限（ポリシー）を持ったロールを作成するとよいのですが、とりあえずここではデプロイ時に選択できるロールとして「AWSLambdaFullAccess」というとても力強いポリシーのものを選びます。

動作確認

デプロイが完了したら動作確認しましょう。
サンプルリクエストとして「Alexa Start Session」を選択します。

レスポンスが返ってきたら、AWSコンソールでDynamoDBにテーブルが追加されているか確認します。

「TestTable」が追加されています。やったね！
ということで、これでC#を使ってAWS_LambdaからDynamoDBにアクセスする第一歩が踏み出せました。

課題

DynamoDBに送るリクエストの構築部分がよくわかっていません。
カラム名の指定のところは見てわかるのですが、KeySchemeとProvisionedThroughputがわかっていません。
調べてわかったら追記します。