**Esta documentación es para la versión 1 de AWS CLI.**

Anunciamos el próximo fin del soporte para la versión 1 de AWS CLI. Recomendamos migrarse a la versión 2 de AWS CLI. Para ver las fechas, los detalles adicionales y la información sobre cómo realizar la migración, consulte el [anuncio](https://aws.amazon.com/blogs/developer/cli-v1-maintenance-mode-announcement/). Para obtener documentación relacionada con la versión 2 de AWS CLI, consulte la [Guía del usuario de la versión 2](https://docs.aws.amazon.com/cli/latest/userguide/).

# Ejemplos de API de administración de puertas de enlace de API que utilizan la AWS CLI
<a name="cli_apigatewaymanagementapi_code_examples"></a>

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.

**Topics**
+ [Acciones](#actions)

## Acciones
<a name="actions"></a>

### `delete-connection`
<a name="apigatewaymanagementapi_DeleteConnection_cli_topic"></a>

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-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](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html) en la *Guía para desarrolladores de Amazon API Gateway*.  
+  Para obtener detalles sobre la API, consulte [DeleteConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewaymanagementapi/delete-connection.html) en la *Referencia de comandos de la AWS CLI*. 

### `get-connection`
<a name="apigatewaymanagementapi_GetConnection_cli_topic"></a>

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-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](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html) en la *Guía para desarrolladores de Amazon API Gateway*.  
+  Para obtener detalles sobre la API, consulte [GetConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewaymanagementapi/get-connection.html) en la *Referencia de comandos de la AWS CLI*. 

### `post-to-connection`
<a name="apigatewaymanagementapi_PostToConnection_cli_topic"></a>

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-connection` se envía un mensaje a un cliente que está conectado a la API de WebSocket 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html) en la *Guía para desarrolladores de Amazon API Gateway*.  
+  Para obtener información sobre la API, consulte [PostToConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewaymanagementapi/post-to-connection.html) en la *Referencia de comandos de la AWS CLI*.