Usar sintaxis abreviada con la AWS CLI

La AWS Command Line Interface (AWS CLI) puede aceptar muchos de sus parámetros de opciones en formato JSON. Sin embargo, resultaría tedioso escribir largas listas o estructuras de JSON en la línea de comandos. Para simplificarlo, la AWS CLI también admite una sintaxis abreviada que permite una representación de los parámetros de opciones más sencilla que si se usara el formato JSON íntegro.

Parámetros estructurales

La sintaxis abreviada de la AWS CLI facilita a los usuarios la introducción de parámetros planos (con estructuras no anidadas). El formato consiste en una lista de pares de clave-valor separados por comas. Asegúrese de utilizar las reglas de comillas y caracteres de escape apropiadas para el terminal como sintaxis abreviada son cadenas.

Linux or macOS

--option key1=value1,key2=value2,key3=value3

PowerShell

--option "key1=value1,key2=value2,key3=value3"

Ambos equivalen al siguiente ejemplo con formato JSON.

--option '{"key1":"value1","key2":"value2","key3":"value3"}'

No debe haber espacios en blanco entre cada uno de los pares de clave-valor separados por comas. A continuación, se muestra un ejemplo del comando de update-table de Amazon DynamoDB con la opción --provisioned-throughput especificada en modo abreviado.

$ aws dynamodb update-table \
    --provisioned-throughput ReadCapacityUnits=15,WriteCapacityUnits=10 \
    --table-name MyDDBTable

Esto equivale al siguiente ejemplo con formato JSON.

$ aws dynamodb update-table \
    --provisioned-throughput '{"ReadCapacityUnits":15,"WriteCapacityUnits":10}' \
    --table-name MyDDBTable

Uso de sintaxis abreviada con la AWS Command Line Interface

Puede especificar los parámetros de entrada en una lista de dos formas: en JSON o en sintaxis abreviada. La sintaxis abreviada de la AWS CLI ha sido diseñada para que su inserción en listas con números, cadenas o estructuras no anidadas resulte más sencilla.

A continuación se muestra el formato básico, en el que los valores de la lista están separados por un único espacio.

--option value1 value2 value3

Esto equivale al siguiente ejemplo con formato JSON.

--option '[value1,value2,value3]'

Como ya hemos mencionado anteriormente, puede especificar una lista de números, una lista de cadenas o una lista de estructuras no anidadas en formato abreviado. A continuación, se muestra un ejemplo del comando stop-instances para Amazon Elastic Compute Cloud (Amazon EC2), en el que el parámetro de entrada (lista de cadenas) de la opción --instance-ids se especifica en forma abreviada.

$ aws ec2 stop-instances \
    --instance-ids i-1486157a i-1286157c i-ec3a7e87

Esto equivale al siguiente ejemplo con formato JSON.

$ aws ec2 stop-instances \
    --instance-ids '["i-1486157a","i-1286157c","i-ec3a7e87"]'

En el siguiente ejemplo se muestra el comando de create-tags de Amazon EC2, que toma una lista de estructuras no anidadas para la opción --tags. La opción --resources especifica el identificador de la instancia que debe etiquetarse.

$ aws ec2 create-tags \
    --resources i-1286157c \
    --tags Key=My1stTag,Value=Value1 Key=My2ndTag,Value=Value2 Key=My3rdTag,Value=Value3

Esto equivale al siguiente ejemplo con formato JSON. El parámetro JSON está escrito en varias líneas para facilitar su lectura.

$ aws ec2 create-tags \
    --resources i-1286157c \
    --tags '[
        {"Key": "My1stTag", "Value": "Value1"},
        {"Key": "My2ndTag", "Value": "Value2"},
        {"Key": "My3rdTag", "Value": "Value3"}
    ]'