AWS CLI –query パラメーターによる部分一致条件

AWS CLI でのコマンド出力結果は、--query パラメーターによってフィルタリングできます。このたび、プロパティ値の「完全一致」「部分一致」「前方一致」「後方一致」で抽出する方法を調べたので、メモしておきます。

–query パラメータについての超概要

--query パラメーターは、コマンドの出力に対して様々なフィルタリングを行うために利用できます。たとえば次のようなことができます：

なお、--query パラメーターによるフィルタリングは、クライアントサイドで実行されます。

詳しくは、AWS 公式ドキュメントにまとめられています。

Filtering output in the AWS CLI – AWS Command Line Interface

AWS CLI からの出力の形式を制御します。

CloudWatch のロググループを、ロググループ名で抽出してみます。

特に条件を指定しない場合：

aws logs describe-log-groups --query "logGroups[].logGroupName"

[
    "/aaa/cli/test/111",
    "/bbb/cli/test/222",
    "/test/aaa/cli/test/111/test",
    "/test/bbb/cli/test/222/test"
]

単に等号で比較します。

aws logs describe-log-groups --query "logGroups[?logGroupName=='/aaa/cli/test/111'].logGroupName"

[
    "/aaa/cli/test/111"
]

contains 関数を使用します。

aws logs describe-log-groups --query "logGroups[?contains(logGroupName, '/aaa')].logGroupName"

[
    "/aaa/cli/test/111",
    "/test/aaa/cli/test/111/test"
]

starts_with 関数を使用します。

aws logs describe-log-groups --query "logGroups[?starts_with(logGroupName, '/aaa')].logGroupName"

[
    "/aaa/cli/test/111"
]

ends_with 関数を使用します。

aws logs describe-log-groups --query "logGroups[?ends_with(logGroupName, '/111')].logGroupName"

[
    "/aaa/cli/test/111"
]

contains 関数を使用する例は、結構さまざまな Web サイトで見つかったのですが、前方一致と後方一致は意外と触れられていなかったので、まとめました。

--query パラメーターの記述には JMESPath 構文を使用するので、何かやりたいことがある場合は JMESPath のリファレンスを参照すると良いと思います。

JMESPath

The JMESPath language is described in an ABNF grammar with a complete specification. This ensures that the language syntax is precisely defined.