**このドキュメントはバージョン 1 の AWS CLI のみを対象としています。** AWS CLI バージョン 1 のサポート終了を発表しました。AWS CLI バージョン 2 に移行することをお勧めします。日付、その他の詳細、移行方法については、「[お知らせ](https://aws.amazon.com/blogs/developer/cli-v1-maintenance-mode-announcement/)」を参照してください。AWS CLI のバージョン 2 に関連するドキュメントについては、[バージョン 2 用ユーザーガイド](https://docs.aws.amazon.com/cli/latest/userguide/)を参照してください。 # Accessing help and resources for the AWS CLI このトピックでは、AWS Command Line Interface (AWS CLI) のヘルプコンテンツにアクセスする方法について説明します。 **Topics** + [組み込みの AWS CLI help コマンド](#cli-usage-help-command) + [AWS CLI リファレンスガイド](#cli-reference) + [API ドキュメント](#api-reference) + [エラーのトラブルシューティング](#help-tshoot) + [その他のヘルプ](#help-additional) ## 組み込みの AWS CLI help コマンド AWS Command Line Interface (AWS CLI) を使用している場合は、どのコマンドのヘルプも表示できます。そのためには、コマンド名の末尾に `help` と入力するだけです。 例えば、次のコマンドは、一般的な AWS CLI オプションと使用可能な最上位レベルのコマンドに関するヘルプを表示します。 ``` $ aws help ``` 次のコマンドは、利用可能な Amazon Elastic Compute Cloud (Amazon EC2) 固有のコマンドを表示します。 ``` $ aws ec2 help ``` 次の例は、Amazon EC2 `DescribeInstances` オペレーションの詳細なヘルプを表示します。ヘルプには、入力パラメータ、使用可能なフィルター、および出力に含まれるものについての説明があります。コマンドの一般的なバリエーションを入力する方法を示す例も含まれています。 ``` $ aws ec2 describe-instances help ``` 各コマンドのヘルプは 6 つのセクションに分かれています。 名前 コマンドの名前。 ``` NAME describe-instances - ``` 説明 コマンドが呼び出す API 操作の説明。 ``` DESCRIPTION Describes one or more of your instances. If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results. ... ``` 概要 コマンドとそのオプションを使用するための基本的な構文。オプションが角括弧で示されている場合は、そのオプションが任意である、デフォルト値がある、または使用できる代替オプションがあることを意味しています。 ``` SYNOPSIS describe-instances [--dry-run | --no-dry-run] [--instance-ids ] [--filters ] [--cli-input-json ] [--starting-token ] [--page-size ] [--max-items ] [--generate-cli-skeleton] ``` たとえば、`describe-instances` のデフォルトの動作では、現在のアカウントおよび AWS リージョン内の***すべて***のインスタンスを記述します。必要に応じて `instance-ids` のリストを指定して、1 つ以上のインスタンスを定義することもできます。`dry-run` は値を取らないオプションのブールフラグです。ブールフラグを使用するには、表示される値のいずれかを指定します。この場合は `--dry-run` または `--no-dry-run` です。同様に、`--generate-cli-skeleton` も値を取りません。オプションの使用に条件がある場合は、`OPTIONS` セクションで説明されるか、例に示されます。 オプション Synopsis に示される各オプションの説明。 ``` OPTIONS --dry-run | --no-dry-run (boolean) Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRun- Operation . Otherwise, it is UnauthorizedOperation . --instance-ids (list) One or more instance IDs. Default: Describes all your instances. ... ``` 例 コマンドとそのオプションの使用方法を示す例。必要なコマンドまたはユースケースについて例がない場合は、このページまたはコマンドのヘルプページの AWS CLI コマンドリファレンスにあるフィードバックリンクを使用してリクエストしてください。 ``` EXAMPLES To describe an Amazon EC2 instance Command: aws ec2 describe-instances --instance-ids i-5203422c To describe all instances with the instance type m1.small Command: aws ec2 describe-instances --filters "Name=instance-type,Values=m1.small" To describe all instances with an Owner tag Command: aws ec2 describe-instances --filters "Name=tag-key,Values=Owner" ... ``` 出力 からの応答に含まれる各フィールドとデータタイプの説明AWS `describe-instances` の場合は、出力は予約オブジェクトのリストであり、それぞれのオブジェクトに、関連付けられたインスタンスに関する情報を含む複数のフィールドとオブジェクトがあります。この情報は、Amazon EC2 で使用される[予約データタイプの API ドキュメント](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Reservation.html)から取得されます。 ``` OUTPUT Reservations -> (list) One or more reservations. (structure) Describes a reservation. ReservationId -> (string) The ID of the reservation. OwnerId -> (string) The ID of the AWS account that owns the reservation. RequesterId -> (string) The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling). Groups -> (list) One or more security groups. (structure) Describes a security group. GroupName -> (string) The name of the security group. GroupId -> (string) The ID of the security group. Instances -> (list) One or more instances. (structure) Describes an instance. InstanceId -> (string) The ID of the instance. ImageId -> (string) The ID of the AMI used to launch the instance. State -> (structure) The current state of the instance. Code -> (integer) The low byte represents the state. The high byte is an opaque internal value and should be ignored. ... ``` 出力が AWS CLI によって JSON にレンダリングされるときには、次の例と同様の予約オブジェクトの配列になります。 ``` { "Reservations": [ { "OwnerId": "012345678901", "ReservationId": "r-4c58f8a0", "Groups": [], "RequesterId": "012345678901", "Instances": [ { "Monitoring": { "State": "disabled" }, "PublicDnsName": "ec2-52-74-16-12.us-west-2.compute.amazonaws.com", "State": { "Code": 16, "Name": "running" }, ... ``` 各予約オブジェクトには、予約およびインスタンスオブジェクトの配列を説明するフィールドがあり、それぞれにそれを説明する独自のフィールド (例: `PublicDnsName`) とオブジェクト (例: `State`) があります。 **Windows ユーザー** ヘルプコマンドの出力を `more` コマンドに*パイプ* (\$1) して、ヘルプファイルを 1 ページずつ表示することができます。スペースバーまたは **PgDn** を押すと、ドキュメントの続きが表示され、**q** を押すと終了します。 ``` C:\> aws ec2 describe-instances help | more ``` ## AWS CLI リファレンスガイド ヘルプファイルには、コマンドラインからは表示や移動ができないリンクが含まれています。オンラインの [AWS CLI バージョン 1 リファレンスガイド](https://docs.aws.amazon.com/cli/v1/reference/)のリンクを利用することで、表示および操作できます。リファレンスには、すべての AWS CLI コマンドのヘルプコンテンツも含まれています。説明は、モバイル、タブレット、またはデスクトップ画面で移動や表示がしやすいように表示されます。 ## API ドキュメント AWS CLI のすべてのコマンドは、AWS サービスのパブリック API に対して行われるリクエストに対応しています。パブリック API を使用する各サービスには API リファレンスがあり、これらは [AWS ドキュメントウェブサイト](https://docs.aws.amazon.com/)にあるサービスのホームページに記載されています。API リファレンスの内容は、API の構築方法および使用されているプロトコルによって異なります。通常、API リファレンスには、API によってサポートされるオペレーション、サービスとの間で送受信されるデータ、およびサービスが報告するエラー条件に関する詳細情報が含まれています。 **API ドキュメントセクション** + **アクション ** - 各オペレーションとそのパラメータに関する詳細情報 (長さまたは内容に関する制約、デフォルト値を含む)。このオペレーションで発生する可能性のあるエラーが一覧表示されます。各オペレーションは、AWS CLI のサブコマンドに対応します。 + **データタイプ ** - コマンドが必要なパラメータそして、リクエストに応答して返す構造体に関する詳細情報。 + **Common Parameters ** - サービスのすべてのアクションに共通のパラメータに関する詳細情報。 + **Common Errors ** - サービスの操作によって返される可能性のあるエラーに関する詳細情報。 各セクションの名前と有無は、サービスによって異なる場合があります。 **サービス固有の CLI** 一部のサービスには、すべてのサービスで動作するように単一の AWS CLI が作成される前から存在する個別の CLI があります。これらのサービス固有の CLI には、サービスのドキュメントページからリンクされた個別のドキュメントがあります。サービス固有の CLI のドキュメントは AWS CLI には適用されません。 ## エラーのトラブルシューティング AWS CLI エラーの診断と修正に関するヘルプについては、「[AWS CLI のエラーのトラブルシューティング](cli-chap-troubleshooting.md)」を参照してください。 ## その他のヘルプ AWS CLI の問題に関する追加のヘルプについては、*GitHub* の [AWS CLI コミュニティ](https://github.com/aws/aws-cli/issues)にアクセスしてください。