AWS CLI を使用した Amazon QLDB へのアクセス (コントロールプレーンのみ) - Amazon Quantum Ledger Database (Amazon QLDB)

AWS CLI を使用した Amazon QLDB へのアクセス (コントロールプレーンのみ)

AWS Command Line Interface (AWS CLI) を使用すると、複数の AWS のサービスをコマンドラインから制御したり、スクリプトで自動化したりできます。AWS CLI はアドホックオペレーションに使用できます。また、ユーティリティスクリプトへの Amazon QLDB オペレーションの埋め込みにも使用できます。

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

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

注記

AWS CLI では、Amazon QLDB API リファレンス に示されている qldb コントロールプレーン API オペレーションのみがサポートされています。これらのアクションは、台帳の管理および非トランザクションデータオペレーションにのみ使用されます。

コマンドラインインターフェイスで qldb-session API を使用してデータトランザクションを実行するには、「QLDB シェルを使用した Amazon QLDB へのアクセス (データプレーンのみ)」を参照してください。

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

AWS CLI は、Windows、macOS または Linux 上で作動します。ダウンロード、インストールおよび設定するには次の手順に従います。

  1. http://aws.amazon.com/cli で AWS CLI をダウンロードします。

  2. AWS Command Line Interface ユーザーガイド の「AWS CLI のインストール」と「AWS CLI の設定」の手順に従います。

QLDB での AWS CLI の使用

コマンドラインの形式は、Amazon QLDB オペレーション名の後に、そのオペレーション用のパラメータが続く形式です。AWS CLI は、JSON に加え、パラメータ値の短縮構文もサポートしています。

help を使用すると、QLDB で使用可能なすべてのコマンドを列挙できます。

aws qldb help

また help を使用して、特定コマンドを記述したり、その用法の詳細を確認したりすることもできます。

aws qldb create-ledger help

たとえば、台帳を作成するには以下のようにします。

aws qldb create-ledger --name my-ledger --permissions-mode ALLOW_ALL