API Gateway Management API-Beispiele mit AWS CLI - AWS Command Line Interface
Aktionen

Diese Dokumentation bezieht sich AWS CLI nur auf Version 1 von. Dokumentation zu Version 2 von finden Sie im Benutzerhandbuch für Version 2. AWS CLI

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.

API Gateway Management API-Beispiele mit AWS CLI

Die folgenden Codebeispiele zeigen Ihnen, wie Sie AWS Command Line Interface mithilfe der API Gateway Management API Aktionen ausführen und allgemeine Szenarien implementieren.

Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Während Aktionen Ihnen zeigen, wie Sie einzelne Service-Funktionen aufrufen, können Sie Aktionen im Kontext der zugehörigen Szenarien anzeigen.

Jedes Beispiel enthält einen Link zum vollständigen Quellcode, wo Sie Anleitungen zum Einrichten und Ausführen des Codes im Kontext finden.

Themen

Aktionen

Das folgende Codebeispiel zeigt, wie Siedelete-connection.

AWS CLI

Um eine WebSocket Verbindung zu löschen

Das folgende delete-connection Beispiel trennt einen Client von der angegebenen WebSocket API.

aws apigatewaymanagementapi delete-connection \
    --connection-id L0SM9cOFvHcCIhw= \
    --endpoint-url https://aabbccddee.execute-api.us-west-2.amazonaws.com/prod

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Verwenden von @connections-Befehlen in Ihrem Backend-Service im Entwicklerhandbuch zu Amazon API Gateway.

Das folgende Codebeispiel zeigt die Verwendungget-connection.

AWS CLI

Um Informationen über eine WebSocket Verbindung zu erhalten

Das folgende get-connection Beispiel beschreibt eine Verbindung zur angegebenen WebSocket API.

aws apigatewaymanagementapi get-connection \
    --connection-id L0SM9cOFvHcCIhw= \
    --endpoint-url https://aabbccddee.execute-api.us-west-2.amazonaws.com/prod

Ausgabe:

{
    "ConnectedAt": "2020-04-30T20:10:33.236Z",
    "Identity": {
        "SourceIp": "192.0.2.1"
    },
    "LastActiveAt": "2020-04-30T20:10:42.997Z"
}

Weitere Informationen finden Sie unter Verwenden von @connections-Befehlen in Ihrem Backend-Service im Entwicklerhandbuch zu Amazon API Gateway.

  • Einzelheiten zur API finden Sie GetConnectionunter AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungpost-to-connection.

AWS CLI

Um Daten an eine WebSocket Verbindung zu senden

Das folgende post-to-connection Beispiel sendet eine Nachricht an einen Client, der mit der angegebenen WebSocket API verbunden ist.

aws apigatewaymanagementapi post-to-connection \
    --connection-id L0SM9cOFvHcCIhw= \
    --data "Hello from API Gateway!" \
    --endpoint-url https://aabbccddee.execute-api.us-west-2.amazonaws.com/prod

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Verwenden von @connections-Befehlen in Ihrem Backend-Service im Entwicklerhandbuch zu Amazon API Gateway.

  • Einzelheiten zur API finden Sie PostToConnectionunter AWS CLI Befehlsreferenz.