API を使用したゲートウェイ管理APIの例 AWS CLI

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

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

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

アクション

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

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

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