Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich. # Zugriff auf Hilfe und Ressourcen für AWS CLI In diesem Thema wird beschrieben, wie Sie auf Hilfeinhalte für AWS Command Line Interface (AWS CLI) zugreifen können. **Topics** + [ ## Der integrierte AWS CLI Hilfebefehl ](#cli-usage-help-command) + [ ## AWS CLI Referenzhandbuch ](#cli-reference) + [ ## API-Dokumentation ](#api-reference) + [ ## Behebung von Fehlern ](#help-tshoot) + [ ## Weitere Hilfe ](#help-additional) ## Der integrierte AWS CLI Hilfebefehl Sie können mit jedem Befehl Hilfe erhalten, wenn Sie die AWS Command Line Interface (AWS CLI) verwenden. Geben Sie dazu hinter einem Befehlsnamen einfach `help` ein. Mit dem folgenden Befehl wird beispielsweise Hilfe zu den allgemeinen AWS CLI Optionen und den verfügbaren Befehlen der obersten Ebene angezeigt. ``` $ aws help ``` Der folgende Befehl zeigt die verfügbaren Amazon-Elastic-Compute-Cloud (Amazon EC2)-spezifischen Befehle an. ``` $ aws ec2 help ``` Im folgenden Beispiel wird die detaillierte Hilfe für die Amazon EC2 `DescribeInstances`-Operation angezeigt. Die Hilfe enthält Informationen zu den Eingabeparametern, verfügbaren Filter und dem Inhalt der Ausgabe. Sie enthält auch Beispiele dazu, wie Sie Variationen des Befehls eingeben können. ``` $ aws ec2 describe-instances help ``` Ab Version `2.31.0` wird die Anzeige für den Befehl `help` durch die Einstellung `cli_help_output` konfiguriert und hat die folgenden Werte: + **(Standard)** `terminal` – Öffnen Sie die Manpage im Terminal. + `browser` – Öffnen Sie die Manpage als lokale HTML-Datei in Ihrem Standardbrowser. Ein Hinweis wird auf Ihrem Terminal gedruckt, wenn Ihr Standardbrowser geöffnet wird, und eine Fehlermeldung, wenn der Browser AWS CLI nicht geöffnet werden kann. + `url`‐ Drucken Sie die URL zum AWS CLI Online-Referenzhandbuch für die Version aus, die AWS CLI Sie installiert haben. Die Einstellungen für das clientseitige Paging, wie z. B. die `AWS_PAGER` Umgebungsvariable, werden berücksichtigt. Die Hilfeinhalte für jeden Befehl sind in sechs Abschnitte unterteilt: Name Der Name des Befehls. ``` NAME describe-instances - ``` Description Eine Beschreibung der API-Operation, die der Befehl aufruft. ``` 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. ... ``` Syntax Die grundlegende Syntax für die Nutzung des Befehls und dessen Optionen. Wenn eine Option in eckigen Klammern dargestellt wird, ist sie optional oder hat einen Standardwert oder es gibt eine alternative Option, die verwendet werden kann. ``` SYNOPSIS describe-instances [--dry-run | --no-dry-run] [--instance-ids ] [--filters ] [--cli-input-json ] [--starting-token ] [--page-size ] [--max-items ] [--generate-cli-skeleton] ``` `describe-instances`Hat beispielsweise ein Standardverhalten, das ***alle*** Instanzen im aktuellen Konto und in der Region beschreibt. AWS Sie können optional eine Liste mit `instance-ids` angeben, um eine oder mehrere Instances zu beschreiben. `dry-run` ist ein optionales boolesches Flag, das keinen Wert akzeptiert. Zur Verwendung eines booleschen Flags geben Sie einen der dargestellten Werte an, in diesem Fall `--dry-run` oder `--no-dry-run`. Ebenso akzeptiert `--generate-cli-skeleton` keinen Wert. Enthält eine Option Bedingungen für ihre Verwendung, sind diese im Abschnitt `OPTIONS` oder in den aufgeführten Beispielen angegeben. Optionen Eine Beschreibung der einzelnen Optionen aus der Zusammenfassung. ``` 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. ... ``` Beispiele Beispiele für die Nutzung des Befehls und seiner Optionen. Wenn kein Beispiel für einen Befehl oder Anwendungsfall verfügbar ist, den Sie benötigen, fordern Sie eines über den Feedback-Link auf dieser Seite oder in der AWS CLI Befehlsreferenz auf der Hilfeseite für den Befehl an. ``` 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" ... ``` Ausgabe Beschreibungen der einzelnen Felder und Datentypen, die in der Antwort von AWS zurückgegeben werden. Für `describe-instances` ist die Ausgabe ist eine Liste mit Reservierungsobjekten, die jeweils mehrere Felder und Objekte enthalten, die Informationen über die damit verknüpften Instances bereitstellen. Diese Informationen stammen aus der [-API-Dokumentation für den Reservierungsdatentyp](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Reservation.html), der von Amazon EC2 verwendet wird. ``` 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. ... ``` Wenn die Ausgabe in JSON AWS CLI gerendert wird, wird sie zu einem Array von Reservierungsobjekten, ähnlich dem folgenden Beispiel. ``` { "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" }, ... ``` Jedes Reservierungsobjekt enthält Felder mit einer Beschreibung der Reservierung und einem Array von Instance-Objekten, jedes mit eigenen Feldern (z. B. `PublicDnsName`) und Objekten (z. B. `State`), die es beschreiben. **Windows-Nutzer** Sie können die Ausgabe des Hilfebefehls *weiterleiten* (\$1) an den `more`-Befehl, um die Hilfedatei seitenweise anzusehen. Drücken Sie die Leertaste oder **PgDn**, um einen größeren Teil des Dokuments anzuzeigen und den Vorgang **q** zu beenden. ``` C:\> aws ec2 describe-instances help | more ``` ## AWS CLI Referenzhandbuch Die Hilfedateien enthalten Links, die nicht von der Befehlszeile aus angezeigt oder aufgerufen werden können. Sie können sich diese Links ansehen und mit ihnen interagieren, indem Sie das verwenden. Die Referenz enthält auch den Hilfeinhalt für alle AWS CLI Befehle. Die Beschreibungen sind so strukturiert, dass eine einfache Navigation und Anzeige auf Mobilgeräten, Tablets und Desktop-Bildschirmen möglich ist. ## API-Dokumentation Alle Befehle in der AWS CLI entsprechen Anfragen, die an die öffentliche API eines AWS Dienstes gestellt wurden. Jeder Service mit einer öffentlichen API verfügt über eine API-Referenz, die über die Service-Startseite auf der Website [AWS -Dokumentation](https://docs.aws.amazon.com/) aufgerufen werden kann. Die Inhalte für eine API-Referenz sind unterschiedlich, je nachdem, wie die API erstellt wurde und welches Protokoll verwendet wird. Im Allgemeinen enthält eine API-Referenz detaillierte Informationen zu den von der API unterstützten Operationen, den Daten, die an den und von dem Service gesendet werden, und mögliche Fehlerbedingungen, die der Service ausgibt. **API-Dokumentationsabschnitte** + **Aktionen** – Detaillierte Informationen zu den einzelnen Operationen und ihren Parametern (einschließlich Einschränkungen bei der Länge oder den Inhalten und Standardwerte). Listet die Fehler auf, die bei dieser Operation auftreten können. Jede Operation entspricht einem Unterbefehl in der AWS CLI. + **Datentypen** – Detaillierte Informationen zu Strukturen, die ein Befehl möglicherweise als Parameter erfordert oder als Reaktion auf eine Anfrage zurückgibt. + **Häufige Parameter** – Detaillierte Informationen zu Parametern, die von allen Aktionen für den Service geteilt werden. + **Häufige Fehler** – Ausführliche Informationen zu Fehlern, die von den Aktionen eines Services ausgegeben werden können. Der Name und die Verfügbarkeit jedes Abschnitts kann abhängig vom Service variieren. **Servicespezifisch CLIs** Einige Dienste verfügen über eine separate CLI, die aus der Zeit stammt, bevor eine einzige erstellt AWS CLI wurde, um mit allen Diensten zu funktionieren. Für diese dienstspezifischen Dienste CLIs gibt es eine separate Dokumentation, die auf der Dokumentationsseite des Dienstes verlinkt ist. Die Dokumentation für dienstspezifische Zwecke gilt CLIs nicht für die. AWS CLI ## Behebung von Fehlern Hilfe zur Diagnose und Behebung von AWS CLI Fehlern finden Sie unter. [Behebung von Fehlern für den AWS CLI](cli-chap-troubleshooting.md) ## Weitere Hilfe Weitere Hilfe bei Ihren AWS CLI Problemen finden Sie in der [AWS CLI Community](https://github.com/aws/aws-cli/issues) unter *GitHub*.