APIAPIExemplos de gerenciamento de gateway usando AWS CLI - AWS SDKExemplos de código
Ações

Há mais AWS SDK exemplos disponíveis no GitHub repositório AWS Doc SDK Examples.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

APIAPIExemplos de gerenciamento de gateway usando AWS CLI

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

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar funções de serviço individuais, é possível ver as ações no contexto em seus cenários relacionados.

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

Tópicos

Ações

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

AWS CLI

Para excluir uma WebSocket conexão

O delete-connection exemplo a seguir desconecta um cliente do especificado WebSocket API.

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 Use os comandos @connections em seu serviço de back-end no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte DeleteConnectionna Referência de AWS CLI Comandos.

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

AWS CLI

Para obter informações sobre uma WebSocket conexão

O get-connection exemplo a seguir descreve uma conexão com o especificado WebSocket API.

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

Saída:

{
    "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 Use os comandos @connections em seu serviço de back-end no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte GetConnectionna Referência de AWS CLI Comandos.

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

AWS CLI

Para enviar dados para uma WebSocket conexão

O post-to-connection exemplo a seguir envia uma mensagem para um cliente conectado ao 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 não produz saída.

Para obter mais informações, consulte Use os comandos @connections em seu serviço de back-end no Amazon API Gateway Developer Guide.

  • Para API obter detalhes, consulte PostToConnectionna Referência de AWS CLI Comandos.