Opciones de línea de comandos en AWS CLI - AWS Command Line Interface
Cómo utilizar las opciones de la línea de comandosAWS CLI opciones de línea de comandos globales compatiblesUsos comunes de las opciones de la línea de comandos

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Opciones de línea de comandos en AWS CLI

En el AWS CLI, las opciones de línea de comandos son parámetros globales que puede utilizar para anular los ajustes de configuración predeterminados, cualquier ajuste de perfil correspondiente o parámetro de variable de entorno para ese único comando. No se pueden utilizar las opciones de línea de comandos para especificar credenciales directamente, aunque es posible especificar qué perfil se debe utilizar.

Cómo utilizar las opciones de la línea de comandos

La mayoría de las opciones de la línea de comandos son cadenas simples, como el nombre del perfil profile1 en el siguiente ejemplo:

$ aws s3 ls --profile profile1
amzn-s3-demo-bucket1
amzn-s3-demo-bucket2
...

Cada opción toma un argumento que requiere un espacio o un signo igual (=) que separa el argumento del nombre de la opción. Si el valor del argumento es una cadena que contiene un espacio, debe utilizar comillas en torno al argumento. Para obtener más información sobre los tipos de argumentos y el formato de los parámetros, consulte Especificar los valores de los parámetros en el AWS CLI.

AWS CLI opciones de línea de comandos globales compatibles

En el, AWS CLI puede utilizar las siguientes opciones de línea de comandos para anular los ajustes de configuración predeterminados, cualquier ajuste de perfil correspondiente o parámetro de variable de entorno para ese único comando.

--ca-bundle <string>

Especifica el paquete de certificados de la entidad emisora de certificados (CA) que se va a utilizar al comprobar SSL los certificados.

Si se define, esta opción anula el valor de la configuración del perfil ca_bundle y la variable del entorno de AWS_CA_BUNDLE.

--cli-auto-prompt

Habilita el modo de solicitud automática para un solo comando. Como muestran los siguientes ejemplos, se puede especificar en cualquier momento.

$ aws --cli-auto-prompt
$ aws dynamodb --cli-auto-prompt
$ aws dynamodb describe-table --cli-auto-prompt

Esta opción anula la variable de entorno de aws_cli_auto_prompt y la configuración del perfil cli_auto_prompt.

Para obtener información sobre la función de aviso automático de la AWS CLI versión 2, consulteActivación y uso de las solicitudes de comando en el AWS CLI.

--cli-binary-format

Especifica cómo interpreta la AWS CLI versión 2 los parámetros de entrada binarios. Puede ser uno de los siguientes valores:

  • base64: este es el valor predeterminado. Un parámetro de entrada que se escribe como un objeto grande binario (BLOB) acepta una cadena codificada en base64. Para pasar verdadero contenido binario, coloque el contenido en un archivo y proporcione la ruta y el nombre del archivo con el prefijo fileb:// como valor del parámetro. Para pasar el texto codificado en base64 incluido en un archivo, proporcione la ruta y el nombre del archivo con el prefijo file:// como valor del parámetro.

  • raw-in-base64 salidas: valor predeterminado para la versión 1. AWS CLI Si el valor de la configuración esraw-in-base64-out, los archivos a los que se hace referencia con el file:// prefijo se leen como texto y, a continuación, se AWS CLI intenta codificarlos en formato binario.

Esto anula la opción de configuración de archivo cli_binary_format.

$ aws lambda invoke \
    --cli-binary-format raw-in-base64-out \
    --function-name my-function \
    --invocation-type Event \
    --payload '{ "name": "Bob" }' \
    response.json

Si hace referencia a un valor binario en un archivo mediante la notación de fileb:// prefijo, AWS CLI siempre espera que el archivo contenga contenido binario sin procesar y no intenta convertir el valor.

Si hace referencia a un valor binario de un archivo mediante la notación de file:// prefijo, AWS CLI gestiona el archivo según la configuración actualcli_binary_format. Si el valor de esa configuración es base64 (el predeterminado cuando no se establece de forma explícita), se AWS CLI espera que el archivo contenga texto codificado en base64. Si el valor de esa configuración es raw-in-base64-out, la AWS CLI espera que el archivo incluya contenido binario sin codificar.

