API Gateway Management: esempi di API che utilizzano AWS CLI

I seguenti esempi di codice mostrano come eseguire azioni e implementare scenari comuni utilizzando l'API AWS Command Line Interface with API Gateway Management.

Le azioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le azioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.

Ogni esempio include un link al codice sorgente completo, in cui vengono fornite le istruzioni su come configurare ed eseguire il codice nel contesto.

Azioni

delete-connection

L’esempio di codice seguente mostra come utilizzare delete-connection.

AWS CLI

Per eliminare una connessione WebSocket

L'delete-connectionesempio seguente disconnette un client dall' WebSocket API specificata.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Utilizzo di comandi @connections nel servizio di backend nella Guida per gli sviluppatori di Gateway Amazon API.

• Per i dettagli sull'API, vedere DeleteConnection in AWS CLI Command Reference.

get-connection

L’esempio di codice seguente mostra come utilizzare get-connection.

AWS CLI

Per ottenere informazioni su una WebSocket connessione

L'get-connectionesempio seguente descrive una connessione all' WebSocket API specificata.

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

Output:

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

Per ulteriori informazioni, consulta Utilizzo di comandi @connections nel servizio di backend nella Guida per gli sviluppatori di Gateway Amazon API.

• Per i dettagli sull'API, vedere GetConnection in AWS CLI Command Reference.

dopo la connessione

L’esempio di codice seguente mostra come utilizzare post-to-connection.

AWS CLI

Per inviare dati a una connessione WebSocket

L'post-to-connectionesempio seguente invia un messaggio a un client connesso all' WebSocket API specificata.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Utilizzo di comandi @connections nel servizio di backend nella Guida per gli sviluppatori di Gateway Amazon API.

• Per i dettagli sull'API, vedi PostToConnection in AWS CLI Command Reference.