AWS CLI を使用した API Gateway Management API の例

次のコードサンプルは、API Gateway Management API で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。

アクション

delete-connection

次の例では、delete-connection を使用する方法を説明しています。

AWS CLI

WebSocket 接続を削除する方法

次の delete-connection の例では、指定された WebSocket API からクライアントを切断します。

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

このコマンドでは何も出力されません。

詳細については、「Amazon API Gateway ディベロッパーガイド」の「バックエンドサービスでの @connections コマンドの使用」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteConnection」を参照してください。

get-connection

次の例では、get-connection を使用する方法を説明しています。

AWS CLI

WebSocket 接続に関する情報を取得する方法

次の get-connection 例では、指定された WebSocket API への接続について説明しています。

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

出力:

{
    "ConnectedAt": "2020-04-30T20:10:33.236Z",
    "Identity": {
        "SourceIp": "192.0.2.1"
    },
    "LastActiveAt": "2020-04-30T20:10:42.997Z"
}

詳細については、「Amazon API Gateway ディベロッパーガイド」の「バックエンドサービスでの @connections コマンドの使用」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「GetConnection」を参照してください。

post-to-connection

次の例では、post-to-connection を使用する方法を説明しています。

AWS CLI

データを WebSocket 接続に送信する方法

次の post-to-connection の例では、指定した 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

このコマンドでは何も出力されません。

詳細については、「Amazon API Gateway ディベロッパーガイド」の「バックエンドサービスでの @connections コマンドの使用」を参照してください。

• API の詳細については、AWS CLI コマンドリファレンスの「PostToConnection」を参照してください。