APIAPIEjemplos de administración de puertas de enlace utilizando AWS CLI - AWS Command Line Interface
Acciones

Esta documentación es AWS CLI únicamente para la versión 1 de la versión. Para ver la documentación relacionada con la versión 2 de AWS CLI, consulte la Guía del usuario de la versión 2.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

APIAPIEjemplos de administración de puertas de enlace utilizando AWS CLI

Los siguientes ejemplos de código muestran cómo realizar acciones e implementar situaciones comunes mediante el AWS Command Line Interface uso de API Gateway ManagementAPI.

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 funciones de servicio individuales, es posible ver las acciones en contexto en los escenarios relacionados.

Cada ejemplo incluye un enlace al código fuente completo, donde puede encontrar instrucciones sobre cómo configurar y ejecutar el código en su contexto.

Acciones

El siguiente ejemplo de código muestra cómo usarlodelete-connection.

AWS CLI

Para eliminar una WebSocket conexión

El siguiente delete-connection ejemplo desconecta un cliente del especificado WebSocket API.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Utilizar los comandos @connections en su servicio de backend en la Guía para desarrolladores de Amazon API Gateway.

  • Para API obtener más información, consulte DeleteConnectionla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarloget-connection.

AWS CLI

Para obtener información sobre una WebSocket conexión

En el siguiente get-connection ejemplo se describe una conexión a la especificada WebSocket API.

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

Salida:

{
    "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 Utilizar los comandos @connections en su servicio de backend en la Guía para desarrolladores de Amazon API Gateway.

  • Para API obtener más información, consulte GetConnectionla Referencia de AWS CLI comandos.

El siguiente ejemplo de código muestra cómo usarlopost-to-connection.

AWS CLI

Para enviar datos a una WebSocket conexión

El siguiente post-to-connection ejemplo envía un mensaje a un cliente que está conectado al especificado WebSocket API.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Utilizar los comandos @connections en su servicio de backend en la Guía para desarrolladores de Amazon API Gateway.

  • Para API obtener más información, consulte PostToConnectionla Referencia de AWS CLI comandos.