Beispiele für die Verwendung der AWS CLI mit der Management-API von API Gateway - AWS Command Line Interface
Aktionen

Beispiele für die Verwendung der AWS CLI mit der Management-API von API Gateway

Die folgenden Codebeispiele zeigen, wie Sie Aktionen durchführen und gängige Szenarien implementieren, indem Sie die AWS Command Line Interface mit der Management-API von API Gateway nutzen.

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 delete-connection verwendet wird.

AWS CLI

So löschen Sie eine WebSocket-Verbindung

Im folgenden Beispiel für delete-connection wird ein Client von der angegebenen WebSocket-API getrennt.

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, wie get-connection verwendet wird.

AWS CLI

So rufen Sie Informationen zu einer WebSocket-Verbindung ab

Im folgenden Beispiel für get-connection wird eine Verbindung zur angegebenen WebSocket-API beschrieben.

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.

  • API-Details finden Sie unter GetConnection in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie post-to-connection verwendet wird.

AWS CLI

So senden Sie Daten an eine WebSocket-Verbindung

Im folgenden Beispiel für post-to-connection wird eine Nachricht an einen Client gesendet, 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.