Exemples d’utilisation de l’AWS CLI avec l’API de gestion API Gateway - AWS Command Line Interface
Actions

Exemples d’utilisation de l’AWS CLI avec l’API de gestion API Gateway

Les exemples de code suivants montrent comment réaliser des actions et mettre en œuvre des scénarios courants en utilisant l’AWS Command Line Interface avec l’API de gestion API Gateway.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.

Rubriques

Actions

L’exemple de code suivant montre comment utiliser delete-connection.

AWS CLI

Pour supprimer une connexion WebSocket

L’exemple delete-connection suivant déconnecte un client de l’API WebSocket spécifiée.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Utilisation des commandes @connections dans votre service backend dans le Manuel du développeur Amazon API Gateway.

  • Pour plus de détails sur l’API, consultez DeleteConnection dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-connection.

AWS CLI

Pour obtenir les informations sur une connexion WebSocket

L’exemple get-connection suivant décrit une connexion à l’API WebSocket spécifiée.

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

Sortie :

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

Pour plus d’informations, consultez Utilisation des commandes @connections dans votre service backend dans le Manuel du développeur Amazon API Gateway.

  • Pour plus de détails sur l’API, consultez GetConnection dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser post-to-connection.

AWS CLI

Pour envoyer des données à une connexion WebSocket

L’exemple post-to-connection suivant envoie un message à un client connecté à l’API WebSocket spécifiée.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Utilisation des commandes @connections dans votre service backend dans le Manuel du développeur Amazon API Gateway.

  • Pour plus de détails sur l’API, consultez PostToConnection dans la Référence des commandes de l’AWS CLI.