View a markdown version of this page

Ejemplos de API de API Gateway Management que utilizan AWS CLI - AWS Ejemplos de código de SDK
Acciones

Hay más ejemplos de AWS SDK disponibles en el repositorio de ejemplos de AWS Doc SDK. GitHub

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.

Ejemplos de API de API Gateway Management que utilizan AWS CLI

En los siguientes ejemplos de código, se muestra cómo realizar acciones e implementar escenarios comunes mediante la API AWS Command Line Interface con API Gateway Management.

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.

Acciones

En el siguiente ejemplo de código, se muestra cómo utilizar delete-connection.

AWS CLI

Para eliminar una conexión WebSocket

El siguiente delete-connection ejemplo desconecta a un cliente de la WebSocket API especificada.

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 Uso de comandos @connections en el servicio de backend en la Guía para desarrolladores de Amazon API Gateway.

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

En el siguiente ejemplo de código, se muestra cómo utilizar get-connection.

AWS CLI

Para obtener información sobre una WebSocket conexión

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

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 Uso de comandos @connections en el servicio de backend en la Guía para desarrolladores de Amazon API Gateway.

  • Para obtener más información sobre la API, consulte GetConnection AWS CLI Command Reference.

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

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

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 Uso de comandos @connections en el servicio de backend en la Guía para desarrolladores de Amazon API Gateway.

  • Para obtener más información sobre la API, consulta PostToConnection la AWS CLI sección Referencia de comandos.