書き方に少々クセがあるのが難点ですが、使いこなすとワンコマンドでだいたい事足りるようになるのでCIなどで助かります。awscliを使うひとは覚えておいて損はないです。

JMESPathのリファレンスは以下です。

• http://jmespath.org/tutorial.html
• http://jmespath.org/specification.html

JMESPathはjson形式の構造に対してXPathチックにアクセスできるクエリ言語です。awscliでは–queryオプションがこれに対応しています。

最低限覚えておくとよいこと

• Resources[](空ブラケット)とResouces[*](アスタリスク)は等価、子要素をトップルートとして取り出せる
• リスト化したいだけなら Resources[].Idの書き方が一番ラク、複数カラムならResouces[].[Id,Arn]とカンマ区切りで指定
• 要素の添字(ブラケット)内に?を置くことで関数モード的な扱いになる
• 関数はとりあえずcontainsを覚えておけばなんとかなる
  • 例：

      $ aws iam list-policies --query 'Policies[?contains(Arn,`arn:aws:iam::aws`)].Arn'
      $ aws iam list-policies --query 'Policies[?contains(Arn,to_string(`999999999999`))].Arn'
    

• containsの第二引数にはバッククォートを使うので、クエリ全体はシングルクォーテーションで囲うとエスケープの手間が省けてよい
• awscliの--outputを組み合わせられることを意識するとより一層便利に
• Pipeが使える、aws iam list-policies --query 'Policies[*].{m:PolicyName} | [0]'のように書ける

気をつけるところ

• containsの第一引数にいれる@は検査対象がarray型かstring型でなければならない、object型には使えない
• ほか、containsの第二引数(String型を要求)など、各種関数の引数の型に注意

所感

私のユースケースとしては結局扱うのはawscliのレスポンスがほとんどなので、 あまり多くの関数を使いこなすようなことはせず、 最低限containsだけ使えるようになっていれば十分なのかなという評価でした。

型やクォートなどに少し気をつける必要はありますが、コマンドやクエリをスニペット化しておけば低コストに運用できそうです。

パターン集

起動中の instance のうち、指定タグ（今回はExample）が「付いていない」 instance id を列挙する

aws ec2 describe-instances --filters Name=instance-state-name,Values=running --query 'Reservations[].Instances[?!not_null(Tags[?Key == `Example`].Value)] | [].InstanceId'

instance id を半角スペース区切りでjoinして列挙する

aws ec2 describe-instances --query 'Reservations[].Instances[].InstanceId | join(`" "`, @)' --output text

# カンマ区切りなら
aws ec2 describe-instances --query 'Reservations[].Instances[].InstanceId | join(`","`, @)' --output text

AAAというタグはhogeでBBBというタグはfugaではなくInstanceProfileにmogaが含まれる instance id を配列で列挙する

aws ec2 describe-instances --query 'Reservations[].Instances[?(Tags[?Key==`AAA`].Value|[0]==`"hoge"`) && !(Tags[?Key==`BBB`].Value|[0]==`"fuga"`) && (contains(IamInstanceProfile.Arn,`"moga"`))] | [].[InstanceId]'