About the examples in the AWS CLI User Guide

本ガイドの AWS Command Line Interface (AWS CLI) 例は、以下の規則を使用してフォーマットされています。

• プロンプト – コマンドプロンプトは Linux プロンプトを使用し、($ ) として表示されます。Windows 固有のコマンドの場合、C:\> がプロンプトとして使用されます。コマンドを入力した場合はプロンプトを含めないでください。

• ディレクトリ – 特定のディレクトリからコマンドを実行する必要がある場合は、プロンプト記号の前にディレクトリ名が表示されます。

• ユーザー入力 – コマンドラインに入力するコマンドテキストは、user input としてフォーマットされます。

• 置き換え可能なテキスト – 選択したリソースの名前、またはコマンドに含める必要のある AWS のサービスによって生成された ID を含む変更可能なテキストで、replaceable text としてフォーマットされます。複数行のコマンドまたは特定のキーボード入力が必要なコマンドの場合、キーボードコマンドも置き換え可能なテキストとして表示できます。

• 出力 – AWS のサービスによって返される出力はユーザー入力の下に表示され、computer output としてフォーマットされます。

以下の aws configure コマンド例は、ユーザー入力、置き換え可能なテキスト、および出力を表しています。

1. コマンドラインに aws configure を入力し、Enter キーを押します。

2. AWS CLI はテキスト行を出力し、追加情報の入力を求めるプロンプトを表示します。

3. 各アクセスキーを順に入力して、[Enter] キーを押します。

4. その後、表示されている形式で AWS リージョン名を入力して Enter キーを押し、最後に Enter キーをもう一度押して出力形式の設定をスキップします。

5. 最後の Enter コマンドは、その行にユーザー入力がないため、置き換え可能なテキストとして表示されます。

   $ aws configure
   AWS Access Key ID [None]: AKIAIOSFODNN7EXAMPLE
   AWS Secret Access Key [None]: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
   Default region name [None]: us-west-2
   Default output format [None]: ENTER

次の例は、簡単なコマンドと出力を示しています。この例を使用するには、コマンドのフルテキスト (プロンプトの後の強調表示されたテキスト) を入力し、Enter キーを押します。セキュリティグループ名 my-sg は、目的のセキュリティグループ名に置き換えることができます。JSON ドキュメントは中括弧を含めて出力です。CLI を TEXT または TABLE 形式で出力するように設定した場合、出力は異なる形式になります。JSON がデフォルトの出力形式です。

$ aws ec2 create-security-group --group-name my-sg --description "My security group"
{
    "GroupId": "sg-903004f8"
}