Mengakses bantuan dan sumber daya untuk 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.

Mengakses bantuan dan sumber daya untuk AWS CLI

Topik ini menjelaskan cara mengakses konten bantuan untuk AWS Command Line Interface (AWS CLI).

Perintah AWS CLI bantuan bawaan

Anda bisa mendapatkan bantuan dengan perintah apa pun saat menggunakan AWS Command Line Interface (AWS CLI). Untuk melakukannya, cukup ketik help di akhir nama perintah.

Misalnya, perintah berikut menampilkan bantuan untuk AWS CLI opsi umum dan perintah tingkat atas yang tersedia.

$ aws help

Perintah berikut menampilkan perintah khusus Amazon Elastic Compute Cloud (AmazonEC2) yang tersedia.

$ aws ec2 help

Contoh berikut menampilkan bantuan terperinci untuk EC2 DescribeInstances operasi Amazon. Bantuan tersebut mencakup deskripsi parameter inputnya, filter yang tersedia, dan apa yang disertakan sebagai output. Ini juga mencakup contoh yang menunjukkan cara mengetik variasi umum dari perintah.

$ aws ec2 describe-instances help

Bantuan untuk setiap perintah dibagi menjadi enam bagian:

Nama

Nama perintah.

NAME describe-instances -
Deskripsi

Deskripsi API operasi yang dipanggil perintah.

DESCRIPTION Describes one or more of your instances. If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results. ...
Sinopsis

Sintaks dasar untuk menggunakan perintah dan opsinya. Jika opsi ditampilkan dalam tanda kurung siku, itu opsional, memiliki nilai default, atau memiliki opsi alternatif yang dapat Anda gunakan.

SYNOPSIS describe-instances [--dry-run | --no-dry-run] [--instance-ids <value>] [--filters <value>] [--cli-input-json <value>] [--starting-token <value>] [--page-size <value>] [--max-items <value>] [--generate-cli-skeleton]

Misalnya, describe-instances memiliki perilaku default yang menjelaskan semua instance di akun saat ini dan AWS Wilayah. Anda dapat secara opsional menentukan daftar instance-ids untuk menggambarkan satu atau beberapa contoh; dry-run adalah bendera Boolean opsional yang tidak mengambil nilai. Untuk menggunakan bendera Boolean, tentukan nilai yang ditampilkan, dalam kasus ini --dry-run atau--no-dry-run. Demikian juga, --generate-cli-skeleton tidak mengambil nilai. Jika ada kondisi pada penggunaan opsi, mereka dijelaskan di OPTIONS bagian, atau ditampilkan dalam contoh.

Opsi

Deskripsi masing-masing opsi yang ditunjukkan dalam sinopsis.

OPTIONS --dry-run | --no-dry-run (boolean) Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRun- Operation . Otherwise, it is UnauthorizedOperation . --instance-ids (list) One or more instance IDs. Default: Describes all your instances. ...
Contoh

Contoh yang menunjukkan penggunaan perintah dan opsinya. Jika tidak ada contoh yang tersedia untuk perintah atau kasus penggunaan yang Anda butuhkan, mintalah satu menggunakan tautan umpan balik di halaman ini, atau dalam referensi AWS CLI perintah di halaman bantuan untuk perintah tersebut.

EXAMPLES To describe an Amazon EC2 instance Command: aws ec2 describe-instances --instance-ids i-5203422c To describe all instances with the instance type m1.small Command: aws ec2 describe-instances --filters "Name=instance-type,Values=m1.small" To describe all instances with an Owner tag Command: aws ec2 describe-instances --filters "Name=tag-key,Values=Owner" ...
Output

Deskripsi masing-masing bidang dan tipe data yang disertakan dalam respons dari AWS.

Untukdescribe-instances, outputnya adalah daftar objek reservasi, yang masing-masing berisi beberapa bidang dan objek yang berisi informasi tentang instance yang terkait dengannya. Informasi ini berasal dari APIdokumentasi untuk tipe data reservasi yang digunakan oleh AmazonEC2.

