访问帮助和资源 AWS CLI - AWS Command Line Interface
内置 AWS CLI 帮助命令AWS CLI 参考指南API文档纠正错误其他帮助

本文档 AWS CLI 仅适用于版本 1。有关版本 2 的文档 AWS CLI，请参阅版本 2 用户指南。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

访问帮助和资源 AWS CLI

本主题介绍如何访问 AWS Command Line Interface (AWS CLI) 的帮助内容。

内置 AWS CLI 帮助命令

使用 AWS Command Line Interface (AWS CLI) 时，您可以获得有关任何命令的帮助。为此，只需在命令名称末尾键入 help。

例如，以下命令显示常规 AWS CLI 选项和可用顶级命令的帮助。

$ aws help

以下命令显示可用的亚马逊弹性计算云 (AmazonEC2) 特定命令。

$ aws ec2 help

以下示例显示了 Amazon EC2 DescribeInstances 操作的详细帮助。帮助包括对其输入参数、可用筛选条件以及作为输出包含的内容的描述。它还包含说明如何键入命令的常见变体的示例。

$ aws ec2 describe-instances help

每个命令的帮助分为六个部分：

名称

命令的名称。

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 <value>]
          [--filters <value>]
          [--cli-input-json <value>]
          [--starting-token <value>]
          [--page-size <value>]
          [--max-items <value>]
          [--generate-cli-skeleton]

例如，describe-instances具有描述当前账户和 AWS 区域中所有实例的默认行为。您可以选择指定 instance-ids 列表来描述一个或多个实例；dry-run 是不接受值的可选布尔标志。要使用布尔标志，请指定其中一个显示的值，在本例中为 --dry-run 或 --no-dry-run。同样，--generate-cli-skeleton 不使用值。如果某个选项的使用存在条件，则在 OPTIONS 部分中描述这些条件，或在示例中显示这些条件。

选项

对摘要中显示的每个选项的描述。

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，输出是预留对象的列表，每个列表都包含若干字段和对象，这些字段和对象包含与其关联的实例的相关信息。此信息来自亚马逊使用的预订数据类型的API文档EC2。

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 用户

您可以通过管道 (|) 将 help 命令的输出发送到 more 命令以便每次查看一页帮助文件。按空格键或PgDn查看文档的更多内容，然后q退出。

C:\> aws ec2 describe-instances help | more

AWS CLI 参考指南

帮助文件包含无法通过命令行查看或导航至的链接。您可以使用在线AWS CLI 版本 1 参考指南第 参考指南查看这些链接并与之交互。该参考还包含所有 AWS CLI 命令的帮助内容。将显示这些说明以方便在手机、平板电脑或桌面屏幕进行浏览和查看。

API文档

中的所有命令都对 AWS CLI 应于向 AWS 服务公众发出的请求API。每项公共服务都API有一个API参考文献，可以在AWS 文档网站的服务主页上找到。API参考的内容因其构造API方式和使用的协议而异。通常，API参考文献包含有关支持的操作API、发送到和发送出服务的数据，以及该服务可以报告的任何错误情况的详细信息。

API文档部分

  • Actions（操作）– 有关每个操作及其参数（包括对长度或内容以及默认值的约束）的详细信息。它列出了此操作可能发生的错误。每个操作都对应于中的一个子命令。 AWS CLI

  • Data Types（数据类型）– 有关命令可能需要作为参数或在响应请求时要返回的结构的详细信息。

  • Common Parameters （常用参数）– 有关由服务的所有操作共享的参数的详细信息。

  • Common Errors（常见错误）– 有关可能由服务的任意操作返回的错误的详细信息。

每个部分的名称和可用性可能根据具体服务而不同。

特定于服务 CLIs

有些服务有单独的服务CLI，其历史可以追溯到创建单个 AWS CLI 服务之前，可以与所有服务配合使用。这些特定服务CLIs都有单独的文档，这些文档链接到服务的文档页面。特定于服务的文档CLIs不适用于。 AWS CLI

纠正错误

有关诊断和修复 AWS CLI 错误的帮助，请参阅对错误进行故障排除 AWS CLI。

其他帮助

如需更多 AWS CLI 问题方面的帮助，请访问AWS CLI 社区GitHub。