Allgemeine AWS CLI-Parametertypen

In diesem Abschnitt werden einige häufige Parametertypen sowie das in der Regel erforderliche Format beschrieben.

Wenn Sie Probleme mit der Formatierung eines Parameters für einen bestimmten Befehl haben, sehen Sie in der Hilfe nach, indem Sie nach dem Befehlsnamen help eingeben. Die Hilfe für jeden Unterbefehl enthält den Namen und die Beschreibung einer Option. Der Parametertyp der Option ist in Klammern angegeben. Weitere Informationen zur Anzeige der Hilfe finden Sie unter Hilfe mit der AWS CLI.

Zeichenfolge

Zeichenfolgenparameter können alphanumerische Zeichen, Symbole und Leerzeichen aus dem ASCII-Zeichensatz enthalten. Zeichenfolgen, die Leerzeichen enthalten, müssen in Anführungszeichen gesetzt werden. Wir empfehlen, keine anderen Symbole oder Leerzeichen als das Standardleerzeichen zu verwenden und die Anführungszeichenregeln Ihres Terminals zu beachten, um unerwartete Ergebnisse zu vermeiden.

Einige Zeichenfolgenparameter können Binärdaten aus einer Datei akzeptieren. Ein Beispiel finden Sie unter Binärdateien.

Zeitstempel

Zeitstempel sind nach dem ISO 8601-Standard formatiert. Diese werden oft als „DateTime“- oder „Date“-Parameter bezeichnet.

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

Zu den akzeptierte Formaten zählen folgende:

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

• YYYY-MM-DDThh:mm:ss.sssTZD (versetzt), beispielsweise 2014-10-01T12:30:00.000-08:00

• YYYY-MM-DD, beispielsweise 2014-10-01

• Unix-Zeit in Sekunden, beispielsweise 1 412 195 400. Dies wird manchmal als Zeit seit Unix-Epoche bezeichnet und gibt die Anzahl der Sekunden seit dem 1. Januar 1970, 0:00 Uhr UTC an.

Standardmäßig übersetzt die AWS CLI Version 2 alle Antwort-Datums-/Uhrzeitwerte in das ISO-8601-Format.

Sie können das Zeitstempelformat über die cli_timestamp_format-Dateieinstellung festlegen.

Auflisten

Eine oder mehrere durch Leerzeichen voneinander getrennte Zeichenfolgen. Wenn eines der Zeichenfolgenelemente ein Leerzeichen enthält, müssen Sie es in Anführungszeichen setzen. Beachten Sie die Anführungszeichenregeln Ihres Terminals, um unerwartete Ergebnisse zu vermeiden

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

Boolesch

Binäres Flag, das eine Option aktiviert oder deaktiviert. Zum Beispiel verfügt ec2 describe-spot-price-history über einen booleschen Parameter --dry-run. Wenn dieser angegeben wird, verifiziert er die Abfrage mit dem Service, ohne tatsächlich die Abfrage auszuführen.

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

Die Ausgabe gibt an, ob der Befehl ordnungsgemäß formatiert wurde oder nicht. Dieser Befehl enthält auch eine Version des Parameters --no-dry-run, mit dem Sie explizit angeben können, dass der Befehl normal ausgeführt werden soll. Dies ist allerdings nicht erforderlich, da dies das Standardverhalten ist.

Ganzzahl

Eine nicht signierte ganze Zahl.

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

Binary/Blob (Binary Large Object) und Streaming-Blob

In der AWS CLI können Sie einen Binärwert als Zeichenfolge direkt in der Befehlszeile übergeben. Es gibt zwei Arten von Blobs:

• Blob

• Streaming-Blob

Blob

Um einen Wert an einen Parameter vom Typ blob zu übergeben, müssen Sie unter Verwendung des Präfix fileb:// einen Pfad zu einer lokalen Datei angeben, die die Binärdaten enthält. Dateien, auf die mit dem Präfix fileb:// verwiesen wird, werden immer als unkodierte Binärdateien behandelt. Der angegebene Pfad wird als relativ zum aktuellen Arbeitsverzeichnis interpretiert. Beispiel: Der Parameter --plaintext für aws kms encrypt ist ein Blob.

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

Anmerkung

Aus Gründen der Abwärtskompatibilität können Sie das Präfix file:// verwenden. Basierend auf der Dateieinstellung cli_binary_format oder der Befehlszeilenoption --cli-binary-format werden zwei Formate verwendet:

• Standard für die AWS CLI Version 2. Wenn der Wert der Einstellung base64 lautet, werden Dateien, auf die mit dem Präfix file:// verwiesen wird, als base64-kodierter Text behandelt.

• Standard für die AWS CLI Version 1. Wenn der Wert der Einstellung raw-in-base64-out lautet, werden Dateien, auf die mit dem Präfix file:// verwiesen wird, als Text gelesen und dann versucht die AWS CLI, sie in Binärform zu codieren.

Weitere Informationen finden Sie in der Erläuterung zur Dateieinstellung cli_binary_format oder zur Befehlszeilenoption --cli-binary-format.

Streaming-Blob

Streaming-Blobs wie z. B. aws cloudsearchdomain upload-documents verwenden keine Präfixe. Stattdessen werden Streaming-Blob-Parameter unter Verwendung des direkten Dateipfads formatiert. Im folgenden Beispiel wird der direkte Dateipfad document-batch.json für den Befehl aws cloudsearchdomain upload-documents verwendet:

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

Zuordnung

Ein Satz von Schlüssel-Wert-Paaren, der in JSON oder mit der Kurznotation der CLI angegeben wird. Das folgende JSON-Beispiel liest ein Element aus einer Amazon-DynamoDB-Tabelle namens my-table mit einem Zuordnungs-Parameter, --key. Der Parameter gibt den Primärschlüssel namens id mit einem Zahlenwert von 1 in einer geschachtelten JSON-Struktur an.

Für eine erweiterte JSON-Nutzung in einer Befehlszeile sollten Sie einen Befehlszeilen-JSON-Prozessor wie jq verwenden, um JSON-Strings zu erstellen. Weitere Informationen zu jq finden Sie im jq-Repository auf GitHub.

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

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

Dokument

Anmerkung

Kurzsyntax ist mit Dokumenttypen nicht kompatibel.

Dokumenttypen werden verwendet, um Daten zu senden, ohne JSON in Zeichenfolgen einbetten zu müssen. Der Dokumenttyp ermöglicht Services, willkürliche Schemata bereitzustellen, damit Sie flexiblere Datentypen verwenden können.

Dies ermöglicht das Senden von JSON-Daten, ohne Werte in Escape-Zeichen einschließen zu müssen. Anstatt beispielsweise die folgende JSON-Eingabe mit Escape-Zeichen zu verwenden:

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

Können Sie den folgenden Dokumenttyp verwenden:

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

Gültige Werte für Dokumenttypen

Aufgrund der flexiblen Natur von Dokumenttypen gibt es mehrere gültige Werttypen. Gültige Werte sind unter anderem:

Zeichenfolge

--option '"value"'

Zahl

--option 123
--option 123.456

Boolesch

--option true

Null

--option null

Array

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

Objekt

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