Types de paramètres d'AWS CLI courants

Cette section décrit certains types de paramètres communs et le format typique requis.

Si vous ne parvenez pas à formater un paramètre pour une commande spécifique, consultez l'aide en saisissant le texte help après le nom de la commande. L'aide pour chaque sous-commande inclut le nom et la description d'une option. Le type de paramètre de l'option est indiqué entre parenthèses. Pour plus d'informations sur l'affichage de l'aide, consultezObtenez de l'aide concernant le AWS CLI.

Chaîne

Les paramètres de chaîne peuvent contenir des caractères alphanumériques, des symboles et des espaces blancs issus du jeu de caractères ASCII. Les chaînes contenant des espaces blancs doivent être entourées de guillemets. Nous vous recommandons de ne pas utiliser de symboles ou d'espaces blancs autres que le caractère d'espace standard et de respecter les règles de citation de votre terminal pour éviter des résultats inattendus.

Certains paramètres de chaîne peuvent accepter les données binaires d'un fichier. Veuillez consulter Fichiers binaires pour obtenir un exemple.

Horodatage

Les horodatages sont mis en forme selon la norme ISO 8601. Ces paramètres sont souvent appelés « DateTime » ou Date « ».

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

Les formats acceptables sont les suivants :

• AAAA-MM-JJThh:mm:ss.sssTZD (UTC), par exemple, 2014-10-01T20:30:00.000Z

• AAAA-MM-JJThh:mm:ss.sssTZD (avec décalage), par exemple, 2014-10-01T12:30:00.000-08:00

• AAAA-MM-JJ, par exemple, 2014-10-01

• Horaire Unix en secondes, par exemple 1412195400. Ceci est parfois appelé Heure d'époque Unix et représente le nombre de secondes écoulées depuis le 1er janvier 1970 à minuit, UTC.

Par défaut, la AWS CLI version 2 traduit toutes les DateTime valeurs de réponse au format ISO 8601.

Vous pouvez définir le format d'horodatage à l'aide du paramètre du cli_timestamp_format fichier.

Liste

Une ou plusieurs chaînes séparées par des espaces. Si l'un des éléments de chaîne contient un espace, vous devez mettre cet élément entre guillemets. Respectez les règles de devis de votre terminal pour éviter des résultats inattendus.

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

Booléen

Drapeau binaire qui active ou désactive une option. Par exemple, ec2 describe-spot-price-history comporte un paramètre d'essai booléen --dry-run qui, lorsqu'il est spécifié, valide la demande sur le service sans réellement exécuter la requête.

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

La sortie indique si la commande était ou non correctement mise en forme. Cette commande inclut également une version --no-dry-run du paramètre qui peut être utilisée pour indiquer de manière explicite que la commande doit s'exécuter normalement. Il n'est pas nécessaire de l'inclure puisqu'il s'agit du comportement par défaut.

Entier

Nombre entier non signé.

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

Binaire/blob (gros objet binaire) et blob de streaming

Dans leAWS CLI, vous pouvez transmettre une valeur binaire sous forme de chaîne directement sur la ligne de commande. Il existe deux types de blobs :

• Blob

• Blob en streaming

BLOB

Pour transmettre une valeur à un paramètre avec typeblob, vous devez spécifier un chemin d'accès à un fichier local contenant les données binaires à l'aide du fileb:// préfixe. Les fichiers référencés à l'aide du fileb:// préfixe sont toujours traités comme des fichiers binaires bruts non codés. Le chemin spécifié est interprété comme étant relatif au répertoire de travail actuel. Par exemple, le paramètre --plaintext pour aws kms encrypt est un objet blob.

$ aws kms encrypt \
    --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \
    --plaintext fileb://ExamplePlaintextFile \
    --output text \
    --query CiphertextBlob | base64 \
    --decode > ExampleEncryptedFile

Note

Pour des raisons de rétrocompatibilité, vous pouvez utiliser le file:// préfixe. Deux formats sont utilisés en fonction du paramètre du fichier cli_binary_format ou de l'option de ligne de --cli-binary-format commande :

• Par défaut pour la AWS CLI version 2. Si la valeur du paramètre estbase64, les fichiers référencés à l'aide du file:// préfixe sont traités comme du texte codé en base64.

• Par défaut pour la AWS CLI version 1. Si la valeur du paramètre estraw-in-base64-out, les fichiers référencés à l'aide du file:// préfixe sont lus sous forme de texte, puis les AWS CLI tentatives de codage en binaire sont tentées.

Pour plus d'informations, consultez le paramètre de fichier cli_binary_format ou l'option de ligne de --cli-binary-format commande.

Blob en streaming

Blobs de streaming tels que « aws cloudsearchdomain upload-documents Ne pas utiliser de préfixes ». Au lieu de cela, les paramètres du blob de streaming sont formatés à l'aide du chemin direct du fichier. L'exemple suivant utilise le chemin de fichier direct document-batch.json pour la aws cloudsearchdomain upload-documents commande :

$ aws cloudsearchdomain upload-documents \
    --endpoint-url https://doc-my-domain.us-west-1.cloudsearch.amazonaws.com \
    --content-type application/json \
    --documents document-batch.json

Map

Ensemble de paires clés-valeurs spécifiées en JSON ou à l'aide de la syntaxe raccourcie de l'interface de ligne de commande. L'exemple JSON suivant lit un élément d'une table Amazon DynamoDB nommée my-table avec un paramètre de carte,. --key Le paramètre spécifie la clé primaire nommée id avec la valeur numérique 1 dans une structure JSON imbriquée.

Pour une utilisation plus avancée du JSON dans une ligne de commande, pensez à utiliser un processeur JSON en ligne de commandejq, par exemple pour créer des chaînes JSON. Pour plus d'informations surjq, consultez le référentiel jq sur GitHub.

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

{
    "Item": {
        "name": {
            "S": "John"
        },
        "id": {
            "N": "1"
        }
    }
}

Document

Note

La syntaxe abrégée n'est pas compatible avec les types de documents.

Les types de documents sont utilisés pour envoyer des données sans qu'il soit nécessaire d'intégrer du JSON dans des chaînes. Le type de document permet aux services de fournir des schémas arbitraires afin que vous puissiez utiliser des types de données plus flexibles.

Cela permet d'envoyer des données JSON sans avoir à échapper aux valeurs. Par exemple, au lieu d'utiliser l'entrée JSON échappée suivante :

{"document": "{\"key\":true}"}

Vous pouvez utiliser le type de document suivant :

{"document": {"key": true}}

Valeurs valides pour les types de documents

En raison de la flexibilité des types de documents, il existe plusieurs types de valeurs valides. Les valeurs valides sont notamment les suivantes :

Chaîne

--option '"value"'

Nombre

--option 123
--option 123.456

Booléen

--option true

Null

--option null

Tableau

--option '["value1", "value2", "value3"]'
--option '["value", 1, true, null, ["key1", 2.34], {"key2": "value2"}]'

Objet

--option '{"key": "value"}'
--option '{"key1": "value1", "key2": 123, "key3": true, "key4": null, "key5": ["value3", "value4"], "key6": {"value5": "value6"}'