を使用した API Gateway Management API の例 AWS CLI - AWS SDK コード例

Doc AWS SDK Examples リポジトリには、他にも SDK の例があります。 AWS GitHub

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

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

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

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

「シナリオ」は、同じサービス内で複数の関数を呼び出して、特定のタスクを実行する方法を示すコード例です。

各例には、 へのリンクが含まれています。このリンクには GitHub、コンテキスト内でコードをセットアップして実行する方法の手順が記載されています。

トピック

アクション

次の例は、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 の詳細については、「 コマンドリファレンスDeleteConnection」の「」を参照してください。 AWS CLI

次の例は、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 の詳細については、「 コマンドリファレンスGetConnection」の「」を参照してください。 AWS CLI

次の例は、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 の詳細については、「 コマンドリファレンスPostToConnection」の「」を参照してください。 AWS CLI