Cara menggunakan opsi baris perintah AWS CLI mendukung opsi baris perintah global Penggunaan umum opsi baris perintah

Opsi baris perintah di AWS CLI

Di AWS CLI, opsi baris perintah adalah parameter global yang dapat Anda gunakan untuk mengganti pengaturan konfigurasi default, pengaturan profil yang sesuai, atau pengaturan variabel lingkungan untuk perintah tunggal itu. Anda tidak dapat menggunakan opsi baris perintah untuk menentukan kredensional secara langsung, meskipun Anda dapat menentukan profil mana yang akan digunakan.

Topik

Cara menggunakan opsi baris perintah
AWS CLI mendukung opsi baris perintah global
Penggunaan umum opsi baris perintah

Cara menggunakan opsi baris perintah

Sebagian besar opsi baris perintah adalah string sederhana, seperti nama profil profile1 dalam contoh berikut:


$ aws s3 ls --profile profile1
amzn-s3-demo-bucket1
amzn-s3-demo-bucket2
...

Setiap opsi yang mengambil argumen memerlukan spasi atau sama dengan tanda (=) yang memisahkan argumen dari nama opsi. Jika nilai argumen adalah string yang berisi spasi, Anda harus menggunakan tanda kutip di sekitar argumen. Untuk detail tentang tipe argumen dan pemformatan parameter, lihatMenentukan nilai parameter dalam AWS CLI.

AWS CLI mendukung opsi baris perintah global

Di dalam AWS CLI Anda dapat menggunakan opsi baris perintah berikut untuk mengganti pengaturan konfigurasi default, pengaturan profil yang sesuai, atau pengaturan variabel lingkungan untuk perintah tunggal itu.

--ca-bundel <string>

Menentukan bundel sertifikat otoritas sertifikat (CA) yang akan digunakan saat memverifikasi SSL sertifikat.

Jika ditentukan, opsi ini mengesampingkan nilai untuk pengaturan profil ca_bundle dan variabel AWS_CA_BUNDLE lingkungan.

--cli-auto-prompt

Mengaktifkan mode auto-prompt untuk satu perintah. Seperti yang ditunjukkan contoh berikut, Anda dapat menentukannya kapan saja.


$ aws --cli-auto-prompt
$ aws dynamodb --cli-auto-prompt
$ aws dynamodb describe-table --cli-auto-prompt

Opsi ini mengesampingkan variabel aws_cli_auto_prompt lingkungan dan pengaturan cli_auto_prompt profil.

Untuk informasi tentang fitur prompt otomatis AWS CLI versi 2, lihatMengaktifkan dan menggunakan command prompt di AWS CLI.

--cli-binary-format

Menentukan bagaimana AWS CLI versi 2 menafsirkan parameter input biner. Ini bisa menjadi salah satu nilai berikut:

base64 - Ini adalah nilai default. Parameter input yang diketik sebagai objek besar biner (BLOB) menerima string yang dikodekan base64. Untuk meneruskan konten biner yang benar, letakkan konten dalam file dan berikan path dan nama file dengan fileb:// awalan sebagai nilai parameter. Untuk meneruskan teks berenkode base64 yang terkandung dalam file, berikan path dan nama file dengan file:// awalan sebagai nilai parameter.
raw-in-base64-out - 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.

Ini mengesampingkan pengaturan konfigurasi cli_binary_format file.


$ aws lambda invoke \
    --cli-binary-format raw-in-base64-out \
    --function-name my-function \
    --invocation-type Event \
    --payload '{ "name": "Bob" }' \
    response.json

Jika Anda mereferensikan nilai biner dalam file menggunakan notasi fileb:// awalan, AWS CLI selalu mengharapkan file tersebut berisi konten biner mentah dan tidak mencoba mengonversi nilainya.

Jika Anda mereferensikan nilai biner dalam file menggunakan notasi file:// awalan, AWS CLI menangani file sesuai dengan pengaturan saat inicli_binary_format. Jika nilai pengaturan itu base64 (default saat tidak disetel secara eksplisit), file tersebut AWS CLI mengharapkan file berisi teks yang dikodekan base64. Jika nilai pengaturan ituraw-in-base64-out, file AWS CLI mengharapkan berisi konten biner mentah.

--cli-connect-timeout <integer>

Menentukan waktu koneksi soket maksimum dalam hitungan detik. Jika nilainya disetel ke nol (0), sambungan soket menunggu tanpa batas waktu (memblokir) dan tidak batas waktu.

