Jenis parameter umum di AWS CLI - AWS Command Line Interface

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Jenis parameter umum di AWS CLI

Bagian ini menjelaskan beberapa jenis parameter umum dan format khas yang diperlukan.

Jika Anda mengalami masalah dalam memformat parameter untuk perintah tertentu, periksa bantuan dengan memasukkan help setelah nama perintah. Bantuan untuk setiap subperintah mencakup nama dan deskripsi opsi. Jenis parameter opsi tercantum dalam tanda kurung. Untuk informasi selengkapnya tentang melihat bantuan, lihatMengakses bantuan dan sumber daya untuk AWS CLI.

String

Parameter string dapat berisi karakter alfanumerik, simbol, dan spasi putih dari set karakter ASCII. String yang berisi spasi putih harus dikelilingi oleh tanda kutip. Kami menyarankan Anda untuk tidak menggunakan simbol atau spasi putih selain karakter spasi standar dan untuk mematuhi aturan kutipan terminal Anda untuk mencegah hasil yang tidak terduga.

Beberapa parameter string dapat menerima data biner dari file. Lihat File biner sebagai contoh.

Stempel Waktu

Stempel waktu diformat sesuai dengan standar ISO 8601. Ini sering disebut sebagai parameter "DateTime" atau Date "”.

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

Format yang dapat diterima meliputi:

  • YYYY- MM - DD Thh:mm: ss.sssTZD (UTC), misalnya, 2014-10-01T 20:30:00.000 Z

  • YYYY- MM - DD Thh:mm: ss.sssTZD (with offset), misalnya, 2014-10-01T 12:30:00.000-08:00

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

  • Waktu Unix dalam hitungan detik, misalnya, 1412195400. Ini kadang-kadang disebut sebagai waktu Unix Epoch dan mewakili jumlah detik sejak tengah malam, 1 Januari 1970 UTC.

Secara default, AWS CLI versi 2 menerjemahkan semua DateTime nilai respons ke format ISO 8601.

Anda dapat mengatur format stempel waktu dengan menggunakan pengaturan cli_timestamp_format file.

Daftar

Satu atau lebih string dipisahkan oleh spasi. Jika salah satu item string berisi spasi, Anda harus meletakkan tanda kutip di sekitar item itu. Amati aturan kutipan terminal Anda untuk mencegah hasil yang tidak terduga.

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

Boolean

Bendera biner yang mengaktifkan atau menonaktifkan opsi. Misalnya, ec2 describe-spot-price-history memiliki --dry-run parameter Boolean yang, ketika ditentukan, memvalidasi kueri dengan layanan tanpa benar-benar menjalankan kueri.

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

Output menunjukkan apakah perintah itu terbentuk dengan baik. Perintah ini juga menyertakan --no-dry-run versi parameter yang dapat Anda gunakan untuk secara eksplisit menunjukkan bahwa perintah harus dijalankan secara normal. Menyertakannya tidak perlu karena ini adalah perilaku default.

Bilangan Bulat

Nomor bulat yang tidak ditandatangani.

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

Biner/gumpalan (objek besar biner) dan gumpalan streaming

Dalam AWS CLI, Anda dapat melewatkan nilai biner sebagai string langsung pada baris perintah. Ada dua jenis gumpalan:

blob

Untuk meneruskan nilai ke parameter dengan tipeblob, Anda harus menentukan jalur ke file lokal yang berisi data biner menggunakan fileb:// awalan. File yang direferensikan menggunakan fileb:// awalan selalu diperlakukan sebagai biner mentah yang tidak dikodekan. Jalur yang ditentukan ditafsirkan sebagai relatif terhadap direktori kerja saat ini. Misalnya, --plaintext parameter untuk aws kms encrypt adalah gumpalan.

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

Untuk kompatibilitas mundur, Anda dapat menggunakan file:// awalan. Ada dua format yang digunakan berdasarkan pengaturan file cli_binary_format atau opsi baris --cli-binary-format perintah:

  • Default untuk AWS CLI versi 2. Jika nilai pengaturan adalahbase64, file yang direferensikan menggunakan file:// awalan diperlakukan sebagai teks berenkode base64.

  • Default untuk AWS CLI versi 1. Jika nilai pengaturan adalahraw-in-base64-out, file yang direferensikan menggunakan file:// awalan dibaca sebagai teks dan kemudian AWS CLI upaya untuk menyandikannya ke biner.

Untuk informasi selengkapnya, lihat opsi pengaturan file cli_binary_format atau baris --cli-binary-format perintah.

Gumpalan streaming

Gumpalan streaming seperti aws cloudsearchdomain upload-documents tidak menggunakan awalan. Sebagai gantinya, parameter blob streaming diformat menggunakan jalur file langsung. Contoh berikut menggunakan path file langsung document-batch.json untuk aws cloudsearchdomain upload-documents perintah:

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

Peta

Satu set pasangan kunci-nilai ditentukan dalam JSON atau dengan menggunakan sintaks singkatan CLI. Contoh JSON berikut membaca item dari tabel Amazon DynamoDB bernama my-table dengan parameter peta,. --key Parameter menentukan kunci utama bernama id dengan nilai angka 1 dalam struktur JSON bersarang.

Untuk penggunaan JSON yang lebih maju di baris perintah, pertimbangkan untuk menggunakan prosesor JSON baris perintah, sepertijq, untuk membuat string JSON. Untuk informasi lebih lanjut tentangjq, lihat repositori jq di. GitHub

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

Dokumen

catatan

Sintaks singkatan tidak kompatibel dengan jenis dokumen.

Jenis dokumen digunakan untuk mengirim data tanpa perlu menanamkan JSON di dalam string. Jenis dokumen memungkinkan layanan menyediakan skema arbitrer bagi Anda untuk menggunakan tipe data yang lebih fleksibel.

Ini memungkinkan untuk mengirim data JSON tanpa perlu melarikan diri dari nilai. Misalnya, alih-alih menggunakan input JSON yang lolos berikut:

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

Anda dapat menggunakan jenis dokumen berikut:

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

Nilai yang valid untuk jenis dokumen

Karena sifat fleksibel dari jenis dokumen, ada beberapa jenis nilai yang valid. Nilai-nilai yang valid meliputi:

String
--option '"value"'
Number
--option 123 --option 123.456
Boolean
--option true
Nol
--option null
Susunan
--option '["value1", "value2", "value3"]' --option '["value", 1, true, null, ["key1", 2.34], {"key2": "value2"}]'
Objek
--option '{"key": "value"}' --option '{"key1": "value1", "key2": 123, "key3": true, "key4": null, "key5": ["value3", "value4"], "key6": {"value5": "value6"}'