バックエンドサービスでの @connections
コマンドの使用
バックエンドサービスは次の WebSocket 接続 HTTP リクエストを使用して、接続されたクライアントへのコールバックメッセージの送信、接続情報の取得、またはクライアントの切断を行うことができます。
重要
これらのリクエストは IAM 認証を使用するため、署名バージョン 4 (SigV4) を使用して署名する必要があります。これを行うには、API Gateway 管理 API を使用します。詳細については、「ApiGatewayManagementApi
次のコマンドでは、
を実際の API ID に置き換える必要があります。これは API Gateway コンソールに表示されるか、AWS CLI {api-id}
create-api
コマンドによって返されます。さらに、API が us-east-1
以外のリージョンにある場合、正しいリージョンに置き換える必要があります。
コールバックメッセージをクライアントに送信するには、以下を使用します。
POST https://
{api-id}
.execute-api.us-east-1
.amazonaws.com/{stage}
/@connections/{connection_id}
以下の例のように、Postman
を使用するか、awscurl
を呼び出すことで、このリクエストをテストできます。
awscurl --service execute-api -X POST -d "hello world" https://
{prefix}
.execute-api.us-east-1
.amazonaws.com/{stage}
/@connections/{connection_id}
次の例のようにコマンドを URL でエンコードする必要があります。
awscurl --service execute-api -X POST -d "hello world" https://
aabbccddee
.execute-api.us-east-1
.amazonaws.com/prod
/%40connections/R0oXAdfD0kwCH6w%3D
クライアントの最新の接続ステータスを取得するには、以下を使用します。
GET https://
{api-id}
.execute-api.us-east-1
.amazonaws.com/{stage}
/@connections/{connection_id}
クライアントを切断するには、以下を使用します。
DELETE https://
{api-id
}.execute-api.us-east-1
.amazonaws.com/{stage}
/@connections/{connection_id
}
統合で $context
変数を使用して、コールバック URL を動的に構築できます。例えば、Node.js
Lambda 関数で Lambda プロキシの統合を使用する場合は、次のように URL を構築し、接続されたクライアントにメッセージを送信できます。
import { ApiGatewayManagementApiClient, PostToConnectionCommand, } from "@aws-sdk/client-apigatewaymanagementapi"; export const handler = async (event) => { const domain = event.requestContext.domainName; const stage = event.requestContext.stage; const connectionId = event.requestContext.connectionId; const callbackUrl = `https://${domain}/${stage}`; const client = new ApiGatewayManagementApiClient({ endpoint: callbackUrl }); const requestParams = { ConnectionId: connectionId, Data: "Hello!", }; const command = new PostToConnectionCommand(requestParams); try { await client.send(command); } catch (error) { console.log(error); } return { statusCode: 200, }; };