--cli-read-timeout <integer>

Menentukan waktu baca soket maksimum dalam hitungan detik. Jika nilai disetel ke nol (0) pembacaan soket menunggu tanpa batas waktu (memblokir) dan tidak batas waktu.

--warna <string>

Menentukan dukungan untuk output warna. Nilai yang valid adalah on, off, dan auto. Nilai default-nya adalah auto.

--debug

Sakelar Boolean yang memungkinkan logging debug. Secara AWS CLI default menyediakan informasi yang dibersihkan mengenai keberhasilan atau kegagalan terkait hasil perintah dalam output perintah. --debugOpsi ini menyediakan log Python lengkap. Ini termasuk informasi stderr diagnostik tambahan tentang pengoperasian perintah yang dapat berguna saat memecahkan masalah mengapa perintah memberikan hasil yang tidak terduga. Untuk melihat log debug dengan mudah, kami sarankan mengirim log ke file agar lebih mudah mencari informasi. Anda dapat melakukan ini dengan menggunakan salah satu dari berikut ini.

Untuk mengirim hanya informasi stderr diagnostik, tambahkan 2> debug.txt di mana nama debug.txt yang ingin Anda gunakan untuk file debug Anda:


$ aws servicename commandname options --debug 2> debug.txt

Untuk mengirim informasi output dan stderr diagnostik, tambahkan &> debug.txt di mana nama debug.txt yang ingin Anda gunakan untuk file debug Anda:


$ aws servicename commandname options --debug &> debug.txt

--titik akhir-url <string>

Menentukan URL untuk mengirim permintaan ke. Untuk sebagian besar perintah, AWS CLI secara otomatis menentukan URL berdasarkan layanan yang dipilih dan AWS Wilayah yang ditentukan. Namun, beberapa perintah mengharuskan Anda menentukan spesifik akun. URL Anda juga dapat mengonfigurasi beberapa AWS layanan untuk meng-host titik akhir langsung di dalam pribadi Anda VPC, yang mungkin perlu ditentukan.

Contoh perintah berikut menggunakan endpoint Amazon S3 kustom. URL


$ aws s3 ls --endpoint-url http://localhost:4567

Pengaturan konfigurasi titik akhir terletak di beberapa tempat, seperti variabel sistem atau lingkungan pengguna, file AWS konfigurasi lokal, atau dinyatakan secara eksplisit pada baris perintah sebagai parameter. Pengaturan konfigurasi AWS CLI titik akhir diutamakan dalam urutan sebagai berikut:

Opsi baris --endpoint-url perintah.
Jika diaktifkan, variabel lingkungan endpoint AWS_IGNORE_CONFIGURED_ENDPOINT_URLS global atau pengaturan profil ignore_configure_endpoint_urls untuk mengabaikan endpoint kustom.
Nilai yang diberikan oleh variabel lingkungan khusus layananAWS_ENDPOINT_URL_<SERVICE>, seperti. AWS_ENDPOINT_URL_DYNAMODB
Nilai yang disediakan olehAWS_USE_DUALSTACK_ENDPOINT,AWS_USE_FIPS_ENDPOINT, dan variabel AWS_ENDPOINT_URL lingkungan.
Nilai endpoint khusus layanan yang disediakan oleh endpoint_url pengaturan dalam services bagian file bersama. config
Nilai yang diberikan oleh endpoint_url pengaturan profile dalam config file bersama.
use_dualstack_endpoint,use_fips_endpoint, dan endpoint_url pengaturan.
Setiap titik akhir default URL untuk masing-masing Layanan AWS digunakan terakhir. Untuk daftar titik akhir layanan standar yang tersedia di setiap Wilayah, lihat AWS Wilayah dan Titik Akhir di. Referensi Umum Amazon Web Services

--no-cli-auto-prompt

Menonaktifkan mode prompt otomatis untuk satu perintah.


$ aws dynamodb describe-table --table-name Table1 --no-cli-auto-prompt

Opsi ini mengesampingkan variabel aws_cli_auto_prompt lingkungan dan pengaturan cli_auto_prompt profil.

Untuk informasi tentang fitur prompt otomatis AWS CLI versi 2, lihatMengaktifkan dan menggunakan command prompt di AWS CLI.

--no-cli-pager

Sakelar Boolean yang menonaktifkan menggunakan pager untuk output perintah.

