【初心者向け】AWS CLIリファレンスを読むときのコツ

はじめに

こんにちは、大阪オフィスのちゃだいんです。

「AWS CLI を使うぞ！」ってなってリファレンスを開くと、 全文英語ページをひらいた途端「うっ」ってなることないですか？私は毎回なってます。

公式リファレンスは、一定の知識者であれば難なくフムフムできることも、 初心者の場合なんて事のないことでもつまずいたりします。

つまずきほうけた中で、気づいたことをまとめてみました。

今回は例として、aws s3 ls　をみながらご紹介します。

AWS CLI コマンドリファレンス s3 ls

 

↓↓↓AWS CLIの初期設定についてはこちら↓↓↓

【初心者向け】MacユーザがAWS CLIを最速で試す方法

1. Chromeのgoogle翻訳アドインを入れる

すでに導入している人も多いと思いますが、

google翻訳のchrome拡張機能を入れておくと、英文の翻訳作業が一瞬です！

実際使ってみるとワンクリックでこんな感じ。

まだの人はこちらからどうぞ。

Google 翻訳 - Google Chrome

2. まずExamplesから読みはじめる

上から順番に読むのではなく、ざっと一番下まで行ってみて、Examplesがあればそこから読み始めてください。

結局どうしたらどうなるの？がわかりやすいのは、やはり例文です。

ただし、全てのページに例文があるわけではないのでご注意ください。（カンタンなのでもいいから全てにつけて欲しいと切に願います……）

 

公式ドキュメント以外で例文が欲しい時、以下コンテンツがすごく充実してます。

 [JAWS-UG CLI] ハンズオン一覧

3. とりあえずやってみる

わからない場合は、試してみるのが一番。

百見は一行にしかずですよね。今すぐその場で試せるのがクラウドの恩恵なのですぐにやってみます。

 

4. 各章のカンタンな解説

Description（説明）

コマンドの説明が書かれています。

ポイントはgoogle翻訳でざっと全体をなめるのが良さそうです。

Synopsis（概要）

シノプシスは概要という意味だそうですが、要はコマンドの公式みたいなものを書いてます。

今回の例であるaws cli s3 ls の場合、

  ls
<S3Uri> or NONE
[--recursive]
[--page-size <value>]
[--human-readable]
[--summarize]
[--request-payer <value>]

[ ] は必須ではなく任意なので、必要に応じて使用してください。（なくても実行できる）

ここでAWS CLIコマンドの構成をおさらいをすると、下図のような構成になっています。(かなり古いんですがわかりやすいスライドだったので引用します）

引用元 AWS Black Belt Tech シリーズ 2015 AWS CLI & AWS Tools for Windows Powershell

Options（オプション）

Synopsisで記載されていた、各オプションに関する解説です。

ここでオプションに引数が必要な場合、入れる文字の形式指定（データ型）があります。

主なデータ型の一覧は以下です。

パラメータタイプ

• string：文字列（abcdefg）
• timestamp：タイプスタンプ形式（YYYY-MM-DDThh:mm:ss.sssTZD）
• list：半角スペースで区切られた文字列たち（aaa bbb ccc）
• boolean：真=true と偽=falseという2値をとるデータ型（01で表現される）
• integer：整数　　など

Examples（実例）

この項目がある場合はラッキーです。

何より先にここから読み始めます。

Output（出力）

コマンド実行後に、結果何かを出力する場合、ここに記載されています。

しかし、いきなりここを読んでもよくわからないので、

実際にやってみて何が出力されるのかをみてみるのが良さそうです。

終わりに

世の中のいろんな解説記事にお世話になりつつ、でもちゃんと公式リファレンスがある以上、それをスラスラ読めて理解できたらな〜なんて思います。

もっとわかりすくなる方法など見つけたら改めてご紹介します。それではまた！