Tipos de parámetros comunes de la AWS CLI - AWS Command Line Interface

Python 2.7, 3.4 y 3.5 están obsoletas para la versión 1 de AWS CLI. Para obtener más información, consulte la sección de la versión 1 de AWS CLI de Acerca de las versiones de AWS CLI.

Tipos de parámetros comunes de la AWS CLI

En esta sección, se describen algunos de los tipos de parámetros comunes y el formato requerido típico. Si tiene problemas con el formato de un parámetro en un comando específico, consulte la ayuda escribiendo help después del nombre del comando, tal y como se muestra.

$ aws ec2 describe-spot-price-history help

La ayuda para cada subcomando describe su función, opciones, resultado y ejemplos. La sección de opciones incluye el nombre y la descripción de cada una de las opciones con el tipo de parámetro de la opción entre paréntesis.

String

Los parámetros de cadena pueden contener caracteres alfanuméricos, símbolos y espacios en blanco del conjunto de caracteres ASCII. Las cadenas que contienen espacios en blanco deben entrecomillarse. Le recomendamos que no utilice símbolos ni espacios en blanco diferentes del carácter de espacio estándar, ya que se podrían producir resultados inesperados.

Algunos parámetros de cadena pueden aceptar datos binarios de un archivo. Consulte Archivos binarios para ver un ejemplo.

Timestamp

Las marcas temporales tienen un formato conforme a la norma ISO 8601. A veces se les denomina parámetros "DateTime" o "Date".

$ aws ec2 describe-spot-price-history --start-time 2014-10-13T19:00:00Z

Los formatos aceptados son:

  • AAAA-MM-DDThh:mm:ss.sssTZD (UTC), por ejemplo, 2014-10-01T20:30:00.000Z

  • AAAA-MM-DDThh:mm:ss.sssTZD (con compensación), por ejemplo, 2014-10-01T12:30:00.000-08:00

  • AAAA:MM:DD, por ejemplo, 2014-10-01

  • Hora Unix en segundos; por ejemplo, 1412195400. Esto es lo que a veces se denomina fecha de inicio UNIX y representa el número de segundos desde la medianoche del 1 de enero de 1970 UTC.

(está disponible únicamente en la versión 2 de AWS CLI). De forma predeterminada, la versión 2 de la AWS CLI convierte todos los valores DateTime response al formato ISO 8601.

List

Una o varias cadenas separadas por espacios. Si cualquiera de los elementos de cadena contiene un espacio, debe escribir dicho elemento entre comillas.

$ aws ec2 describe-spot-price-history --instance-types m1.xlarge m1.medium

Boolean

Marcador binario que activa o desactiva una opción. Por ejemplo, ec2 describe-spot-price-history tiene con un parámetro --dry-run booleano que, cuando se especifica, valida la consulta con el servicio sin ejecutar realmente una consulta.

$ aws ec2 describe-spot-price-history --dry-run

El resultado indica si el comando tenía el formato correcto o no. Este comando también incluye una versión --no-dry-run del parámetro que puede utilizarse para indicar de forma explícita que el comando debe ejecutarse con normalidad, aunque no es necesario incluirlo, ya que este es el comportamiento predeterminado.

Integer

Un número entero sin firma.

$ aws ec2 describe-spot-price-history --max-items 5

Binario/Blob (objeto binario grande)

En la versión 1 de la AWS CLI, para pasar un valor a un parámetro con el tipo blob, debe especificar una ruta a un archivo local que contenga los datos binarios. La ruta no debe contener ningún identificador de protocolo, como http:// o file://. La ruta especificada se interpreta como una ruta relativa al directorio de trabajo actual. Por ejemplo, el parámetro --body para aws s3api put-object es un blob.

$ aws s3api put-object --bucket my-bucket --key testimage.png --body /tmp/image.png

(está disponible únicamente en la versión 2 de AWS CLI). En la versión 2 de la AWS CLI, puede pasar un valor binario como una cadena codificada en base64 directamente en la línea de comandos. Además, de forma predeterminada, en la versión 2 de la AWS CLI, los archivos a los que se hace referencia con el prefijo file:// se tratan como texto codificado en base64.

Puede revertir la versión 2 de la AWS CLI para que sea compatible con la versión 1 de la AWS CLI estableciendo el valor cli-binary-format:

  • Si el valor del parámetro es raw-in-base64-out, los archivos a los que se hace referencia utilizando el prefijo file:// se tratan como binarios sin codificar y sin procesar.

  • Si el valor del parámetro es base64 (el valor predeterminado), los archivos a los que se hace referencia mediante el prefijo file:// se tratan como texto codificado en base64.

Los archivos a los que se hace referencia utilizando el prefijo fileb:// siempre se tratan como binarios sin codificar, independientemente del valor de cli_binary_format.

Para obtener más información, consulte el valor cli-binary-format.

Map

Un conjunto de pares de clave-valor especificado en JSON o mediante la sintaxis abreviada de la CLI. En el siguiente ejemplo de JSON, se lee un elemento de una tabla de Amazon DynamoDB denominada my-table con un parámetro de mapa, --key. El parámetro especifica la clave principal denominada id con un valor numérico de 1 en una estructura JSON anidada.

Para un uso más avanzado de JSON en una línea de comandos, considere usar un procesador JSON de línea de comandos, comojq, para crear cadenas JSON. Para obtener más información sobre jq, consulte el repositorio jq en GitHub.

$ aws dynamodb get-item --table-name my-table --key '{"id": {"N":"1"}}' { "Item": { "name": { "S": "John" }, "id": { "N": "1" } } }