--no-paginate

Sakelar Boolean yang menonaktifkan beberapa panggilan yang dilakukan secara otomatis AWS CLI untuk menerima semua hasil perintah yang membuat pagination output. Ini berarti hanya halaman pertama output Anda yang ditampilkan.

--no-sign-request

Sakelar Boolean yang menonaktifkan penandatanganan HTTP permintaan ke titik akhir AWS layanan. Ini mencegah kredensional dimuat.

--no-verify-ssl

Secara default, AWS CLI penggunaan SSL saat berkomunikasi dengan AWS layanan. Untuk setiap SSL koneksi dan panggilan, AWS CLI memverifikasi SSL sertifikat. Menggunakan opsi ini mengesampingkan perilaku default untuk memverifikasi SSL sertifikat.

Awas

Opsi ini bukan praktik terbaik. Jika Anda menggunakannya--no-verify-ssl, lalu lintas antara klien dan AWS layanan Anda tidak lagi aman. Ini berarti lalu lintas Anda berisiko keamanan dan rentan terhadap man-in-the-middle eksploitasi. Jika Anda mengalami masalah dengan sertifikat, sebaiknya selesaikan masalah tersebut. Untuk langkah pemecahan masalah sertifikat, lihat. SSLkesalahan sertifikat

--keluaran <string>

Menentukan format output yang akan digunakan untuk perintah ini. Anda dapat menentukan salah satu nilai berikut:

json— Output diformat sebagai JSONstring.
yaml— Output diformat sebagai YAMLstring.
yaml-stream— Output dialirkan dan diformat sebagai YAMLstring. Streaming memungkinkan penanganan tipe data besar yang lebih cepat.
text- Output diformat sebagai beberapa baris nilai string yang dipisahkan tab. Ini dapat berguna untuk meneruskan output ke prosesor teks, sepertigrep,sed, atauawk.
table— Output diformat sebagai tabel menggunakan karakter +|- untuk membentuk batas sel. Ini biasanya menyajikan informasi dalam format “ramah manusia” yang jauh lebih mudah dibaca daripada yang lain, tetapi tidak berguna secara terprogram.

--profil <string>

Menentukan profil bernama untuk digunakan untuk perintah ini. Untuk mengatur profil bernama tambahan, Anda dapat menggunakan aws configure perintah dengan --profile opsi.


$ aws configure --profile <profilename>

--kueri <string>

Menentukan JMESPathquery untuk digunakan dalam penyaringan data respon. Untuk informasi selengkapnya, lihat Output penyaringan di AWS CLI.

--wilayah <string>

Menentukan AWS Region mana untuk mengirim AWS permintaan perintah ini ke. Untuk daftar semua Wilayah yang dapat Anda tentukan, lihat AWS Wilayah dan Titik Akhir di Referensi Umum Amazon Web Services.

--versi

Sakelar Boolean yang menampilkan versi saat ini dari AWS CLI program yang sedang berjalan.

Penggunaan umum opsi baris perintah

Penggunaan umum untuk opsi baris perintah termasuk memeriksa sumber daya Anda di beberapa AWS Wilayah, dan mengubah format output untuk keterbacaan atau kemudahan penggunaan saat membuat skrip. Dalam contoh berikut, kita menjalankan perintah describe-instance terhadap setiap Region sampai kita menemukan Region mana instance kita berada.


$ aws ec2 describe-instances --output table --region us-west-1
-------------------
|DescribeInstances|
+-----------------+
$ aws ec2 describe-instances --output table --region us-west-2
------------------------------------------------------------------------------
|                              DescribeInstances                             |
+----------------------------------------------------------------------------+
||                               Reservations                               ||
|+-------------------------------------+------------------------------------+|
||  OwnerId                            |  012345678901                      ||
||  ReservationId                      |  r-abcdefgh                        ||
|+-------------------------------------+------------------------------------+|
|||                                Instances                               |||
||+------------------------+-----------------------------------------------+||
|||  AmiLaunchIndex        |  0                                            |||
|||  Architecture          |  x86_64                                       |||
...

Awas Javascript dinonaktifkan atau tidak tersedia di browser Anda.

Untuk menggunakan Dokumentasi AWS, Javascript harus diaktifkan. Lihat halaman Bantuan browser Anda untuk petunjuk.

Konvensi Dokumen

Variabel lingkungan

Mengkonfigurasi penyelesaian perintah di AWS CLI