En los siguientes ejemplos de código, se muestra cómo llevar a cabo acciones e implementar situaciones comunes mediante la AWS Command Line Interface con una API de administración de puertas de enlace de API.
Las acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las distintas funciones de servicio, es posible ver las acciones en contexto en los escenarios relacionados.
En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.
Temas
Acciones
En el siguiente ejemplo de código, se muestra cómo utilizar delete-connection.
- AWS CLI
-
Eliminación de una conexión WebSocket
En el siguiente ejemplo de
delete-connection, se desconecta un cliente de la API de WebSocket especificada.aws apigatewaymanagementapi delete-connection \ --connection-idL0SM9cOFvHcCIhw=\ --endpoint-urlhttps://aabbccddee.execute-api.us-west-2.amazonaws.com/prodEste comando no genera ninguna salida.
Para obtener más información, consulte Uso de comandos @connections en el servicio de backend en la Guía para desarrolladores de Amazon API Gateway.
-
Para obtener detalles sobre la API, consulte DeleteConnection
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar get-connection.
- AWS CLI
-
Para obtener información sobre una conexión WebSocket
En el siguiente ejemplo de
get-connection, se describe una conexión a la API de WebSocket especificada.aws apigatewaymanagementapi get-connection \ --connection-idL0SM9cOFvHcCIhw=\ --endpoint-urlhttps://aabbccddee.execute-api.us-west-2.amazonaws.com/prodSalida:
{ "ConnectedAt": "2020-04-30T20:10:33.236Z", "Identity": { "SourceIp": "192.0.2.1" }, "LastActiveAt": "2020-04-30T20:10:42.997Z" }Para obtener más información, consulte Uso de comandos @connections en el servicio de backend en la Guía para desarrolladores de Amazon API Gateway.
-
Para obtener detalles sobre la API, consulte GetConnection
en la Referencia de comandos de la AWS CLI.
-
En el siguiente ejemplo de código, se muestra cómo utilizar post-to-connection.
- AWS CLI
-
Para enviar datos a una conexión WebSocket
En el siguiente ejemplo
post-to-connectionse envía un mensaje a un cliente que está conectado a la API de WebSocket especificada.aws apigatewaymanagementapi post-to-connection \ --connection-idL0SM9cOFvHcCIhw=\ --data"Hello from API Gateway!"\ --endpoint-urlhttps://aabbccddee.execute-api.us-west-2.amazonaws.com/prodEste comando no genera ninguna salida.
Para obtener más información, consulte Uso de comandos @connections en el servicio de backend en la Guía para desarrolladores de Amazon API Gateway.
-
Para obtener información sobre la API, consulte PostToConnection
en la Referencia de comandos de la AWS CLI.
-
