Amazon DynamoDB
開発者ガイド (API バージョン 2012-08-10)

CLI の使用

AWS Command Line Interface (AWS CLI) を使用すると、複数の AWS のサービスをコマンドラインから制御したり、スクリプトで自動化したりできます。テーブルの作成など、その場限りのオペレーションに AWS CLI を使用できます。ユーティリティスクリプト内に Amazon DynamoDB オペレーションを埋め込む際に使用することもできます。

DynamoDB を使用して AWS CLI を使用するには、アクセスキー ID とシークレットアクセスキーを取得する必要があります。詳細については、「AWS Access Key の取得」を参照してください。

AWS CLI で DynamoDB 向けに使用できるすべてのコマンドの完全な一覧については、「AWS CLI コマンドリファレンス」を参照してください。

AWS CLI のダウンロードと設定

AWS CLI は、http://aws.amazon.com/cli からアクセスできます。Windows、macOS、または Linux 上で実行できます。AWS CLI をダウンロードしたら、以下の手順に従って、インストールと設定を行います。

  1. AWS Command Line Interface ユーザーガイド に移動します。

  2. AWS CLI をインストールし、AWS CLI を設定する手順に従います。

DynamoDB で AWS CLI を使用する

コマンドラインの形式は、DynamoDB オペレーション名と、それに続くそのオペレーションのパラメータで構成されます。AWS CLI では、パラメータ値の短縮構文および JSON をサポートしています。

たとえば、次のコマンドでは、Music という名前のテーブルを作成します。パーティションキーは Artist で、ソートキーは SongTitle です。(読みやすくするために、このセクションの長いコマンドは、複数の行に分かれています)。

aws dynamodb create-table \ --table-name Music \ --attribute-definitions \ AttributeName=Artist,AttributeType=S \ AttributeName=SongTitle,AttributeType=S \ --key-schema AttributeName=Artist,KeyType=HASH AttributeName=SongTitle,KeyType=RANGE \ --provisioned-throughput ReadCapacityUnits=1,WriteCapacityUnits=1

次のコマンドでは、新しい項目をテーブルに追加します。この例では、短縮構文と JSON を組み合わせて使用しています。

aws dynamodb put-item \ --table-name Music \ --item \ '{"Artist": {"S": "No One You Know"}, "SongTitle": {"S": "Call Me Today"}, "AlbumTitle": {"S": "Somewhat Famous"}}' \ --return-consumed-capacity TOTAL aws dynamodb put-item \ --table-name Music \ --item '{ \ "Artist": {"S": "Acme Band"}, \ "SongTitle": {"S": "Happy Day"}, \ "AlbumTitle": {"S": "Songs About Life"} }' \ --return-consumed-capacity TOTAL

コマンドラインで、有効な JSON を作成するのは難しい場合があります。ただし、AWS CLI で JSON ファイルを読み込むことができます。たとえば、key-conditions.json という名前のファイルに格納されている次の JSON コードスニペットがあるとします。

{ "Artist": { "AttributeValueList": [ { "S": "No One You Know" } ], "ComparisonOperator": "EQ" }, "SongTitle": { "AttributeValueList": [ { "S": "Call Me Today" } ], "ComparisonOperator": "EQ" } }

次のように、AWS CLI を使用して、Query リクエストを発行できます。この例では、key-conditions.json ファイルの内容は、--key-conditions パラメータに使用されます。

aws dynamodb query --table-name Music --key-conditions file://key-conditions.json

ダウンロード可能な DynamoDB での AWS CLI の使用

AWS CLI を使用して、コンピュータで実行されている DynamoDB (ダウンロード可能なバージョン) を操作することもできます。これを有効にするには、各コマンドに次のパラメータを追加します。

--endpoint-url http://localhost:8000

次の例では、AWS CLI を使用して、ローカルデータベースのテーブルを一覧表示します。

aws dynamodb list-tables --endpoint-url http://localhost:8000

DynamoDB がデフォルト (8000) 以外のポート番号を使用している場合は、それに応じて --endpoint-url 値を変更する必要があります。

注記

AWS CLI では、ダウンロード可能なバージョンの DynamoDB をデフォルトのエンドポイントとして使用することはできません。そのため、各コマンドで --endpoint-url を指定する必要があります。