--cli-connect-timeout <integer>

Especifica el máximo tiempo de conexión del conector en segundos. Si el valor se establece en cero (0), la conexión del socket espera de forma indefinida (bloqueo) y no se agota el tiempo de espera.

--cli-read-timeout <integer>

Especifica el máximo tiempo de lectura del conector en segundos. Si el valor se establece en cero (0), la lectura del socket espera de forma indefinida (bloqueo) y no se agota el tiempo de espera.

--color <string>

Especifica la compatibilidad con el color de salida. Los valores válidos son on, off y auto. El valor predeterminado es auto.

--debug

Modificador booleano que permite registrar la depuración. De forma AWS CLI predeterminada, proporciona información clara sobre cualquier éxito o error relacionado con los resultados de los comandos en la salida del comando. La --debug proporciona los registros completos de Python. Esto incluye información de diagnóstico adicional de stderr sobre la operación del comando que puede ser útil para resolver problemas si un comando proporciona resultados inesperados. Para ver fácilmente los registros de depuración, sugerimos enviar los registros a un archivo para buscar la información más fácilmente. Puede hacer esto utilizando de los siguientes métodos.

Para enviar solo la información de diagnóstico de stderr, agregue 2> debug.txt donde debug.txt es el nombre que desea usar para su archivo de depuración:

$ aws servicename commandname options --debug 2> debug.txt

Para enviar ambos la salida y la información de diagnóstico de stderr, agregue &> debug.txt donde debug.txt es el nombre que desea usar para su archivo de depuración:

$ aws servicename commandname options --debug &> debug.txt
--endpoint-url <string>

Especifica el destinatario al que se debe URL enviar la solicitud. Para la mayoría de los comandos, determina AWS CLI automáticamente el en URL función del servicio seleccionado y de la AWS región especificada. Sin embargo, algunos comandos requieren que especifique una cuenta específica. URL También puedes configurar algunos AWS servicios para alojar un punto final directamente en tu cuenta privada VPC, que puede que luego tengas que especificar.

El siguiente ejemplo de comando usa un punto de conexión Amazon S3 personalizadoURL.

$ aws s3 ls --endpoint-url http://localhost:4567

Los ajustes de configuración del punto final se encuentran en varios lugares, como las variables de entorno del sistema o del usuario, los archivos de AWS configuración locales, o se declaran explícitamente en la línea de comandos como parámetros. Los ajustes de configuración del punto de conexión de la AWS CLI tienen prioridad en el siguiente orden:

  1. La opción de línea de comandos --endpoint-url.

  2. Si está habilitada, la variable de entorno del punto de conexión AWS_IGNORE_CONFIGURED_ENDPOINT_URLS global o la configuración del perfil ignore_configure_endpoint_urls para ignorar los puntos de conexión personalizados.

  3. El valor proporcionado por una variable de entorno específica del servicio AWS_ENDPOINT_URL_<SERVICE>, como AWS_ENDPOINT_URL_DYNAMODB.

  4. Los valores proporcionados por las variables de entorno AWS_USE_DUALSTACK_ENDPOINT, AWS_USE_FIPS_ENDPOINT y AWS_ENDPOINT_URL.

  5. El valor de punto de conexión específico del servicio proporcionado por la configuración endpoint_url de una sección de services del archivo compartido config.

  6. El valor proporcionado por la configuración endpoint_url en un profile de un archivo compartido config.

  7. Configuración de use_dualstack_endpoint, use_fips_endpoint y endpoint_url.

  8. En último lugar se utiliza cualquier punto final predeterminado URL para el respectivo Servicio de AWS . Para obtener una lista de los puntos de enlace de servicio estándar disponibles en cada región, consulte Regiones y puntos de enlace de AWS en la Referencia general de Amazon Web Services.

--no-cli-auto-prompt

Deshabilita el modo de solicitud automática para un solo comando.

$ aws dynamodb describe-table --table-name Table1 --no-cli-auto-prompt