OUTPUT Reservations -> (list) One or more reservations. (structure) Describes a reservation. ReservationId -> (string) The ID of the reservation. OwnerId -> (string) The ID of the AWS account that owns the reservation. RequesterId -> (string) The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling). Groups -> (list) One or more security groups. (structure) Describes a security group. GroupName -> (string) The name of the security group. GroupId -> (string) The ID of the security group. Instances -> (list) One or more instances. (structure) Describes an instance. InstanceId -> (string) The ID of the instance. ImageId -> (string) The ID of the AMI used to launch the instance. State -> (structure) The current state of the instance. Code -> (integer) The low byte represents the state. The high byte is an opaque internal value and should be ignored. ...

Ketika AWS CLI merender output ke dalamJSON, itu menjadi array objek reservasi, mirip dengan contoh berikut.

{ "Reservations": [ { "OwnerId": "012345678901", "ReservationId": "r-4c58f8a0", "Groups": [], "RequesterId": "012345678901", "Instances": [ { "Monitoring": { "State": "disabled" }, "PublicDnsName": "ec2-52-74-16-12.us-west-2.compute.amazonaws.com", "State": { "Code": 16, "Name": "running" }, ...

Setiap objek reservasi berisi bidang yang menjelaskan reservasi dan array objek instance, masing-masing dengan bidangnya sendiri (misalnya,PublicDnsName) dan objek (misalnya,State) yang mendeskripsikannya.

Pengguna Windows

Anda dapat menyalurkan (|) output dari perintah bantuan ke more perintah untuk melihat file bantuan satu halaman pada satu waktu. Tekan spasi atau PgDnuntuk melihat lebih banyak dokumen, dan q untuk berhenti.

C:\> aws ec2 describe-instances help | more

AWS CLI panduan referensi

File bantuan berisi tautan yang tidak dapat dilihat atau dinavigasi dari baris perintah. Anda dapat melihat dan berinteraksi dengan tautan ini dengan menggunakan referensi AWS CLI versi 2. Referensi juga berisi konten bantuan untuk semua AWS CLI perintah. Deskripsi disajikan untuk navigasi dan tampilan yang mudah di layar seluler, tablet, atau desktop.

APIdokumentasi

Semua perintah dalam AWS CLI sesuai dengan permintaan yang dibuat untuk publik AWS layananAPI. Setiap layanan dengan publik API memiliki API referensi yang dapat ditemukan di halaman beranda layanan di situs web AWS Dokumentasi. Konten untuk API referensi bervariasi berdasarkan bagaimana API dibangun dan protokol mana yang digunakan. Biasanya, API referensi berisi informasi terperinci tentang operasi yang didukung olehAPI, data yang dikirim ke dan dari layanan, dan kondisi kesalahan apa pun yang dapat dilaporkan oleh layanan.

APIBagian Dokumentasi
  • Tindakan — Informasi terperinci tentang setiap operasi dan parameternya (termasuk kendala pada panjang atau konten, dan nilai default). Ini mencantumkan kesalahan yang dapat terjadi untuk operasi ini. Setiap operasi sesuai dengan subperintah di. AWS CLI

  • Tipe Data — Informasi terperinci tentang struktur yang mungkin diperlukan perintah sebagai parameter, atau dikembalikan sebagai respons terhadap permintaan.

  • Parameter Umum — Informasi terperinci tentang parameter yang dibagikan oleh semua tindakan untuk layanan.

  • Kesalahan Umum — Informasi terperinci tentang kesalahan yang dapat dikembalikan oleh salah satu operasi layanan.

Nama dan ketersediaan setiap bagian dapat bervariasi, tergantung pada layanan.

Layanan khusus CLIs

Beberapa layanan memiliki tanggal terpisah CLI dari sebelum satu AWS CLI dibuat untuk bekerja dengan semua layanan. Khusus layanan ini CLIs memiliki dokumentasi terpisah yang ditautkan dari halaman dokumentasi layanan. Dokumentasi untuk layanan khusus CLIs tidak berlaku untuk. AWS CLI

Memecahkan masalah kesalahan

Untuk bantuan mendiagnosis dan memperbaiki AWS CLI kesalahan, lihatMemecahkan masalah kesalahan untuk AWS CLI.

Bantuan tambahan

Untuk bantuan tambahan AWS CLI terkait masalah Anda, kunjungi AWS CLI komunitas di GitHub.