# A API de gerenciamento do API Gateway usando a AWS CLI
<a name="cli_apigatewaymanagementapi_code_examples"></a>

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com a API de gerenciamento do API Gateway.

*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.

**Topics**
+ [Ações](#actions)

## Ações
<a name="actions"></a>

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

O código de exemplo a seguir mostra como usar `delete-connection`.

**AWS CLI**  
**Para excluir uma conexão WebSocket**  
O exemplo `delete-connection` a seguir desconecta um cliente da 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 não produz saída.  
Para obter mais informações, consulte [Usar os comandos @connections em seu serviço de backend](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html) no *Guia do desenvolvedor do Amazon API Gateway*.  
+  Para ver detalhes da API, consulte [DeleteConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewaymanagementapi/delete-connection.html) na *Referência de comandos da AWS CLI*. 

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

O código de exemplo a seguir mostra como usar `get-connection`.

**AWS CLI**  
**Para obter informações sobre uma conexão WebSocket**  
O exemplo `get-connection` a seguir descreve uma conexão com a API de WebSocket especificada.  

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

```
{
    "ConnectedAt": "2020-04-30T20:10:33.236Z",
    "Identity": {
        "SourceIp": "192.0.2.1"
    },
    "LastActiveAt": "2020-04-30T20:10:42.997Z"
}
```
Para obter mais informações, consulte [Usar os comandos @connections em seu serviço de backend](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html) no *Guia do desenvolvedor do Amazon API Gateway*.  
+  Para ver detalhes da API, consulte [GetConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewaymanagementapi/get-connection.html) na *Referência de comandos da AWS CLI*. 

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

O código de exemplo a seguir mostra como usar `post-to-connection`.

**AWS CLI**  
**Como enviar dados para uma conexão WebSocket**  
O exemplo de `post-to-connection` a seguir envia uma mensagem para um cliente conectado à 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 não produz saída.  
Para obter mais informações, consulte [Usar os comandos @connections em seu serviço de backend](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html) no *Guia do desenvolvedor do Amazon API Gateway*.  
+  Consulte detalhes da API em [PostToConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewaymanagementapi/post-to-connection.html) na *Referência de comandos da AWS CLI*.