Esta opción anula la variable de entorno de aws_cli_auto_prompt y la configuración del perfil cli_auto_prompt.

Para obtener información sobre la función de aviso automático de la AWS CLI versión 2, consulteActivación y uso de las solicitudes de comando en el AWS CLI.

--no-cli-pager

Modificador booleano que desactiva el uso de un buscapersonas para la salida del comando.

--no-paginate

Un conmutador booleano que desactiva las llamadas múltiples y recibe automáticamente todos los resultados de los comandos, AWS CLI lo que crea una paginación del resultado. Esto significa que solo se muestra la primera página de su salida.

--no-sign-request

Un conmutador booleano que desactiva la firma de las solicitudes en el punto final del servicio. HTTP AWS Impide que se carguen las credenciales.

--no-verify-ssl

De forma predeterminada, se AWS CLI utiliza SSL cuando se comunica con los servicios. AWS Para cada SSL conexión y llamada, AWS CLI verifica los SSL certificados. El uso de esta opción anula el comportamiento predeterminado de la verificación SSL de los certificados.

aviso

Esta opción no es una práctica recomendada. Si la usa--no-verify-ssl, el tráfico entre el cliente y AWS los servicios ya no está protegido. Esto significa que su tráfico es un riesgo para la seguridad y vulnerable a los man-in-the-middle exploits. Si tiene problemas con los certificados, es mejor que los resuelva. Para conocer los pasos para solucionar problemas de certificados, consulte SSLerrores de certificado.

--output <string>

Especifica el formato de salida que se va a utilizar con este comando. Puede especificar cualquiera de los siguientes valores:

  • json— La salida está formateada como una JSONcadena.

  • yaml— La salida tiene el formato de una YAMLcadena.

  • yaml-stream— La salida se transmite y se formatea como una cadena. YAML El streaming permite un manejo más rápido de tipos de datos de gran tamaño.

  • text: la salida tiene el formato de varias líneas de valores de cadena separados por tabuladores. Esto puede ser útil para pasar la salida a un procesador de texto, como grep, sed o awk.

  • table: el resultado tiene el formato de una tabla en la que se usan los caracteres +|- para los bordes de celda. Normalmente, la información se presenta en un formato que es más fácil de leer que los demás formatos, pero que no es útil para programar.

--profile <string>

Especifica el perfil con nombre que se va a utilizar con este comando. Para configurar perfiles con nombre adicionales, puede utilizar el comando aws configure con la opción --profile.

$ aws configure --profile <profilename>
--consulta <string>

Especifica una JMESPathconsulta que se utilizará para filtrar los datos de respuesta. Para obtener más información, consulte Filtrar la salida en el AWS CLI.

--region <string>

Especifica a qué AWS región se va a enviar la AWS solicitud de este comando. Para obtener una lista de todas las regiones que se pueden especificar, consulte Regiones y puntos de enlace de AWS en la Referencia general de Amazon Web Services.

--version

Un modificador booleano que muestra la versión actual del AWS CLI programa que se está ejecutando.

Usos comunes de las opciones de la línea de comandos

Entre los usos habituales de las opciones de la línea de comandos se incluyen la comprobación de sus recursos en varias regiones de AWS y el cambio del formato de salida para obtener una mayor legibilidad o facilidad de uso al generar scripts. En los siguientes ejemplos, ejecutamos el comando describe-instances en cada región hasta que encontremos en qué región se encuentra la instancia. 

$ aws ec2 describe-instances --output table --region us-west-1
-------------------
|DescribeInstances|
+-----------------+
$ aws ec2 describe-instances --output table --region us-west-2
------------------------------------------------------------------------------
|                              DescribeInstances                             |
+----------------------------------------------------------------------------+
||                               Reservations                               ||
|+-------------------------------------+------------------------------------+|
||  OwnerId                            |  012345678901                      ||
||  ReservationId                      |  r-abcdefgh                        ||
|+-------------------------------------+------------------------------------+|
|||                                Instances                               |||
||+------------------------+-----------------------------------------------+||
|||  AmiLaunchIndex        |  0                                            |||
|||  Architecture          |  x86_64                                       |||
...