Obtener ayuda con la AWS CLI - AWS Command Line Interface

Obtener ayuda con la AWS CLI

En este tema, se describe cómo acceder al contenido de ayuda de AWS Command Line Interface (AWS CLI).

El comando de ayuda de AWS CLI integrado

Puede obtener ayuda para cualquier comando cuando utiliza la AWS Command Line Interface (AWS CLI). Para ello, simplemente escriba help al final del nombre de un comando.

Por ejemplo, el siguiente comando muestra la ayuda de las opciones generales de la AWS CLI generales y los comandos de nivel superior.

$ aws help

El comando siguiente muestra los comandos específicos de Amazon Elastic Compute Cloud (Amazon EC2) disponibles.

$ aws ec2 help

En el siguiente ejemplo se muestra información de ayuda detallada de la operación DescribeInstances de Amazon EC2. La ayuda incluye descripciones de los parámetros de entrada, los filtros disponibles y qué se incluye como salida. También incluye ejemplos que muestran cómo escribir variaciones comunes del comando.

$ aws ec2 describe-instances help

La ayuda de cada comando se divide en seis secciones:

Nombre

El nombre del comando.

NAME describe-instances -
Descripción

Una descripción de la operación de la API que el comando invoca.

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. ...
Sinopsis

La sintaxis básica para utilizar el comando y sus opciones. Si una opción aparece entre corchetes, significa que es opcional, que tiene un valor predeterminado o que existe una opción alternativa que puede utilizarse en su lugar.

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]

Por ejemplo, describe-instances tiene un comportamiento predeterminado que describe todas las instancias de la cuenta y la región de AWS actuales. Si lo desea, puede especificar una lista de instance-ids para describir una o varias instancias. dry-run es un indicador booleano opcional que no adopta ningún valor. Para utilizar un indicador booleano, especifique el valor aparece; en este caso, --dry-run o --no-dry-run. Del mismo modo, --generate-cli-skeleton no adopta un valor. Si existen condiciones para usar una opción, aparecen descritas en la sección OPTIONS o se muestran en los ejemplos.

Opciones

Una descripción de cada una de las opciones que aparecen en el resumen.

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. ...
Ejemplos

Ejemplos que ilustran el uso del comando y sus opciones. Si no se proporciona un ejemplo de un comando o un caso de uso que necesite, solicítelo a través del enlace de comentarios de esta página o de la referencia de comandos de la AWS CLI en la página de ayuda del comando.

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" ...
Salida

Descripciones de cada uno de los campos y tipos de datos incluidos en la respuesta de AWS.

Para describe-instances, la salida es una lista de objetos de reserva, cada uno de los cuales contiene varios campos y objetos con información acerca de las instancias asociadas al mismo. Esta información procede de la documentación de la API para el tipo de datos de reserva que utiliza Amazon 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. ...

Cuando la AWS CLI proporciona la salida en formato JSON, se convierte en una matriz de objetos de reserva, similar a la del siguiente ejemplo.

{ "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" }, ...

Cada objeto de reserva tiene campos que describen la reserva y una matriz de objetos de instancia, cada uno de ellos con sus propios campos (por ejemplo, PublicDnsName) y objetos (por ejemplo State) que los describen.

Usuarios de Windows

Puede añadir una barra vertical (|) a la salida del comando de ayuda al comando more para ver las páginas del archivo de ayuda una a una. Pulse la barra espaciadora o AvPág para avanzar por el documento y q para salir.

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

Guía de referencia de AWS CLI

Los archivos de ayuda contienen enlaces que no se pueden ver o visitar desde la línea de comandos. Puede consultar e interactuar con estos enlac‎es mediante la versión 2 de la guía de referencia de AWS CLI en línea. La referencia también tiene el contenido de la ayuda de todos los comandos de AWS CLI. Las descripciones se presentan para facilitar la navegación y la consulta en móviles, tabletas o equipos de escritorio.

Documentación de la API

Todos los comandos de la AWS CLI corresponden a solicitudes realizadas a la API pública de un servicio de AWS. Todos los servicios con una API pública tienen una referencia de API que puede encontrarse en la página de inicio del servicio en el AWSsitio web Documentación de . El contenido de una referencia de API varía en función de cómo se construye la API y del protocolo utilizado. Normalmente, las referencias de API contienen información detallada sobre las acciones compatibles con la API, los datos enviados al servicio y desde este, y cualquier posible situación de error que pueda detectar el sistema.

Secciones de documentación de la API

  • Acciones: información detallada de cada operación y sus parámetros (incluidas las restricciones de longitud o contenido, y valores predeterminados). Muestra los errores que pueden ocurrir con esta operación. Cada operación se corresponde con un subcomando de la AWS CLI.

  • Tipos de datos: información detallada sobre las estructuras que un comando puede requerir como parámetro, o devolver en respuesta a una solicitud.

  • Parámetros comunes: información detallada sobre los parámetros que utilizan todas las acciones de un servicio.

  • Errores comunes: información detallada sobre los errores que cualquiera de las operaciones del servicio puede devolver.

El nombre y la disponibilidad de cada sección puede variar en función del servicio.

CLI específicas de los servicios

Algunos servicios tienen una CLI distinta que existía antes de que se creara una única AWS CLI para funcionar con todos los servicios. Las CLI específicas de los servicios tienen documentación aparte, a la que se accede con un enlace a la página de documentación del servicio. La documentación de las CLI específicas de los servicios no se aplica a AWS CLI.

Solución de errores

Para obtener ayuda a fin de diagnosticar y corregir errores de AWS CLI, consulte Solución de errores de AWS CLI.

Ayuda adicional

Para obtener ayuda adicional con sus problemas de AWS CLI, visite la Comunidad de AWS CLI en GitHub.