API Gateway Management API-Beispiele mit AWS CLI

PDF

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 Szenarios anzeigen.

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

Aktionen

delete-connection

Das folgende Codebeispiel zeigt die Verwendungdelete-connection.

AWS CLI

Um eine WebSocket Verbindung zu löschen

Im folgenden delete-connection Beispiel wird die Verbindung eines Clients mit 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 Amazon API Gateway Developer Guide.

• Einzelheiten zur API finden Sie unter DeleteConnection AWS CLIBefehlsreferenz.

delete-connection

Das folgende Codebeispiel zeigt die Verwendungdelete-connection.

AWS CLI

Um eine WebSocket Verbindung zu löschen

Im folgenden delete-connection Beispiel wird die Verbindung eines Clients mit 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 Amazon API Gateway Developer Guide.

• Einzelheiten zur API finden Sie unter DeleteConnection AWS CLIBefehlsreferenz.

get-connection

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 Amazon API Gateway Developer Guide.

• Einzelheiten zur API finden Sie unter GetConnection AWS CLIBefehlsreferenz.

get-connection

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 Amazon API Gateway Developer Guide.

• Einzelheiten zur API finden Sie unter GetConnection AWS CLIBefehlsreferenz.

post-to-connection

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 Amazon API Gateway Developer Guide.

• Einzelheiten zur API finden Sie unter PostToConnection AWS CLIBefehlsreferenz.

post-to-connection

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 Amazon API Gateway Developer Guide.

• Einzelheiten zur API finden Sie unter PostToConnection AWS CLIBefehlsreferenz.