Esempi di API di gestione Gateway API che utilizzano la AWS CLI - AWS Command Line Interface
Operazioni

Esempi di API di gestione Gateway API che utilizzano la AWS CLI

Gli esempi di codice seguenti mostrano come eseguire azioni e implementare scenari comuni utilizzando AWS Command Line Interface con l’API di gestione Gateway API.

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

Ogni esempio include un link al codice sorgente completo, dove è possibile trovare le istruzioni su come configurare ed eseguire il codice nel contesto.

Argomenti

Operazioni

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

AWS CLI

Come eliminare una connessione WebSocket

Nell’ esempio seguente delete-connection disconnette un client dall’API WebSocket 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 sviluppatori di Gateway Amazon API.

  • Per informazioni dettagliate sull’API, consulta DeleteConnection in AWS CLI Command Reference.

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

AWS CLI

Come ottenere informazioni su una connessione WebSocket

Nell’esempio seguente get-connection descrive una connessione all’API WebSocket 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 sviluppatori di Gateway Amazon API.

  • Per informazioni dettagliate sull’API, consulta GetConnection in AWS CLI Command Reference.

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

AWS CLI

Come inviare dati a una connessione WebSocket

Il seguente codice post-to-connection di esempio invia un messaggio a un client connesso all’API WebSocket 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 sviluppatori di Gateway Amazon API.

  • Per informazioni dettagliate sull’API, consulta PostToConnection in AWS CLI Command Reference.